[virtualization-guide] more edits

Chris Curran tsagadai at fedoraproject.org
Thu Jun 10 05:55:53 UTC 2010


commit 8f5406fc6567f31cb70ed9ba8510e1bb40211c15
Author: Chris Curran <ccurran at redhat.com>
Date:   Thu Jun 10 15:55:44 2010 +1000

    more edits

 en-US/Storage_Pools_Directory.xml |  195 ++++++++++++++++++-------------------
 en-US/Storage_Pools_LVM.xml       |   11 +-
 en-US/Storage_Pools_iSCSI.xml     |    8 +-
 3 files changed, 104 insertions(+), 110 deletions(-)
---
diff --git a/en-US/Storage_Pools_Directory.xml b/en-US/Storage_Pools_Directory.xml
index b5b2820..8d319f8 100644
--- a/en-US/Storage_Pools_Directory.xml
+++ b/en-US/Storage_Pools_Directory.xml
@@ -2,38 +2,41 @@
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 ]>
 <section id="sect-Virtualization-Storage_Pools-Creating-Local_Directories">
-	<title>Local directories</title>
+	<title>Directory-based storage pools</title>
 	<para>
-		This section covers storing virtualized guests in a local directory on the host.
+		This section covers storing virtualized guests in a directory on the host.
 	</para>
 	<para>
-		You can create a directory storage pool using <command>virt-manager</command> or through the the <command>virsh</command> command line utility.  
+		Directory-based storage pools can be created with <command>virt-manager</command> or the <command>virsh</command> command line tools.  
 	</para>
 	<section>
-		<title>Creating a directory storage pool using virt-manager</title>
+		<title>Creating a directory-based storage pool with virt-manager</title>
 		<procedure>
 			<step>
 				<title>Create the local directory</title>
 				<substeps>
-					<step>
+					<step><title>Optional: Create a new directory for the storage pool</title>
 						<para>
-							Create the directory on the host where the virtual machine disk files will be stored. This example uses a directory named <replaceable>/guest_images</replaceable>.
+							Create the directory on the host for the storage pool. An existing directory can be used if permissions and SELinux are configured correctly. This example uses a directory named <replaceable>/guest_images</replaceable>.
 						</para>
 						<screen># mkdir <replaceable>/guest_images</replaceable>
 </screen>
 					</step>
 
-					<step>
+					<step><title>Set directory ownership</title>
 						<para>
-							Change the ownership and permissions so only the root user, and root owned processes such as kvm, can access it. 
+							Change the user and group ownership of the directory. The directory must be owned by the root user. 
 						</para>
-						<screen># chown root:root <replaceable>/guest_images</replaceable>
-# chmod 700 /guest_images
-# ls -la /guest_images
+						<screen># chown root:root <replaceable>/guest_images</replaceable></screen></step>
+						<step><title>Set directory permissions</title>
+						<para>Change the file permissions of the directory.</para>
+<screen># chmod 700 <replaceable>/guest_images</replaceable></screen></step>
+<step><title>Verify the changes</title>
+<para>Verify the permissions were modified. The output shows a correctly configured empty directory.</para>
+<screen># ls -la <replaceable>/guest_images</replaceable>
 total 8
 drwx------.  2 root root 4096 May 28 13:57 .
 dr-xr-xr-x. 26 root root 4096 May 28 13:57 ..
-#
 </screen>
 					</step>
 				</substeps>
@@ -41,64 +44,65 @@ dr-xr-xr-x. 26 root root 4096 May 28 13:57 ..
 
 			<step>
 				<title>Configure SELinux file contexts</title>
-			<!-- Is this step necessary?  If libvirt runs the equivalent of pool-build (virsh command) then it may not be.  Would be best to verify. This needs a step to set permanence-->
+			<!-- Is this step necessary?  If libvirt runs the equivalent of pool-build (virsh command) then it may not be.  Would be best to verify. -->
 				<para>
 					Configure the correct SELinux context for the new directory.
 				</para>
