From alinefm at linux.vnet.ibm.com Tue Mar 4 14:59:56 2014 Content-Type: multipart/mixed; boundary="===============6002350270177794640==" MIME-Version: 1.0 From: Aline Manera To: kimchi-devel at ovirt.org Subject: Re: [Kimchi-devel] [PATCH] Added help for host and network tab. Edited help for guests, storage, and templates tab. Signed-off-by: Kersten Richter Date: Tue, 04 Mar 2014 16:59:46 -0300 Message-ID: <531630B2.9060205@linux.vnet.ibm.com> In-Reply-To: 1393959040-14341-1-git-send-email-kersten@us.ibm.com --===============6002350270177794640== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 @@ > - > - > - > - > - Virtual machines > - The Virtual machines page lists the defined KVM virtual > -machines. > - > - > - Title of window or panel associated with this= help; > -for review output only. > - Name of field or control associated with this= help; > -for review output only > - > - > - > -

For each virtual machine, the following information is displa= yed:

Name
Name of the virtual machine.
CPU
Percentage of processor utilization in the virtu= al machine.
Network I/O
Network input/ou= tput transmission rate in KB per seconds.
Disk I= /O
Disk input/output transmission rate in KB per seconds.
Console
Current state of guest operating system = console.

> -

The following actions icons are displayed for each virtual ma= chine:

Reload
Click to reload the displayed data. <= /dd>
Power
Click to power on the virtual mach= ine. If the icon is red, the > -power is off; if the icon is green, the power is on.
=

> -

The following actions can be selected for each virtual machin= e:

  • Select VNC to connect to the remote console > -for the virtual machine.
  • Select Delete to= delete the virtual machine.
To create a virtual machine, click th= e plus (+) icon > -in the upper right of the page.

> - > - > - Create virtual machine > - Create a virtual machine using an existing template.<= /shortdesc> > - > - > - Title of window or panel associated with = this help; > -for review output only. > - Name of field or control associated with = this help; > -for review output only > - > - > - > -

> -

    > -
  1. Type the name to be used to identify the virtual= machine.
    2. > -
  2. Click to select a template.
    3. > -
  3. Click Create.
    4. > -
> -

> - > - > - > - > - > + > + > + + "..\dtd\cshelp.dtd"> > + > + > + > + > +Guests > +The Guests page lists the defined > +KVM virtual machines. > + > +

For each guest, the following information is displayed:

> +
Name
> +
Name of the virtual machine.
> + > +
CPU
> +
Percentage of processor utilization in the virtual machine.
> + > +
Network I/O
> +
Network input/output transmission rate in KB per seconds.
> + > +
Disk I/O
> +
Disk input/output transmission rate in KB per seconds.
> + > +
Livetile
> +
State of guest operating system console, or an icon > +that represents the Linux dis= tribution > +if the guest is not active.
> +

> +

The following actions icons are displayed for each guest:

> + > +
Reset
> +
Click to reset the guest.
> + > +
Power= (Start > +or Stop)
> +
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.
> +

> +

The following actions can be selected for each guest:

    > +
  • Select VNC to connect to the remote console > +for the guest operating system.
    • > +
  • Select Edit to edit the properties of an > +existing guest. Guests can be edited only while stopped.
    • > +
  • Select Delete to delete the guest.
    • > +
To create a guest, or virtual machine, click the plus > +(+) icon in the upper right of the page.

> + > + > +Create virtual machine > +Create a virtual machine by using an existing template. > + > +

    > +
  1. Type the name to be used to identify the virtual machine.
    2. > +
  2. Select a template.
      > +
    • If templates exist, select from displayed templates.
      • > +
    • If no templates exist, click Create a template to > +create a template.
      • > +
    3. > +
  3. Click Create.
    4. > +

> + > + > + > +Edit guest > +Edit the properties of an existing virtual machi= ne. > +Guests can be edited only while stopped. > + > +Title of window or panel associated with this help; > +for review output only. > +Name of field or control associated with this help; > +for review output only > + > + > +

For each guest, the following information is displayed:

