[PATCH] Added help for host and network tab. Edited help for guests, storage, and templates tab. Signed-off-by: Kersten Richter <kersten@us.ibm.com>

--- ui/pages/help/guests.dita | 146 +++++++++++++++++++++++----------- ui/pages/help/host.dita | 51 ++++++++++++ ui/pages/help/network.dita | 68 ++++++++++++++++ ui/pages/help/storage.dita | 135 +++++++++++++++++++++----------- ui/pages/help/templates.dita | 179 ++++++++++++++++++++++++++++-------------- 5 files changed, 428 insertions(+), 151 deletions(-) create mode 100644 ui/pages/help/host.dita create mode 100644 ui/pages/help/network.dita diff --git a/ui/pages/help/guests.dita b/ui/pages/help/guests.dita index cc6294c..bae98bb 100644 --- a/ui/pages/help/guests.dita +++ b/ui/pages/help/guests.dita @@ -1,47 +1,99 @@ -<?xml version="1.0" encoding="UTF-8"?> -<?Pub Sty _display FontColor="red"?> -<?Pub Inc?> -<cshelp id="kimhvirtm" xml:lang="en-us"> - <title>Virtual machines</title> - <shortdesc>The Virtual machines page lists the defined KVM virtual -machines.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; -for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; -for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p>For each virtual machine, the following information is displayed:<dl><dlentry><dt>Name</dt><dd>Name of the virtual machine.</dd></dlentry><dlentry><dt>CPU</dt><dd>Percentage of processor utilization in the virtual machine.</dd></dlentry><dlentry><dt>Network I/O</dt><dd>Network input/output transmission rate in KB per seconds.</dd></dlentry><dlentry><dt>Disk I/O</dt><dd> Disk input/output transmission rate in KB per seconds.</dd></dlentry><dlentry><dt>Console</dt><dd>Current state of guest operating system console.</dd></dlentry></dl></p> - <p>The following actions icons are displayed for each virtual machine:<dl><dlentry><dt>Reload</dt><dd>Click to reload the displayed data. </dd></dlentry><dlentry><dt>Power</dt><dd>Click to power on the virtual machine. If the icon is red, the -power is off; if the icon is green, the power is on.</dd></dlentry></dl> </p> - <p>The following actions can be selected for each virtual machine:<ul><li>Select <uicontrol>VNC</uicontrol> to connect to the remote console -for the virtual machine.</li><li>Select <uicontrol>Delete</uicontrol> to delete the virtual machine.</li></ul>To create a virtual machine, click the <uicontrol>plus (+)</uicontrol> icon -in the upper right of the page.</p> - </csbody> - <cshelp id="kimhvirtmcrt" xml:lang="en-us"> - <title>Create virtual machine</title> - <shortdesc>Create a virtual machine using an existing template.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; -for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; -for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p> - <ol> - <li>Type the name to be used to identify the virtual machine.</li> - <li>Click to select a template.</li> - <li>Click <uicontrol>Create</uicontrol>.</li> - </ol> - </p> - </csbody> - </cshelp> - <?Pub Caret -1?> -</cshelp> -<?Pub *0000002746?> +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhvirtm" xml:lang="en-us"> +<title>Guests</title> +<shortdesc>The <wintitle>Guests</wintitle> page lists the defined +KVM virtual machines.</shortdesc> +<csbody> +<p>For each guest, the following information is displayed:<dl><dlentry> +<dt>Name</dt> +<dd>Name of the virtual machine.</dd> +</dlentry><dlentry> +<dt>CPU</dt> +<dd>Percentage of processor utilization in the virtual machine.</dd> +</dlentry><dlentry> +<dt>Network I/O</dt> +<dd>Network input/output transmission rate in KB per seconds.</dd> +</dlentry><dlentry> +<dt>Disk I/O</dt> +<dd> Disk input/output transmission rate in KB per seconds.</dd> +</dlentry><dlentry> +<dt>Livetile</dt> +<dd rev="rev1">State of guest operating system console, or an icon +that represents the <tm tmtype="tm" trademark="Linux">Linux</tm> distribution +if the guest is not active.</dd> +</dlentry></dl></p> +<p>The following actions icons are displayed for each guest:<dl> +<dlentry> +<dt rev="rev1">Reset</dt> +<dd rev="rev1">Click to reset the guest. </dd> +</dlentry><dlentry> +<dt><tm tmclass="IGNORE" tmtype="reg" trademark="Power">Power</tm> (Start +or Stop)</dt> +<dd>Click to power on or power off the guest. If the icon is red, +the power is off; if the icon is green, the power is on.</dd> +</dlentry></dl> </p> +<p>The following actions can be selected for each guest:<ul> +<li>Select <uicontrol>VNC</uicontrol> to connect to the remote console +for the guest operating system.</li> +<li>Select <uicontrol>Edit</uicontrol> to edit the properties of an +existing guest. Guests can be edited only while stopped.</li> +<li>Select <uicontrol>Delete</uicontrol> to delete the guest.</li> +</ul>To create a guest, or virtual machine, click the <uicontrol>plus +(+)</uicontrol> icon in the upper right of the page.</p> +</csbody> +<cshelp id="kimhvirtmcrt" xml:lang="en-us"> +<title>Create virtual machine</title> +<shortdesc>Create a virtual machine by using an existing template.</shortdesc> +<csbody> +<p> <ol> +<li>Type the name to be used to identify the virtual machine.</li> +<li rev="rev1">Select a template. <ul> +<li>If templates exist, select from displayed templates.</li> +<li>If no templates exist, click <uicontrol>Create a template</uicontrol> to +create a template.</li> +</ul></li> +<li>Click <uicontrol>Create</uicontrol>.</li> +</ol> </p> +</csbody> +</cshelp> +<cshelp id="kimhvirtmedit" xml:lang="en-us"> +<title>Edit guest</title> +<shortdesc rev="rev1">Edit the properties of an existing virtual machine. +Guests can be edited only while stopped.</shortdesc> +<csprolog><csmetadata> +<cswindowtitle>Title of window or panel associated with this help; +for review output only.</cswindowtitle> +<cswidgetlabel>Name of field or control associated with this help; +for review output only</cswidgetlabel> +</csmetadata></csprolog> +<csbody> +<p>For each guest, the following information is displayed:<dl><dlentry> +<dt>Name</dt> +<dd>Name of the virtual machine.</dd> +</dlentry><dlentry> +<dt>CPUs</dt> +<dd>Number of processors.</dd> +</dlentry><dlentry> +<dt>Memory</dt> +<dd>Amount of memory in MB.</dd> +</dlentry><dlentry> +<dt>Icon</dt> +<dd rev="rev2"> Graphic image representing the Linux distribution +to be displayed in place of current status (Livetile) when the guest +is not active.</dd> +</dlentry></dl></p> +<p> Fields that are not disabled can be edited. After you edit a field, +click <uicontrol>Save</uicontrol>. </p> +</csbody> +</cshelp><?Pub Caret -1?> +<?tm 1391540919 3?> +</cshelp> +<?Pub *0000003805?> diff --git a/ui/pages/help/host.dita b/ui/pages/help/host.dita new file mode 100644 index 0000000..d961edc --- /dev/null +++ b/ui/pages/help/host.dita @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhhost" xml:lang="en-us"> +<title>Host</title> +<shortdesc rev="rev1">The <wintitle>Host</wintitle> page shows information +about the host system, and allows you to shut down, restart, and connect +to the host.</shortdesc> +<csbody> +<p>You can perform the following actions on the host:<ul> +<li>Select <uicontrol>Shut down</uicontrol> to shut down the host +system.</li> +<li>Select <uicontrol>Restart</uicontrol> to restart the host system.</li> +<li rev="rev1">Select <uicontrol>Connect</uicontrol> to open a VNC +connection to the host system, if it is not already connected.</li> +</ul></p> +<p>Click the following sections to display information about the host:<dl> +<dlentry> +<dt>Basic information</dt> +<dd>This section displays the host operating system distribution, +version, and code name, as well as the processor type and amount of +memory in GB.</dd> +</dlentry><dlentry> +<dt>System statistics</dt> +<dd rev="rev1">This section displays graphs to show statistics for +CPU, memory, disk I/O, and network I/O for the host. Select <uicontrol>Collecting +data after leaving this page</uicontrol> to continue collecting data +when the host tab is out of view.</dd> +</dlentry><dlentry> +<dt>Debug reports</dt> +<dd rev="rev1">This section displays debug reports, including name +and file path. You can select from options to generate a new report, +or rename, remove, or download an existing report.<p>The debug report +is generated using the <cmdname>sosreport</cmdname> command. It is +available for Red Hat Enterprise <tm tmtype="tm" trademark="Linux">Linux</tm>, +Fedora, and Ubuntu distributions. The command generates a .tar file +that contains configuration and diagnostic information, such as the +running kernel version, loaded modules, and system and service configuration +files. The command also runs external programs to collect further +information and stores this output in the resulting archive.</p> </dd> +</dlentry></dl></p> +</csbody><?Pub Caret -2?> +<?tm 1392659967 1?> +</cshelp> +<?Pub *0000002392?> diff --git a/ui/pages/help/network.dita b/ui/pages/help/network.dita new file mode 100644 index 0000000..4846d5b --- /dev/null +++ b/ui/pages/help/network.dita @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhnetw" xml:lang="en-us"> +<title>Network</title> +<shortdesc>The <wintitle>Network</wintitle> page displays information +about the network connection.</shortdesc> +<csbody> +<p><dl><dlentry> +<dt>Network Name</dt> +<dd>Name of the network, or <uicontrol>default</uicontrol>.</dd> +</dlentry><dlentry> +<dt>State</dt> +<dd>State of the network, active (green) or inactive (red). </dd> +</dlentry><dlentry> +<dt>Network type</dt> +<dd>Network type, for example, <uicontrol>NAT</uicontrol> (network +address translation).</dd> +</dlentry><dlentry> +<dt>Interface</dt> +<dd>Network interface, for example, <uicontrol>virbr0</uicontrol> (default).</dd> +</dlentry><dlentry> +<dt>Address space</dt> +<dd>IP address.</dd> +</dlentry></dl></p> +<p>The following actions can be selected:<ul> +<li rev="rev1">Select <uicontrol>Start</uicontrol> to begin the network +connection.</li> +<li>Select <uicontrol>Stop</uicontrol> to end the network connection.</li> +<li>Select <uicontrol>Delete</uicontrol> to delete the connection +information.</li> +</ul>To create a network, click the <uicontrol>plus (+)</uicontrol> icon +in the upper right of the display.</p> +</csbody> +<cshelp id="kimhnetwcrt" xml:lang="en-us"> +<title>Create a network</title> +<shortdesc>Create a network.</shortdesc> +<csbody> +<p> <ol> +<li>Type the name of the network.</li> +<li>Click to select the network type. <dl rev="rev1"><dlentry> +<dt><uicontrol>Isolated</uicontrol></dt> +<dd>Isolated mode. Guests cannot send or receive communication to +or from external systems.</dd> +</dlentry><dlentry> +<dt><uicontrol>NAT</uicontrol></dt> +<dd>Network Address Translation mode. Communication from guests to +external systems uses the host IP address. External systems cannot +initiate communication to guests.</dd> +</dlentry><dlentry> +<dt><uicontrol>Bridged</uicontrol></dt> +<dd>Bridged mode. Guests can communicate with external systems and +be contacted by external systems as if they were physical systems +on the network. For bridged mode, you must specify additional destination +and VLAN information.</dd> +</dlentry></dl><?Pub Caret 224?></li> +<li>Click <uicontrol>Create</uicontrol>.</li> +</ol> </p> +</csbody> +</cshelp> +</cshelp> +<?Pub *0000002571?> diff --git a/ui/pages/help/storage.dita b/ui/pages/help/storage.dita index f9ae93e..9ad0ea4 100644 --- a/ui/pages/help/storage.dita +++ b/ui/pages/help/storage.dita @@ -1,45 +1,90 @@ -<?xml version="1.0" encoding="UTF-8"?> -<?xml-stylesheet href="dita.xsl" type="text/xsl" ?> -<?Pub Sty _display FontColor="red"?> -<?Pub Inc?> -<cshelp id="kimhstor" xml:lang="en-us"> - <title>Storage</title> - <shortdesc>The Storage page lists the available storage pools, including the default storage pool.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p>For each storage pool, the following information is displayed:<dl><dlentry><dt>Name</dt><dd>Name of the storage pool and percentage used.</dd></dlentry><dlentry><dt>State</dt><dd>State of the storage pool, active (green) or inactive (red). </dd></dlentry><dlentry><dt>Location</dt><dd>File path to the location of the storage pool.</dd></dlentry><dlentry><dt>Type</dt><dd><uicontrol>dir</uicontrol> for directory.</dd></dlentry><dlentry><dt>Capacity</dt><dd>Amount of space in the storage pool.</dd></dlentry><dlentry><dt>Allocated</dt><dd>Amount of space already allocated in the storage pool.</dd></dlentry></dl></p> - <p>The following actions can be selected for each storage pool:<ul><li>Select <uicontrol>Activate</uicontrol> to activate the storage -pool so that it can be used.</li><li>Select <uicontrol>Undefine</uicontrol> to remove an inactive storage -pool.</li></ul></p> - <p>To display storage volume details for a storage pool, click the -arrow on the right side of the storage pool row. Details include -the following:<dl><dlentry><dt>Type</dt><dd>The type of storage pool, for example, dir or disk.</dd></dlentry><dlentry><dt>Format</dt><dd>The format, varying dependent on the type.</dd></dlentry><dlentry><dt>Capacity</dt><dd>Size of the storage volume.</dd></dlentry><dlentry><dt>Allocated</dt><dd>Amount of space already allocated in the storage pool.</dd></dlentry></dl>To define a storage pool, click the <uicontrol>plus -(+)</uicontrol> icon in the upper right of the display.</p> - </csbody> - <cshelp id="kimhdefstor" xml:lang="en-us"> - <title>Define a storage pool</title> - <shortdesc> Define a storage pool.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p> - <ol> - <li>Type the name to be used to identify the storage pool.</li> - <li>Type the file path to the storage pool.</li> - <li>Click <uicontrol>Create</uicontrol>.</li> - </ol> - </p> - </csbody> - </cshelp> - <?Pub Caret -1?> -</cshelp> -<?Pub *0000003013?> +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhstor" xml:lang="en-us"> +<title>Storage</title> +<shortdesc>The <wintitle>Storage</wintitle> page lists the available +storage pools, including the default storage pool.</shortdesc> +<csbody> +<p>For each storage pool, the following information is displayed:<dl> +<dlentry> +<dt>Name</dt> +<dd>Name of the storage pool and percentage used.</dd> +</dlentry><dlentry> +<dt>State</dt> +<dd>State of the storage pool, active (green) or inactive (red). </dd> +</dlentry><dlentry> +<dt>Location</dt> +<dd>File path to the location of the storage pool.</dd> +</dlentry><dlentry> +<dt>Type</dt> +<dd>Type of storage pool, for example, <uicontrol>dir</uicontrol>.</dd> +</dlentry><dlentry> +<dt>Capacity</dt> +<dd>Amount of space in the storage pool.</dd> +</dlentry><dlentry> +<dt>Allocated</dt> +<dd>Amount of space that is already allocated in the storage pool.</dd> +</dlentry></dl></p> +<p>The following actions can be selected for each storage pool:<ul> +<li>Select <uicontrol>Activate</uicontrol> to activate the storage +pool so that it can be used.</li> +<li>Select <uicontrol>Deactivate</uicontrol> to deactivate an active +storage pool.</li> +<li>Select <uicontrol>Undefine</uicontrol> to remove an inactive storage +pool.</li> +</ul></p> +<p>To display storage volume details for a storage pool, click the +arrow on the right side of the storage pool row. Details include +the following:<dl><dlentry> +<dt>Type</dt> +<dd>The type of volume, for example, <uicontrol>file</uicontrol>.</dd> +</dlentry><dlentry> +<dt>Format</dt> +<dd>The format, varying dependent on the type.</dd> +</dlentry><dlentry> +<dt>Capacity</dt> +<dd>Size of the storage volume.</dd> +</dlentry><dlentry> +<dt>Allocation</dt> +<dd>Amount of space that is already allocated in the storage pool.</dd> +</dlentry></dl><?Pub Caret -2?>To define a storage pool, click the <uicontrol>plus +(+)</uicontrol> icon in the upper right of the display.</p> +</csbody> +<cshelp id="kimhdefstor" xml:lang="en-us"> +<title>Define a storage pool</title> +<shortdesc> Define a storage pool.</shortdesc> +<csbody> +<p> <ol> +<li>In the <uicontrol>Storage pool name</uicontrol> field, type the +name to be used to identify the storage pool.</li> +<li>In the <uicontrol>Storage pool type</uicontrol> list, select the +type: <dl rev="rev1"><dlentry> +<dt><uicontrol>DIR</uicontrol></dt> +<dd>Specifies a directory pool. When selecting <uicontrol>DIR</uicontrol>, +type the <uicontrol>Storage path</uicontrol> (file path to the storage +pool).</dd> +</dlentry><dlentry> +<dt><uicontrol>NFS</uicontrol></dt> +<dd>Specifies a network filesystem pool. When selecting <uicontrol>NFS</uicontrol>, +type the <uicontrol>NFS server IP</uicontrol> address and <uicontrol>NFS +path</uicontrol> (path of the exported directory).</dd> +</dlentry><dlentry> +<dt><uicontrol>iSCSI</uicontrol></dt> +<dd>Specifies a pool based on a target allocated on an iSCSI server. +When selecting <uicontrol>iSCSI</uicontrol>, type the <uicontrol>iSCSI +server</uicontrol> IP address and <uicontrol>Target</uicontrol> on +the iSCSI server. You can optionally select to add iSCSI authentication.</dd> +</dlentry></dl></li> +<li>Click <uicontrol>Create</uicontrol>.</li> +</ol> </p> +</csbody> +</cshelp> +</cshelp> +<?Pub *0000003580?> diff --git a/ui/pages/help/templates.dita b/ui/pages/help/templates.dita index 0a9bcff..5048fc8 100644 --- a/ui/pages/help/templates.dita +++ b/ui/pages/help/templates.dita @@ -1,59 +1,120 @@ -<?xml version="1.0" encoding="UTF-8"?> -<?Pub Sty _display FontColor="red"?> -<?Pub Inc?> -<cshelp id="kimhtempl" xml:lang="en-us"> - <title>Templates</title> - <shortdesc>The Templates page shows the defined virtual machine templates -that can be used to create KVM virtual machines.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; -for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; -for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p>For each template, the following information is displayed:<dl><dlentry><dt>OS</dt><dd>Name of the operating system or distribution.</dd></dlentry><dlentry><dt>Version</dt><dd>Version of the operating system or distribution.</dd></dlentry><dlentry><dt>CPU</dt><dd>Number of processors defined for the template.</dd></dlentry><dlentry><dt>Memory</dt><dd>Amount of random access memory to be allocated, in MB.</dd></dlentry></dl></p> - <p>The following actions can be selected for each template:<ul><li>Select <uicontrol>Edit</uicontrol> to edit the template.</li><li>Select <uicontrol>Delete</uicontrol> to delete the template.</li></ul>To add a template, click the <uicontrol>plus (+)</uicontrol> icon -in the upper right of the display.</p> - </csbody> - <cshelp id="kimhedittempl" xml:lang="en-us"> - <title>Edit template</title> - <shortdesc>Edit an existing template.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; -for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; -for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p><ol><li>Edit the following information for the template:<dl><dlentry><dt>Name</dt><dd>Name of the template.</dd></dlentry><dlentry><dt>CPU</dt><dd>Number of processors defined for the template.</dd></dlentry><dlentry><dt>Memory</dt><dd>Memory to be allocated to the virtual machine.</dd></dlentry></dl></li><li>Click <uicontrol>Save</uicontrol>.</li></ol>The following information is displayed but cannot be edited:<dl><dlentry><dt>Vendor</dt><dd>The name of the company that created the operating system or distribution -that the template is configured to use.</dd></dlentry><dlentry><dt>Version</dt><dd>The version of the operating system or distribution that the template -is configured to use.</dd></dlentry></dl></p> - </csbody> - </cshelp> - <?Pub Caret -1?> - <cshelp id="kimhaddtempl"> - <title>Add template</title> - <shortdesc>Add a template from source media.</shortdesc> - <csbody> - <p>Select the location from the following options:<ol><li>Select the location of the source media from the following options:<dl><dlentry><dt>Local ISO image</dt><dd>Select to scan storage pools for installation ISO images available -on the system.</dd></dlentry><dlentry><dt>Remote ISO image</dt><dd>Select to specify a remote location for an installation ISO image.</dd></dlentry></dl></li><li>Click <uicontrol>Create</uicontrol>.</li></ol></p> - </csbody> - </cshelp> - <cshelp id="kimhaddloct"> - <title>Add template - local ISO image</title> - <shortdesc>Add a template from a local ISO image.</shortdesc> - <csbody> - <p>The ISO images available on the system are displayed.<dl><dlentry><dt>OS</dt><dd>Name of the operating system or distribution.</dd></dlentry><dlentry><dt>Version</dt><dd>Version of the operating system or distribution.</dd></dlentry><dlentry><dt>Size</dt><dd>Size of the ISO image.</dd></dlentry></dl></p> - <p>To create a template from an ISO image, complete the following -steps:<ol><li>Choose from the following options:<ul><li>Select an ISO image from which to create a template.</li><li>Select the <uicontrol>All</uicontrol> check box to create a template -from each listed ISO image.</li><li>Select the <uicontrol>I want to use a specific file</uicontrol> check -box to specify a path to the ISO image.</li></ul></li><li>Click <uicontrol>Create</uicontrol>.</li></ol></p> - </csbody> - </cshelp> -</cshelp> -<?Pub *0000004376?> +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhtempl" xml:lang="en-us"> +<title>Templates</title> +<shortdesc>The <wintitle>Templates</wintitle> page shows the defined +virtual machine templates that can be used to create KVM guests.</shortdesc> +<csbody> +<p>For each template, the following information is displayed:<dl> +<dlentry> +<dt>OS</dt> +<dd>Name of the operating system or distribution.</dd> +</dlentry><dlentry> +<dt>Version</dt> +<dd>Version of the operating system or distribution.</dd> +</dlentry><dlentry> +<dt>CPUs</dt> +<dd>Number of processors that are defined for the template.</dd> +</dlentry><dlentry> +<dt>Memory</dt> +<dd>Amount of random access memory to be allocated, in MB.</dd> +</dlentry></dl></p> +<p>The following actions can be selected for each template:<ul> +<li>Select <uicontrol>Edit</uicontrol> to edit the template.</li> +<li>Select <uicontrol>Delete</uicontrol> to delete the template.</li> +</ul>To add a template, click the <uicontrol>plus (+)</uicontrol> icon +in the upper right of the display.</p> +</csbody> +<cshelp id="kimhedittempl" xml:lang="en-us"> +<title>Edit template</title> +<shortdesc>Edit an existing template.</shortdesc> +<csbody> +<p>For each template, the following information is displayed: <dl> +<dlentry> +<dt>Name</dt> +<dd>Name of the template.</dd> +</dlentry><dlentry> +<dt>Vendor</dt> +<dd>The name of the company that created the operating system or distribution +that the template is configured to use.</dd> +</dlentry><dlentry> +<dt>Version</dt> +<dd>The version of the operating system or distribution that the template +is configured to use.</dd> +</dlentry><dlentry> +<dt>CPU number</dt> +<dd>Number of processors that are defined for the template.</dd> +</dlentry><dlentry> +<dt>Memory</dt> +<dd>Amount of memory in MB to be allocated to the virtual machine.</dd> +</dlentry><dlentry> +<dt>Disk</dt> +<dd rev="rev1">Disk size in GB.</dd> +</dlentry><dlentry> +<dt>CDROM</dt> +<dd>File path to the location of the template.</dd> +</dlentry><dlentry> +<dt>Storage pool</dt> +<dd>Specific storage pool or the default storage pool.</dd> +</dlentry><dlentry> +<dt>Network</dt> +<dd rev="rev1">Default network.</dd> +</dlentry></dl><?Pub Caret 427?> Fields that are not disabled can +be edited. After you edit a field, click <uicontrol>Save</uicontrol>. </p> +</csbody> +</cshelp> +<cshelp id="kimhaddtempl"> +<title>Add template</title> +<shortdesc>Add a template from source media.</shortdesc> +<csbody> +<p>Select the location of the source media from the following options:<dl> +<dlentry> +<dt>Local ISO image</dt> +<dd>Select to scan storage pools for installation ISO images available +on the system.</dd> +</dlentry><dlentry> +<dt>Remote ISO image</dt> +<dd>Select to specify a remote location for an installation ISO image.</dd> +</dlentry></dl></p> +</csbody> +</cshelp> +<cshelp id="kimhaddloct"> +<title>Add template - local ISO image</title> +<shortdesc>Add a template from a local ISO image.</shortdesc> +<csbody> +<p>The ISO images available on the system are displayed.<dl><dlentry> +<dt>OS</dt> +<dd>Name of the operating system or distribution.</dd> +</dlentry><dlentry> +<dt>Version</dt> +<dd>Version of the operating system or distribution.</dd> +</dlentry><dlentry> +<dt>Size</dt> +<dd>Size of the ISO image.</dd> +</dlentry></dl></p> +<p>To create a template from an ISO image, choose from the following +options:<ul> +<li>Select an ISO image from which to create a template, then click <uicontrol>Create +Templates from Selected ISO</uicontrol>.</li> +<li>Select <uicontrol>All</uicontrol> to create a template from each + listed ISO image, then click <uicontrol>Create Templates from Selected +ISO</uicontrol>.</li> +<li rev="rev1">If the ISO image that you want to use does not appear +in the scan results, you can select from the following options:<ul> +<li>Select <uicontrol>I want to use a specific ISO file</uicontrol> to +specify a path to the ISO image.</li> +<li>Click <uicontrol>Search more ISOs</uicontrol> to search for more +ISO images.</li> +</ul></li> +</ul></p> +</csbody> +</cshelp> +</cshelp> +<?Pub *0000004366?> -- 1.7.1