-				<screen># chcon -R virt_image_t /guest_images
+				<screen># semanage fcontext -a -t virt_image_t /guest_images
 </screen>
 			</step>
 
 			<step>
-				<title>Edit the storage pool</title>
-				<substeps>
-					<step>
-						<para>
-							With <command>virt-manager</command> running, select the host from the main window.
-						</para>
-						<para>
-							Open the <guilabel>Edit</guilabel> menu and select <guilabel>Host Details</guilabel>.
-						</para>
-						<mediaobject>
-							<imageobject>
-								<imagedata fileref="images/virt-manager_select_host.png" format="PNG" scalefit="1" />
-							</imageobject>
-						</mediaobject>
-					</step>
+			<title>Open the storage pool settings</title>
+			<substeps>
+				<step>
+					<para>
+						In the <command>virt-manager</command> graphical interface, select the host from the main window.
+					</para>
+					<para>
+						Open the <guilabel>Edit</guilabel> menu and select <guilabel>Host Details</guilabel>
+					</para>
+					<mediaobject>
+						<imageobject>
+							<imagedata fileref="images/virt-manager_select_host.png" format="PNG" scalefit="1" />
+						</imageobject>
+					</mediaobject>
+				</step>
 
+				<step>
+					<para>
+						Click on the <guilabel>Storage</guilabel> tab of the <guilabel>Host Details</guilabel> window.
+					</para>
+					<mediaobject>
+						<imageobject>
+							<imagedata fileref="images/virt-manager_host_details_storage.png" format="PNG" scalefit="1" />
+						</imageobject>
+					</mediaobject>
+				</step>
+			</substeps>
+		</step>
+			
+		<step>
+			<title>Create the new storage pool</title>
+			<substeps>
+				<step>
+					<title>Add a new pool (part 1)</title>
+					<para>
+						Press the <guilabel>+</guilabel> button (the add pool button). The <guilabel>Add a New Storage Pool</guilabel> wizard appears.
+					</para>
+					<para>
+						Choose a <guibutton>Name</guibutton> for the storage pool. This example uses the name <replaceable>guest_images_dir</replaceable>. Change the <guibutton>Type</guibutton> to <command>dir: Filesystem Directory</command>.
+					</para>
+					<mediaobject>
+						<imageobject>
+							<imagedata fileref="images/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>
+				</step>
+	
 					<step>
-						<para>
-							Click on the <guilabel>Storage</guilabel> tab of the <guilabel>Host Details</guilabel> window.
-						</para>
-						<mediaobject>
-							<imageobject>
-								<imagedata fileref="images/virt-manager_host_details_storage.png" format="PNG" scalefit="1" />
-							</imageobject>
-						</mediaobject>
-					</step>
-				</substeps>
-			</step>
-			<step>
-				<title>Create the new storage pool</title>
-				<substeps>
-					<step>
-						<title>Start the wizard</title>
-						<para>
-							Press the <guilabel>+</guilabel> button (the add pool button). The <guilabel>Add a New Storage Pool</guilabel> wizard appears.
-						</para>
-						<para>
-							Choose a <guibutton>Name</guibutton> for the storage pool. This example uses <replaceable>guest_images_dir</replaceable>. Change the <guibutton>Type</guibutton> to <command>dir: Filesystem Directory</command>, and 
-						</para>
-						<mediaobject>
-							<imageobject>
-								<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>
-					</step>
-
-					<step>
-						<title>Complete the wizard</title>
+						<title>Add a new pool (part 2)</title>
 						<para>
 							Change the <guibutton>Target Path</guibutton> field. This example uses <replaceable>/guest_images</replaceable>. 
 						</para>
@@ -114,10 +118,10 @@ dr-xr-xr-x. 26 root root 4096 May 28 13:57 ..
 			<step>
 				<title>Verify the new storage pool</title>
 				<para>