> +
Name
> +
Name of the virtual machine.
> + > +
CPUs
> +
Number of processors.
> + > +
Memory
> +
Amount of memory in MB.
> + > +
Icon
> +
Graphic image representing the Linux distribution > +to be displayed in place of current status (Livetile) when the guest > +is not active.
> +

> +

Fields that are not disabled can be edited. After you edit a field, > +click Save.

> + > + > + > + > + > 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 @@ > + > + > + + "..\dtd\cshelp.dtd"> > + > + > + > + > +Host > +The Host page shows informa= tion > +about the host system, and allows you to shut down, restart, and connect > +to the host. > + > +

You can perform the following actions on the host:

    > +
  • Select Shut down to shut down the host > +system.
    • > +
  • Select Restart to restart the host system. > +
  • Select Connect to open a VNC > +connection to the host system, if it is not already connected.
    • > +

> +

Click the following sections to display information about the host: > + > +

Basic information
> +
This section displays the host operating system distribution, > +version, and code name, as well as the processor type and amount of > +memory in GB.
> + > +
System statistics
> +
This section displays graphs to show statistics for > +CPU, memory, disk I/O, and network I/O for the host. Select C= ollecting > +data after leaving this page to continue collecting data > +when the host tab is out of view.
> + > +
Debug reports
> +
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.

The debug report > +is generated using the sosreport command. It is > +available for Red Hat Enterprise L= inux, > +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 configura= tion > +files. The command also runs external programs to collect further > +information and stores this output in the resulting archive.

> +

> + > + > + > + > 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 @@ > + > + > + + "..\dtd\cshelp.dtd"> > + > + > + > + > +Network > +The Network page displays information > +about the network connection. > + > +

> +
Network Name
> +
Name of the network, or default.
> + > +
State
> +
State of the network, active (green) or inactive (red).
> + > +
Network type
> +
Network type, for example, NAT (network > +address translation).
> + > +
Interface
> +
Network interface, for example, virbr0 (defau= lt).
> + > +
Address space
> +
IP address.
> +

> +

The following actions can be selected:

    > +
  • Select Start to begin the network > +connection.
    • > +
  • Select Stop to end the network connection. > +
  • Select Delete to delete the connection > +information.
    • > +
To create a network, click the plus (+) icon > +in the upper right of the display.

> + > + > +Create a network > +Create a network. > + > +

    > +
  1. Type the name of the network.
    2. > +
  2. Click to select the network type.
    > +
    Isolated
    > +
    Isolated mode. Guests cannot send or receive communication to > +or from external systems.
    > +     > +
    NAT
    > +
    Network Address Translation mode. Communication from guests to > +external systems uses the host IP address. External systems cannot > +initiate communication to guests.
    > +     > +
    Bridged
    > +
    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.
    > +
    3. > +
  3. Click Create.
    4. > +

> + > + > + > + > 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 @@ > - > - > - > - > - > - Storage > - The Storage page lists the available storage pools, inclu= ding the default storage pool. > - > - > - Title of window or panel associated with this= help; for review output only. > - Name of field or control associated with this= help; for review output only > - > - > - > -

For each storage pool, the following information is displayed= :

Name
Name of the storage pool and percentage used= .
State
State of the storage pool, activ= e (green) or inactive (red).
Location
F= ile path to the location of the storage pool.
Ty= pe
dir for directory.
Capacity
Amount of space in the storage pool.
Allocated
Amount of space already allocated in the stora= ge pool.

> -