Thanks for this patch. Some minor comments below. On 03/04/2014 03:50 PM, Kersten Richter wrote:
--- ui/pages/help/guests.dita | 146 +++++++++++++++++++++++----------- ui/pages/help/host.dita | 51 ++++++++++++ ui/pages/help/network.dita | 68 ++++++++++++++++ ui/pages/help/storage.dita | 135 +++++++++++++++++++++----------- ui/pages/help/templates.dita | 179 ++++++++++++++++++++++++++++-------------- 5 files changed, 428 insertions(+), 151 deletions(-) create mode 100644 ui/pages/help/host.dita create mode 100644 ui/pages/help/network.dita
diff --git a/ui/pages/help/guests.dita b/ui/pages/help/guests.dita index cc6294c..bae98bb 100644 --- a/ui/pages/help/guests.dita +++ b/ui/pages/help/guests.dita @@ -1,47 +1,99 @@ -<?xml version="1.0" encoding="UTF-8"?> -<?Pub Sty _display FontColor="red"?> -<?Pub Inc?> -<cshelp id="kimhvirtm" xml:lang="en-us"> - <title>Virtual machines</title> - <shortdesc>The Virtual machines page lists the defined KVM virtual -machines.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; -for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; -for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p>For each virtual machine, the following information is displayed:<dl><dlentry><dt>Name</dt><dd>Name of the virtual machine.</dd></dlentry><dlentry><dt>CPU</dt><dd>Percentage of processor utilization in the virtual machine.</dd></dlentry><dlentry><dt>Network I/O</dt><dd>Network input/output transmission rate in KB per seconds.</dd></dlentry><dlentry><dt>Disk I/O</dt><dd> Disk input/output transmission rate in KB per seconds.</dd></dlentry><dlentry><dt>Console</dt><dd>Current state of guest operating system console.</dd></dlentry></dl></p> - <p>The following actions icons are displayed for each virtual machine:<dl><dlentry><dt>Reload</dt><dd>Click to reload the displayed data. </dd></dlentry><dlentry><dt>Power</dt><dd>Click to power on the virtual machine. If the icon is red, the -power is off; if the icon is green, the power is on.</dd></dlentry></dl> </p> - <p>The following actions can be selected for each virtual machine:<ul><li>Select <uicontrol>VNC</uicontrol> to connect to the remote console -for the virtual machine.</li><li>Select <uicontrol>Delete</uicontrol> to delete the virtual machine.</li></ul>To create a virtual machine, click the <uicontrol>plus (+)</uicontrol> icon -in the upper right of the page.</p> - </csbody> - <cshelp id="kimhvirtmcrt" xml:lang="en-us"> - <title>Create virtual machine</title> - <shortdesc>Create a virtual machine using an existing template.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; -for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; -for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p> - <ol> - <li>Type the name to be used to identify the virtual machine.</li> - <li>Click to select a template.</li> - <li>Click <uicontrol>Create</uicontrol>.</li> - </ol> - </p> - </csbody> - </cshelp> - <?Pub Caret -1?> -</cshelp> -<?Pub *0000002746?> +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhvirtm" xml:lang="en-us"> +<title>Guests</title> +<shortdesc>The <wintitle>Guests</wintitle> page lists the defined +KVM virtual machines.</shortdesc> +<csbody> +<p>For each guest, the following information is displayed:<dl><dlentry> +<dt>Name</dt> +<dd>Name of the virtual machine.</dd> +</dlentry><dlentry> +<dt>CPU</dt> +<dd>Percentage of processor utilization in the virtual machine.</dd> +</dlentry><dlentry> +<dt>Network I/O</dt> +<dd>Network input/output transmission rate in KB per seconds.</dd> +</dlentry><dlentry> +<dt>Disk I/O</dt> +<dd> Disk input/output transmission rate in KB per seconds.</dd> +</dlentry><dlentry> +<dt>Livetile</dt> +<dd rev="rev1">State of guest operating system console, or an icon +that represents the <tm tmtype="tm" trademark="Linux">Linux</tm> distribution +if the guest is not active.</dd> +</dlentry></dl></p> +<p>The following actions icons are displayed for each guest:<dl> +<dlentry> +<dt rev="rev1">Reset</dt> +<dd rev="rev1">Click to reset the guest. </dd> +</dlentry><dlentry> +<dt><tm tmclass="IGNORE" tmtype="reg" trademark="Power">Power</tm> (Start +or Stop)</dt> +<dd>Click to power on or power off the guest. If the icon is red, +the power is off; if the icon is green, the power is on.</dd> +</dlentry></dl> </p> +<p>The following actions can be selected for each guest:<ul> +<li>Select <uicontrol>VNC</uicontrol> to connect to the remote console +for the guest operating system.</li> +<li>Select <uicontrol>Edit</uicontrol> to edit the properties of an +existing guest. Guests can be edited only while stopped.</li> +<li>Select <uicontrol>Delete</uicontrol> to delete the guest.</li> +</ul>To create a guest, or virtual machine, click the <uicontrol>plus +(+)</uicontrol> icon in the upper right of the page.</p> +</csbody> +<cshelp id="kimhvirtmcrt" xml:lang="en-us"> +<title>Create virtual machine</title> +<shortdesc>Create a virtual machine by using an existing template.</shortdesc> +<csbody> +<p> <ol> +<li>Type the name to be used to identify the virtual machine.</li> +<li rev="rev1">Select a template. <ul> +<li>If templates exist, select from displayed templates.</li> +<li>If no templates exist, click <uicontrol>Create a template</uicontrol> to +create a template.</li> +</ul></li> +<li>Click <uicontrol>Create</uicontrol>.</li> +</ol> </p> +</csbody> +</cshelp> +<cshelp id="kimhvirtmedit" xml:lang="en-us"> +<title>Edit guest</title> +<shortdesc rev="rev1">Edit the properties of an existing virtual machine. +Guests can be edited only while stopped.</shortdesc> +<csprolog><csmetadata> +<cswindowtitle>Title of window or panel associated with this help; +for review output only.</cswindowtitle> +<cswidgetlabel>Name of field or control associated with this help; +for review output only</cswidgetlabel> +</csmetadata></csprolog> +<csbody> +<p>For each guest, the following information is displayed:<dl><dlentry> +<dt>Name</dt> +<dd>Name of the virtual machine.</dd> +</dlentry><dlentry> +<dt>CPUs</dt> +<dd>Number of processors.</dd> +</dlentry><dlentry> +<dt>Memory</dt> +<dd>Amount of memory in MB.</dd> +</dlentry><dlentry> +<dt>Icon</dt> +<dd rev="rev2"> Graphic image representing the Linux distribution +to be displayed in place of current status (Livetile) when the guest +is not active.</dd> +</dlentry></dl></p> +<p> Fields that are not disabled can be edited. After you edit a field, +click <uicontrol>Save</uicontrol>. </p> +</csbody> +</cshelp><?Pub Caret -1?> +<?tm 1391540919 3?> +</cshelp> +<?Pub *0000003805?> diff --git a/ui/pages/help/host.dita b/ui/pages/help/host.dita new file mode 100644 index 0000000..d961edc --- /dev/null +++ b/ui/pages/help/host.dita @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhhost" xml:lang="en-us"> +<title>Host</title> +<shortdesc rev="rev1">The <wintitle>Host</wintitle> page shows information +about the host system, and allows you to shut down, restart, and connect +to the host.</shortdesc> +<csbody> +<p>You can perform the following actions on the host:<ul> +<li>Select <uicontrol>Shut down</uicontrol> to shut down the host +system.</li> +<li>Select <uicontrol>Restart</uicontrol> to restart the host system.</li> +<li rev="rev1">Select <uicontrol>Connect</uicontrol> to open a VNC +connection to the host system, if it is not already connected.</li> +</ul></p> +<p>Click the following sections to display information about the host:<dl> +<dlentry> +<dt>Basic information</dt> +<dd>This section displays the host operating system distribution, +version, and code name, as well as the processor type and amount of +memory in GB.</dd> +</dlentry><dlentry> +<dt>System statistics</dt> +<dd rev="rev1">This section displays graphs to show statistics for +CPU, memory, disk I/O, and network I/O for the host. Select <uicontrol>Collecting +data after leaving this page</uicontrol> to continue collecting data +when the host tab is out of view.</dd> +</dlentry><dlentry> +<dt>Debug reports</dt> +<dd rev="rev1">This section displays debug reports, including name +and file path. You can select from options to generate a new report, +or rename, remove, or download an existing report.<p>The debug report +is generated using the <cmdname>sosreport</cmdname> command. It is +available for Red Hat Enterprise <tm tmtype="tm" trademark="Linux">Linux</tm>, +Fedora, and Ubuntu distributions. The command generates a .tar file +that contains configuration and diagnostic information, such as the +running kernel version, loaded modules, and system and service configuration +files. The command also runs external programs to collect further +information and stores this output in the resulting archive.</p> </dd> +</dlentry></dl></p> +</csbody><?Pub Caret -2?> +<?tm 1392659967 1?> +</cshelp> +<?Pub *0000002392?> diff --git a/ui/pages/help/network.dita b/ui/pages/help/network.dita new file mode 100644 index 0000000..4846d5b --- /dev/null +++ b/ui/pages/help/network.dita @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColort="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhnetw" xml:lang="en-us"> +<title>Network</title> +<shortdesc>The <wintitle>Network</wintitle> page displays information +about the network connection.</shortdesc> +<csbody> +<p><dl><dlentry> +<dt>Network Name</dt> +<dd>Name of the network, or <uicontrol>default</uicontrol>.</dd> +</dlentry><dlentry> +<dt>State</dt> +<dd>State of the network, active (green) or inactive (red). </dd> +</dlentry><dlentry> +<dt>Network type</dt> +<dd>Network type, for example, <uicontrol>NAT</uicontrol> (network +address translation).</dd> +</dlentry><dlentry> +<dt>Interface</dt> +<dd>Network interface, for example, <uicontrol>virbr0</uicontrol> (default).</dd> +</dlentry><dlentry> +<dt>Address space</dt> +<dd>IP address.</dd> +</dlentry></dl></p> +<p>The following actions can be selected:<ul> +<li rev="rev1">Select <uicontrol>Start</uicontrol> to begin the network +connection.</li> +<li>Select <uicontrol>Stop</uicontrol> to end the network connection.</li> +<li>Select <uicontrol>Delete</uicontrol> to delete the connection +information.</li> +</ul>To create a network, click the <uicontrol>plus (+)</uicontrol> icon +in the upper right of the display.</p> +</csbody> +<cshelp id="kimhnetwcrt" xml:lang="en-us"> +<title>Create a network</title> +<shortdesc>Create a network.</shortdesc> +<csbody> +<p> <ol> +<li>Type the name of the network.</li> +<li>Click to select the network type. <dl rev="rev1"><dlentry> +<dt><uicontrol>Isolated</uicontrol></dt> +<dd>Isolated mode. Guests cannot send or receive communication to +or from external systems.</dd> +</dlentry><dlentry> +<dt><uicontrol>NAT</uicontrol></dt> +<dd>Network Address Translation mode. Communication from guests to +external systems uses the host IP address. External systems cannot +initiate communication to guests.</dd> +</dlentry><dlentry> +<dt><uicontrol>Bridged</uicontrol></dt> +<dd>Bridged mode. Guests can communicate with external systems and +be contacted by external systems as if they were physical systems +on the network. For bridged mode, you must specify additional destination +and VLAN information.</dd> +</dlentry></dl><?Pub Caret 224?></li> +<li>Click <uicontrol>Create</uicontrol>.</li> +</ol> </p> +</csbody> +</cshelp> +</cshelp> +<?Pub *0000002571?> diff --git a/ui/pages/help/storage.dita b/ui/pages/help/storage.dita index f9ae93e..9ad0ea4 100644 --- a/ui/pages/help/storage.dita +++ b/ui/pages/help/storage.dita @@ -1,45 +1,90 @@ -<?xml version="1.0" encoding="UTF-8"?> -<?xml-stylesheet href="dita.xsl" type="text/xsl" ?> -<?Pub Sty _display FontColor="red"?> -<?Pub Inc?> -<cshelp id="kimhstor" xml:lang="en-us"> - <title>Storage</title> - <shortdesc>The Storage page lists the available storage pools, including the default storage pool.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p>For each storage pool, the following information is displayed:<dl><dlentry><dt>Name</dt><dd>Name of the storage pool and percentage used.</dd></dlentry><dlentry><dt>State</dt><dd>State of the storage pool, active (green) or inactive (red). </dd></dlentry><dlentry><dt>Location</dt><dd>File path to the location of the storage pool.</dd></dlentry><dlentry><dt>Type</dt><dd><uicontrol>dir</uicontrol> for directory.</dd></dlentry><dlentry><dt>Capacity</dt><dd>Amount of space in the storage pool.</dd></dlentry><dlentry><dt>Allocated</dt><dd>Amount of space already allocated in the storage pool.</dd></dlentry></dl></p> - <p>The following actions can be selected for each storage pool:<ul><li>Select <uicontrol>Activate</uicontrol> to activate the storage -pool so that it can be used.</li><li>Select <uicontrol>Undefine</uicontrol> to remove an inactive storage -pool.</li></ul></p> - <p>To display storage volume details for a storage pool, click the -arrow on the right side of the storage pool row. Details include -the following:<dl><dlentry><dt>Type</dt><dd>The type of storage pool, for example, dir or disk.</dd></dlentry><dlentry><dt>Format</dt><dd>The format, varying dependent on the type.</dd></dlentry><dlentry><dt>Capacity</dt><dd>Size of the storage volume.</dd></dlentry><dlentry><dt>Allocated</dt><dd>Amount of space already allocated in the storage pool.</dd></dlentry></dl>To define a storage pool, click the <uicontrol>plus -(+)</uicontrol> icon in the upper right of the display.</p> - </csbody> - <cshelp id="kimhdefstor" xml:lang="en-us"> - <title>Define a storage pool</title> - <shortdesc> Define a storage pool.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p> - <ol> - <li>Type the name to be used to identify the storage pool.</li> - <li>Type the file path to the storage pool.</li> - <li>Click <uicontrol>Create</uicontrol>.</li> - </ol> - </p> - </csbody> - </cshelp> - <?Pub Caret -1?> -</cshelp> -<?Pub *0000003013?> +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhstor" xml:lang="en-us"> +<title>Storage</title> +<shortdesc>The <wintitle>Storage</wintitle> page lists the available +storage pools, including the default storage pool.</shortdesc> +<csbody> +<p>For each storage pool, the following information is displayed:<dl> +<dlentry> +<dt>Name</dt> +<dd>Name of the storage pool and percentage used.</dd> +</dlentry><dlentry> +<dt>State</dt> +<dd>State of the storage pool, active (green) or inactive (red). </dd> +</dlentry><dlentry> +<dt>Location</dt> +<dd>File path to the location of the storage pool.</dd> +</dlentry><dlentry> +<dt>Type</dt> +<dd>Type of storage pool, for example, <uicontrol>dir</uicontrol>.</dd> +</dlentry><dlentry> +<dt>Capacity</dt> +<dd>Amount of space in the storage pool.</dd> +</dlentry><dlentry> +<dt>Allocated</dt> +<dd>Amount of space that is already allocated in the storage pool.</dd> +</dlentry></dl></p> +<p>The following actions can be selected for each storage pool:<ul> +<li>Select <uicontrol>Activate</uicontrol> to activate the storage +pool so that it can be used.</li> +<li>Select <uicontrol>Deactivate</uicontrol> to deactivate an active +storage pool.</li> +<li>Select <uicontrol>Undefine</uicontrol> to remove an inactive storage +pool.</li> +</ul></p> +<p>To display storage volume details for a storage pool, click the +arrow on the right side of the storage pool row. Details include +the following:<dl><dlentry> +<dt>Type</dt> +<dd>The type of volume, for example, <uicontrol>file</uicontrol>.</dd> +</dlentry><dlentry> +<dt>Format</dt> +<dd>The format, varying dependent on the type.</dd> +</dlentry><dlentry> +<dt>Capacity</dt> +<dd>Size of the storage volume.</dd> +</dlentry><dlentry> +<dt>Allocation</dt> +<dd>Amount of space that is already allocated in the storage pool.</dd> +</dlentry></dl><?Pub Caret -2?>To define a storage pool, click the <uicontrol>plus +(+)</uicontrol> icon in the upper right of the display.</p> +</csbody> +<cshelp id="kimhdefstor" xml:lang="en-us"> +<title>Define a storage pool</title> +<shortdesc> Define a storage pool.</shortdesc> +<csbody> +<p> <ol> +<li>In the <uicontrol>Storage pool name</uicontrol> field, type the +name to be used to identify the storage pool.</li> +<li>In the <uicontrol>Storage pool type</uicontrol> list, select the +type: <dl rev="rev1"><dlentry> +<dt><uicontrol>DIR</uicontrol></dt> +<dd>Specifies a directory pool. When selecting <uicontrol>DIR</uicontrol>, +type the <uicontrol>Storage path</uicontrol> (file path to the storage +pool).</dd> +</dlentry><dlentry> +<dt><uicontrol>NFS</uicontrol></dt> +<dd>Specifies a network filesystem pool. When selecting <uicontrol>NFS</uicontrol>, +type the <uicontrol>NFS server IP</uicontrol> address and <uicontrol>NFS +path</uicontrol> (path of the exported directory).</dd> +</dlentry><dlentry> +<dt><uicontrol>iSCSI</uicontrol></dt> +<dd>Specifies a pool based on a target allocated on an iSCSI server. +When selecting <uicontrol>iSCSI</uicontrol>, type the <uicontrol>iSCSI +server</uicontrol> IP address and <uicontrol>Target</uicontrol> on +the iSCSI server. You can optionally select to add iSCSI authentication.</dd> +</dlentry></dl></li>
"Logical" and "SCSI Fibre Channel" are also available to the user.
+<li>Click <uicontrol>Create</uicontrol>.</li> +</ol> </p> +</csbody> +</cshelp> +</cshelp> +<?Pub *0000003580?> diff --git a/ui/pages/help/templates.dita b/ui/pages/help/templates.dita index 0a9bcff..5048fc8 100644 --- a/ui/pages/help/templates.dita +++ b/ui/pages/help/templates.dita @@ -1,59 +1,120 @@ -<?xml version="1.0" encoding="UTF-8"?> -<?Pub Sty _display FontColor="red"?> -<?Pub Inc?> -<cshelp id="kimhtempl" xml:lang="en-us"> - <title>Templates</title> - <shortdesc>The Templates page shows the defined virtual machine templates -that can be used to create KVM virtual machines.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; -for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; -for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p>For each template, the following information is displayed:<dl><dlentry><dt>OS</dt><dd>Name of the operating system or distribution.</dd></dlentry><dlentry><dt>Version</dt><dd>Version of the operating system or distribution.</dd></dlentry><dlentry><dt>CPU</dt><dd>Number of processors defined for the template.</dd></dlentry><dlentry><dt>Memory</dt><dd>Amount of random access memory to be allocated, in MB.</dd></dlentry></dl></p> - <p>The following actions can be selected for each template:<ul><li>Select <uicontrol>Edit</uicontrol> to edit the template.</li><li>Select <uicontrol>Delete</uicontrol> to delete the template.</li></ul>To add a template, click the <uicontrol>plus (+)</uicontrol> icon -in the upper right of the display.</p> - </csbody> - <cshelp id="kimhedittempl" xml:lang="en-us"> - <title>Edit template</title> - <shortdesc>Edit an existing template.</shortdesc> - <csprolog> - <csmetadata> - <cswindowtitle>Title of window or panel associated with this help; -for review output only.</cswindowtitle> - <cswidgetlabel>Name of field or control associated with this help; -for review output only</cswidgetlabel> - </csmetadata> - </csprolog> - <csbody> - <p><ol><li>Edit the following information for the template:<dl><dlentry><dt>Name</dt><dd>Name of the template.</dd></dlentry><dlentry><dt>CPU</dt><dd>Number of processors defined for the template.</dd></dlentry><dlentry><dt>Memory</dt><dd>Memory to be allocated to the virtual machine.</dd></dlentry></dl></li><li>Click <uicontrol>Save</uicontrol>.</li></ol>The following information is displayed but cannot be edited:<dl><dlentry><dt>Vendor</dt><dd>The name of the company that created the operating system or distribution -that the template is configured to use.</dd></dlentry><dlentry><dt>Version</dt><dd>The version of the operating system or distribution that the template -is configured to use.</dd></dlentry></dl></p> - </csbody> - </cshelp> - <?Pub Caret -1?> - <cshelp id="kimhaddtempl"> - <title>Add template</title> - <shortdesc>Add a template from source media.</shortdesc> - <csbody> - <p>Select the location from the following options:<ol><li>Select the location of the source media from the following options:<dl><dlentry><dt>Local ISO image</dt><dd>Select to scan storage pools for installation ISO images available -on the system.</dd></dlentry><dlentry><dt>Remote ISO image</dt><dd>Select to specify a remote location for an installation ISO image.</dd></dlentry></dl></li><li>Click <uicontrol>Create</uicontrol>.</li></ol></p> - </csbody> - </cshelp> - <cshelp id="kimhaddloct"> - <title>Add template - local ISO image</title> - <shortdesc>Add a template from a local ISO image.</shortdesc> - <csbody> - <p>The ISO images available on the system are displayed.<dl><dlentry><dt>OS</dt><dd>Name of the operating system or distribution.</dd></dlentry><dlentry><dt>Version</dt><dd>Version of the operating system or distribution.</dd></dlentry><dlentry><dt>Size</dt><dd>Size of the ISO image.</dd></dlentry></dl></p> - <p>To create a template from an ISO image, complete the following -steps:<ol><li>Choose from the following options:<ul><li>Select an ISO image from which to create a template.</li><li>Select the <uicontrol>All</uicontrol> check box to create a template -from each listed ISO image.</li><li>Select the <uicontrol>I want to use a specific file</uicontrol> check -box to specify a path to the ISO image.</li></ul></li><li>Click <uicontrol>Create</uicontrol>.</li></ol></p> - </csbody> - </cshelp> -</cshelp> -<?Pub *0000004376?> +<?xml version="1.0" encoding="UTF-8"?> +<!--Arbortext, Inc., 1988-2011, v.4002--> +<!DOCTYPE cshelp PUBLIC "-//IBM//DTD DITA CSHelp//EN" + "..\dtd\cshelp.dtd"> +<?Pub Sty _display FontColor="red"?> +<?Pub Inc?> +<!--This DITA specialized document type is not supported by the Authoring Tools development team. +For support please see: +https://w3.opensource.ibm.com/projects/dita-cshelp/--> +<cshelp id="kimhtempl" xml:lang="en-us"> +<title>Templates</title> +<shortdesc>The <wintitle>Templates</wintitle> page shows the defined +virtual machine templates that can be used to create KVM guests.</shortdesc> +<csbody> +<p>For each template, the following information is displayed:<dl> +<dlentry> +<dt>OS</dt> +<dd>Name of the operating system or distribution.</dd> +</dlentry><dlentry> +<dt>Version</dt> +<dd>Version of the operating system or distribution.</dd> +</dlentry><dlentry> +<dt>CPUs</dt> +<dd>Number of processors that are defined for the template.</dd> +</dlentry><dlentry> +<dt>Memory</dt> +<dd>Amount of random access memory to be allocated, in MB.</dd> +</dlentry></dl></p> +<p>The following actions can be selected for each template:<ul> +<li>Select <uicontrol>Edit</uicontrol> to edit the template.</li> +<li>Select <uicontrol>Delete</uicontrol> to delete the template.</li> +</ul>To add a template, click the <uicontrol>plus (+)</uicontrol> icon +in the upper right of the display.</p> +</csbody> +<cshelp id="kimhedittempl" xml:lang="en-us"> +<title>Edit template</title> +<shortdesc>Edit an existing template.</shortdesc> +<csbody> +<p>For each template, the following information is displayed: <dl> +<dlentry> +<dt>Name</dt> +<dd>Name of the template.</dd> +</dlentry><dlentry> +<dt>Vendor</dt> +<dd>The name of the company that created the operating system or distribution +that the template is configured to use.</dd> +</dlentry><dlentry> +<dt>Version</dt> +<dd>The version of the operating system or distribution that the template +is configured to use.</dd> +</dlentry><dlentry> +<dt>CPU number</dt> +<dd>Number of processors that are defined for the template.</dd> +</dlentry><dlentry> +<dt>Memory</dt> +<dd>Amount of memory in MB to be allocated to the virtual machine.</dd> +</dlentry><dlentry> +<dt>Disk</dt> +<dd rev="rev1">Disk size in GB.</dd> +</dlentry><dlentry>
+<dt>CDROM</dt> +<dd>File path to the location of the template.</dd>
File path to the ISO file used to install the KVM guest.
+</dlentry><dlentry> +<dt>Storage pool</dt> +<dd>Specific storage pool or the default storage pool.</dd> +</dlentry><dlentry>
+<dt>Network</dt> +<dd rev="rev1">Default network.</dd>
Represent the network interfaces available to the KVM guest The user can select multiple networks
+</dlentry></dl><?Pub Caret 427?> Fields that are not disabled can +be edited. After you edit a field, click <uicontrol>Save</uicontrol>. </p> +</csbody> +</cshelp> +<cshelp id="kimhaddtempl"> +<title>Add template</title> +<shortdesc>Add a template from source media.</shortdesc> +<csbody> +<p>Select the location of the source media from the following options:<dl> +<dlentry> +<dt>Local ISO image</dt> +<dd>Select to scan storage pools for installation ISO images available +on the system.</dd> +</dlentry><dlentry> +<dt>Remote ISO image</dt> +<dd>Select to specify a remote location for an installation ISO image.</dd> +</dlentry></dl></p> +</csbody> +</cshelp> +<cshelp id="kimhaddloct"> +<title>Add template - local ISO image</title> +<shortdesc>Add a template from a local ISO image.</shortdesc> +<csbody> +<p>The ISO images available on the system are displayed.<dl><dlentry> +<dt>OS</dt> +<dd>Name of the operating system or distribution.</dd> +</dlentry><dlentry> +<dt>Version</dt> +<dd>Version of the operating system or distribution.</dd> +</dlentry><dlentry> +<dt>Size</dt> +<dd>Size of the ISO image.</dd> +</dlentry></dl></p> +<p>To create a template from an ISO image, choose from the following +options:<ul> +<li>Select an ISO image from which to create a template, then click <uicontrol>Create +Templates from Selected ISO</uicontrol>.</li> +<li>Select <uicontrol>All</uicontrol> to create a template from each + listed ISO image, then click <uicontrol>Create Templates from Selected +ISO</uicontrol>.</li> +<li rev="rev1">If the ISO image that you want to use does not appear +in the scan results, you can select from the following options:<ul> +<li>Select <uicontrol>I want to use a specific ISO file</uicontrol> to +specify a path to the ISO image.</li> +<li>Click <uicontrol>Search more ISOs</uicontrol> to search for more +ISO images.</li> +</ul></li> +</ul></p> +</csbody> +</cshelp> +</cshelp> +<?Pub *0000004366?>
participants (2)
-
Aline Manera
-
Kersten Richter