-					The new storage pool appears in the storage list on the left after a few seconds. Verify the size is reported as free as expected, <replaceable>36.41 GB Free</replaceable> in our example. Verify the <guibutton>State</guibutton> field reports the new storage pool as <replaceable>Active</replaceable>.
+					The new storage pool appears in the storage list on the left after a few seconds. Verify the size is reported as expected, <replaceable>36.41 GB Free</replaceable> in this example. Verify the <guibutton>State</guibutton> field reports the new storage pool as <replaceable>Active</replaceable>.
 				</para>
 				<para>
-					Set the <guibutton>Autostart</guibutton> check box to start the storage device with the <systemitem class="daemon">libvirtd</systemitem> service. 
+					Select the storage pool and set the <guibutton>Autostart</guibutton> checkbox to start the storage device with the <systemitem class="daemon">libvirtd</systemitem> service. 
 				</para>
 				<mediaobject>
 					<imageobject>
@@ -125,14 +129,14 @@ dr-xr-xr-x. 26 root root 4096 May 28 13:57 ..
 					</imageobject>
 				</mediaobject>
 				<para>
-					The storage pool is now created, close the <guilabel>Host Details</guilabel> dialog.
+					The storage pool is now created, close the <guilabel>Host Details</guilabel> window.
 				</para>
 			</step>
 		</procedure>
 	</section>
 
 	<section>
-		<title>Creating a directory storage pool using virsh</title>
+		<title>Creating a directory-based storage pools with virsh</title>
 		<procedure>
 			<step>
 				<title>
@@ -147,7 +151,7 @@ dr-xr-xr-x. 26 root root 4096 May 28 13:57 ..
 							The <command>name</command> of the Storage Pool. All further virsh command we use for this storage pool will use this name to refer to it.
 						</para>
 						<para>
-							We use <replaceable>guest_images_dir</replaceable> in the example below.
+							This example uses the name <replaceable>guest_images_dir</replaceable>.
 						</para>
 					</listitem>
 					<listitem>
@@ -155,21 +159,25 @@ dr-xr-xr-x. 26 root root 4096 May 28 13:57 ..
 							The <command>path</command> to a file system directory for storage virtual guest image files . This directory does not need to already exist, and it's generally better to allow <command>virsh</command> to create it in the next step.
 						</para>
 						<para>
-							We use <replaceable>/guest_images</replaceable> in the example below.
+							This example uses the <replaceable>/guest_images</replaceable> directory.
 						</para>
 					</listitem>
 				</itemizedlist>
 				<screen> # virsh pool-define-as <replaceable>guest_images_dir</replaceable> dir - - - - "<replaceable>/guest_images</replaceable>"
-Pool guest_images_dir defined
+Pool guest_images_dir defined</screen>
+</step>
 
-# virsh pool-list --all
+<step><title>Verify the storage pool is listed</title>
+				<para>
+					Verify the storage pool object is created correctly and the state reports as <computeroutput>inactive</computeroutput>.
+				</para>
+<screen># virsh pool-list --all
 Name                 State      Autostart 
 -----------------------------------------
 default              active     yes       
-guest_images_dir     inactive   no        
+guest_images_dir     inactive   no   </screen>     
+
 
-#
-</screen>
 			</step>
 
 			<step>
@@ -177,11 +185,10 @@ guest_images_dir     inactive   no
 					Create the local directory
 				</title>
 				<para>
-					Use the virsh command <command>pool-build</command> for this. When <command>pool-build</command> is used with a directory storage pool, it creates the required file system directory.
+					Use the <command>virsh pool-build</command> command  to guild the directory-based storage pool. <command>virsh pool-build</command> sets the required permissions and SELinux settings for the directory and creates the directory if it does not exist.
 				</para>
 				<screen># virsh pool-build <replaceable>guest_images_dir</replaceable>
 Pool guest_images_dir built