The following actions can be selected for each storage pool:<= ul>

  • Select Activate to activate the storage > -pool so that it can be used.
  • Select Undefine to remove an inactive storage > -pool.

    • > -

    To display storage volume details for a storage pool, click t= he > -arrow on the right side of the storage pool row. Details include > -the following:

    Type
    The type of storage pool, fo= r example, dir or disk.
    Format
    The form= at, varying dependent on the type.
    Capacity
    =
    Size of the storage volume.
    Allocated
    Amount of space already allocated in the storage pool.    To define a storage pool, click the plus > -(+) icon in the upper right of the display.

    > - > - > - Define a storage pool > - Define a storage pool. > - > - > - Title of window or panel associated with = this help; for review output only. > - Name of field or control associated with = this help; for review output only > - > - > - > -

    > -

      > -
    1. Type the name to be used to identify the storage= pool.
      2. > -
    2. Type the file path to the storage pool.
      3. > -
    3. Click Create.
      4. > -
    > -

    > -     > -     > - > - > - > + > + > + + "..\dtd\cshelp.dtd"> > + > + > + > + > +Storage > +The Storage page lists the available > +storage pools, including the default storage pool. > + > +

    For each storage pool, the following information is displayed:

    > + > +
    Name
    > +
    Name of the storage pool and percentage used.
    > +     > +
    State
    > +
    State of the storage pool, active (green) or inactive (red).
    > +     > +
    Location
    > +
    File path to the location of the storage pool.
    > +     > +
    Type
    > +
    Type of storage pool, for example, dir.
    > +     > +
    Capacity
    > +
    Amount of space in the storage pool.
    > +     > +
    Allocated
    > +
    Amount of space that is already allocated in the storage pool.
    > +

    > +

    The following actions can be selected for each storage pool:

      > +
    • Select Activate to activate the storage > +pool so that it can be used.
      • > +
    • Select Deactivate to deactivate an active > +storage pool.
      • > +
    • Select Undefine to remove an inactive storage > +pool.
      • > +

    > +

    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:

    > +
    Type
    > +
    The type of volume, for example, file.
    > +     > +
    Format
    > +
    The format, varying dependent on the type.
    > +     > +
    Capacity
    > +
    Size of the storage volume.
    > +     > +
    Allocation
    > +
    Amount of space that is already allocated in the storage pool.
    > +
    To define a storage pool, click the plus > +(+) icon in the upper right of the display.

    > +     > + > +Define a storage pool > + Define a storage pool. > + > +

      > +
    1. In the Storage pool name field, type the > +name to be used to identify the storage pool.
      2. > +
    2. In the Storage pool type list, select the > +type:
      > +
      DIR
      > +
      Specifies a directory pool. When selecting DIR, > +type the Storage path (file path to the storage > +pool).
      > +       > +
      NFS
      > +
      Specifies a network filesystem pool. When selecting NFS, > +type the NFS server IP address and NFS > +path (path of the exported directory).
      > +       > +
      iSCSI
      > +
      Specifies a pool based on a target allocated on an iSCSI server. > +When selecting iSCSI, type the iSCSI > +server IP address and Target on > +the iSCSI server. You can optionally select to add iSCSI authentication.=
      > +
      3. "Logical" and "SCSI Fibre Channel" are also available to the user. > +
    3. Click Create.
      4. > +

    > +     > +     > +     > + > 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 @@ > - > - > - > - > - Templates > - The Templates page shows the defined virtual machine temp= lates > -that can be used to create KVM virtual machines. > - > - > - Title of window or panel associated with this= help; > -for review output only. > - Name of field or control associated with this= help; > -for review output only > - > - > - > -

    For each template, the following information is displayed:

    OS
    Name of the operating system or distribution.
    =
    Version
    Version of the operating system or d= istribution.
    CPU
    Number of processors de= fined for the template.
    Memory
    Amount of= random access memory to be allocated, in MB.

    > -

    The following actions can be selected for each template:

      <= li>Select Edit to edit the template.
    • Select = Delete to delete the template.
    To add a tem= plate, click the plus (+) icon > -in the upper right of the display.

    > -     > - > - Edit template > - Edit an existing template. > - > - > - Title of window or panel associated with = this help; > -for review output only. > - Name of field or control associated with = this help; > -for review output only > - > - > - > -

    1. Edit the following information for the template:<= dl>
      Name
      Name of the template.
      <= dt>CPU
      Number of processors defined for the template.
      Memory
      Memory to be allocated to the virtual machine.=
    2. Click Save.
    Th= e following information is displayed but cannot be edited:
    = Vendor
    The name of the company that created the operating system or= distribution > -that the template is configured to use.
    Versi= on
    The version of the operating system or distribution that the tem= plate > -is configured to use.

    > -     > -     > - > - > - Add template > - Add a template from source media. > - > -

    Select the location from the following options:

    1. Se= lect the location of the source media from the following options:
      Local ISO image
      Select to scan storage pools for installatio= n ISO images available > -on the system.
      Remote ISO image
      Selec= t to specify a remote location for an installation ISO image.
    2. Click Create.

    > -     > -     > - > - Add template - local ISO image > - Add a template from a local ISO image. > - > -

    The ISO images available on the system are displayed.

    =
    OS
    Name of the operating system or distribution.
    <= /dlentry>
    Version
    Version of the operating system or di= stribution.
    Size
    Size of the ISO image.<= /dd>

    > -

    To create a template from an ISO image, complete the foll= owing > -steps:

    1. Choose from the following options:
      • Select an ISO im= age from which to create a template.
      • Select the All check box to create a template > -from each listed ISO image.
      • Select the I want to use= a specific file check > -box to specify a path to the ISO image.
    2. Click Create.

    > -     > -     > -     > - > + > + > + + "..\dtd\cshelp.dtd"> > + > + > + > + > +Templates > +The Templates page shows the defined > +virtual machine templates that can be used to create KVM guests. > + > +

    For each template, the following information is displayed:

    > + > +
    OS
    > +
    Name of the operating system or distribution.
    > +     > +
    Version
    > +
    Version of the operating system or distribution.
    > +     > +
    CPUs
    > +
    Number of processors that are defined for the template.
    > +     > +
    Memory
    > +
    Amount of random access memory to be allocated, in MB.
    > +

    > +

    The following actions can be selected for each template:

      > +
    • Select Edit to edit the template.
      • > +
    • Select Delete to delete the template.
      • > +
    To add a template, click the plus (+) icon > +in the upper right of the display.

    > +     > + > +Edit template > +Edit an existing template. > + > +

    For each template, the following information is displayed:

    > + > +
    Name
    > +
    Name of the template.
    > +     > +
    Vendor
    > +
    The name of the company that created the operating system or distrib= ution > +that the template is configured to use.
    > +     > +
    Version
    > +
    The version of the operating system or distribution that the template > +is configured to use.
    > +     > +
    CPU number
    > +
    Number of processors that are defined for the template.
    > +     > +
    Memory
    > +
    Amount of memory in MB to be allocated to the virtual machine.
    > +     > +
    Disk
    > +
    Disk size in GB.
    > +     > +
    CDROM
    > +
    File path to the location of the template.
    File path to the ISO file used to install the KVM guest. > +     > +
    Storage pool
    > +
    Specific storage pool or the default storage pool.
    > +     > +
    Network
    > +
    Default network.
    Represent the network interfaces available to the KVM guest The user can select multiple networks > +
    Fields that are not disabled can > +be edited. After you edit a field, click Save. > +     > +     > + > +Add template > +Add a template from source media. > + > +

    Select the location of the source media from the following options: > + > +

    Local ISO image
    > +
    Select to scan storage pools for installation ISO images available > +on the system.
    > + > +
    Remote ISO image
    > +
    Select to specify a remote location for an installation ISO image. > +

    > + > + > + > +Add template - local ISO image > +Add a template from a local ISO image. > + > +

    The ISO images available on the system are displayed.

    > +
    OS
    > +
    Name of the operating system or distribution.
    > +     > +
    Version
    > +
    Version of the operating system or distribution.
    > +     > +
    Size
    > +
    Size of the ISO image.
    > +

    > +

    To create a template from an ISO image, choose from the following > +options:

      > +
    • Select an ISO image from which to create a template, then click Create > +Templates from Selected ISO.
      • > +
    • Select All to create a template from each > + listed ISO image, then click Create Templates from Selected > +ISO.
      • > +
    • If the ISO image that you want to use does not appear > +in the scan results, you can select from the following options:
        > +
      • Select I want to use a specific ISO file to > +specify a path to the ISO image.
        • > +
      • Click Search more ISOs to search for more > +ISO images.
        • > +
      • > +

    > +     > +     > + > + --===============6002350270177794640==--