-
 # ls -la /<replaceable>guest_images</replaceable>
 total 8
 drwx------.  2 root root 4096 May 30 02:44 .
@@ -190,58 +197,43 @@ dr-xr-xr-x. 26 root root 4096 May 30 02:44 ..
 Name                 State      Autostart 
 -----------------------------------------
 default              active     yes       
-guest_images_dir     inactive   no        
+guest_images_dir     inactive   no</screen>     </step>   
 
-#
-</screen>
-			</step>
 
-			<step>
-				<title>
-					Start the storage pool
-				</title>
+			step>
+				<title>Start the storage pool</title>
 				<para>
 					Use the virsh command <command>pool-start</command> for this. <command>pool-start</command> enables a directory storage pool, allowing it to be used for volumes and guests.
 				</para>
-				<screen># virsh pool-start <replaceable>guest_images_dir</replaceable>
-Pool guest_images_dir started
-
+				<screen># virsh pool-start <replaceable>guest_images_disk</replaceable>
+Pool guest_images_disk started
 # virsh pool-list --all
 Name                 State      Autostart 
 -----------------------------------------
 default              active     yes       
-guest_images_dir     active     no        
-
-#
+guest_images_disk    active     no        
 </screen>
 			</step>
 
-			<step>
-				<title>
-					Turn on autostart
-				</title>
+			<step><title>Turn on autostart</title>
 				<para>
-					When a storage pool is first defined with virsh, it is not set to automatically start each time the virtualization daemon libvirtd is started. This needs to be manually turned on once, via the <command>pool-autostart</command> virsh command. When done, the storage pool is then automatically started each time libvirtd starts.
+					Turn on <parameter>autostart</parameter> for the storage pool. Autostart configures the <systemitem class="daemon">libvirtd</systemitem> service to start the storage pool when the service starts.
 				</para>
+
+	
 				<screen># virsh pool-autostart <replaceable>guest_images_dir</replaceable>
 Pool guest_images_dir marked as autostarted
-
 # virsh pool-list --all
 Name                 State      Autostart 
 -----------------------------------------
 default              active     yes       
 guest_images_dir     active     yes       
-
-#
 </screen>
 			</step>
 
-			<step>
-				<title>
-					Verify the result
-				</title>
+			<step><title>Verify the storage pool configuration</title>
 				<para>
-					Check the storage pool was created correctly, the sizes reported are what you expect them to be, and the State is reported as <command>running</command>.
+					Verify the storage pool was created correctly, the sizes reported correctly, and the state reports as <computeroutput>running</computeroutput>.
 				</para>
 				<screen># virsh pool-info <replaceable>guest_images_dir</replaceable>
 Name:           guest_images_dir
@@ -259,6 +251,7 @@ dr-xr-xr-x. 26 root root 4096 May 30 02:44 ..
 </screen>
 			</step>
 		</procedure>
+	<para>A directory-based storage pool is now available.</para>
 	</section>
 </section>
 
diff --git a/en-US/Storage_Pools_LVM.xml b/en-US/Storage_Pools_LVM.xml
index 82bb443..51c2265 100644
--- a/en-US/Storage_Pools_LVM.xml
+++ b/en-US/Storage_Pools_LVM.xml
@@ -19,14 +19,14 @@
 	<procedure>
 		<title>Creating an LVM storage pool using virt-manager</title>
 		<step>
-			<title>Edit the storage pool definition</title>
+			<title>Open the storage pool settings</title>
 			<substeps>
 				<step>
 					<para>
 						In the <command>virt-manager</command> graphical interface, select the host from the main window.
 					</para>
 					<para>
-						Open the <guilabel>Edit</guilabel> menu and select Host Details
+						Open the <guilabel>Edit</guilabel> menu and select <guilabel>Host Details</guilabel>
 					</para>
 					<mediaobject>
 						<imageobject>
@@ -37,7 +37,7 @@
 
 				<step>
 					<para>
-						Click on the <guilabel>Storage</guilabel> tab of the Host Details window.
+						Click on the <guilabel>Storage</guilabel> tab of the <guilabel>Host Details</guilabel> window.
 					</para>
 					<mediaobject>
 						<imageobject>
@@ -56,13 +56,14 @@
 						Press the <guilabel>+</guilabel> button (the add pool button). The <guilabel>Add a New Storage Pool</guilabel> wizard appears.
 					</para>
 					<para>
-						Choose a <guibutton>Name</guibutton> for the storage pool. We use <replaceable>guest_images_lvm</replaceable> for this example. Then change the <guibutton>Type</guibutton> to <command>logical: LVM Volume Group</command>, and click the <guibutton>Forward</guibutton> button to continue.
+						Choose a <guibutton>Name</guibutton> for the storage pool. We use <replaceable>guest_images_lvm</replaceable> for this example. Then change the <guibutton>Type</guibutton> to <command>logical: LVM Volume Group</command>, and 
 					</para>
 					<mediaobject>
 						<imageobject>
 							<imagedata fileref="images/virt-manager_storage_pools_add_lvm_step_1_name_and_type.png" format="PNG" scalefit="1" />
 						</imageobject>
 					</mediaobject>
+					<para>Press the <guibutton>Forward</guibutton> button to continue.</para>
 				</step>
 
 				<step>
@@ -73,7 +74,7 @@
 					<itemizedlist>
 						<listitem>
 							<para>
-								Leave the <guibutton>Target Path</guibutton> field with the value suggested by the Virtual Machine Manager GUI.  It follows the format of /dev/<replaceable>storage_pool_name</replaceable>, and must not be changed.  This is unlike virsh, which has more flexibility in this area.
+								Leave the <guibutton>Target Path</guibutton> field with the value suggested by <command>virt-manager</command>.  It follows the format of /dev/<replaceable>storage_pool_name</replaceable>, and must not be changed.  This is unlike virsh, which has more flexibility in this area.
 							</para>
 							<para>
 								Our example below uses <replaceable>/dev/guest_images_lvm</replaceable>.
diff --git a/en-US/Storage_Pools_iSCSI.xml b/en-US/Storage_Pools_iSCSI.xml
index d3dc443..cec4748 100644
--- a/en-US/Storage_Pools_iSCSI.xml
+++ b/en-US/Storage_Pools_iSCSI.xml
@@ -223,8 +223,8 @@ Logout of [sid: 2, target: iqn.2010-05.com.example.server1:trial1, portal: 10.0.
 				</substeps>
 			</step>
 
-			<step>
-				<title>Create a new pool (part 1)</title>
+			<substeps><step>
+				<title>Add a new pool (part 1)</title>
 				<para>
 					Press the <guilabel>+</guilabel> button (the add pool button). The <guilabel>Add a New Storage Pool</guilabel> wizard appears.
 				</para>
@@ -239,7 +239,7 @@ Logout of [sid: 2, target: iqn.2010-05.com.example.server1:trial1, portal: 10.0.
 			</step>
 
 			<step>
-				<title>Create a new pool (part 2)</title>
+				<title>Add a new pool (part 2)</title>
 				<para>
 					Enter the target path for the device, the host name of the target and the source path (the IQN). The <guilabel>Format</guilabel> option is not available as formatting is handled by the guests. It is not advised to edit the <guilabel>Target Path</guilabel>. The default target path value, <filename>/dev/disk/by-path/</filename>, adds the drive path to that folder. The target path should be the same on all hosts for migration.
 				</para>
@@ -257,7 +257,7 @@ Logout of [sid: 2, target: iqn.2010-05.com.example.server1:trial1, portal: 10.0.
 				<para>
 					Press <guibutton>Finish</guibutton> to create the new storage pool.
 				</para>
-			</step>
+			</step></substeps>
 		</procedure>
 	</section>
 


More information about the docs-commits mailing list