-
Language:
English
-
Language:
English
Administration Guide
Administration Tasks in Red Hat Enterprise Virtualization
Abstract
Chapter 1. Introduction
1.1. Red Hat Enterprise Virtualization Architecture
- Virtual machine hosts using the Kernel-based Virtual Machine (KVM).
- Agents and tools running on hosts including VDSM, QEMU, and libvirt. These tools provide local management for virtual machines, networks and storage.
- The Red Hat Enterprise Virtualization Manager; a centralized management platform for the Red Hat Enterprise Virtualization environment. It provides a graphical interface where you can view, provision and manage resources.
- Storage domains to hold virtual resources like virtual machines, templates, ISOs.
- A database to track the state of and changes to the environment.
- Access to an external Directory Server to provide users and authentication.
- Networking to link the environment together. This includes physical network links, and logical networks.
Figure 1.1. Red Hat Enterprise Virtualization Platform Overview
1.2. Red Hat Enterprise Virtualization System Components
1.3. Red Hat Enterprise Virtualization Resources
- Data Center - A data center is the highest level container for all physical and logical resources within a managed virtual environment. It is a collection of clusters, virtual machines, storage, and networks.
- Clusters - A cluster is a set of physical hosts that are treated as a resource pool for virtual machines. Hosts in a cluster share the same network infrastructure and storage. They form a migration domain within which virtual machines can be moved from host to host.
- Logical Networks - A logical network is a logical representation of a physical network. Logical networks group network traffic and communication between the Manager, hosts, storage, and virtual machines.
- Hosts - A host is a physical server that runs one or more virtual machines. Hosts are grouped into clusters. Virtual machines can be migrated from one host to another within a cluster.
- Storage Pool - The storage pool is a logical entity that contains a standalone image repository of a certain type, either iSCSI, Fibre Channel, NFS, or POSIX. Each storage pool can contain several domains, for storing virtual machine disk images, ISO images, and for the import and export of virtual machine images.
- Virtual Machines - A virtual machine is a virtual desktop or virtual server containing an operating system and a set of applications. Multiple identical virtual machines can be created in a Pool. Virtual machines are created, managed, or deleted by power users and accessed by users.
- Template - A template is a model virtual machine with predefined settings. A virtual machine that is based on a particular template acquires the settings of the template. Using templates is the quickest way of creating a large number of virtual machines in a single step.
- Virtual Machine Pool - A virtual machine pool is a group of identical virtual machines that are available on demand by each group member. Virtual machine pools can be set up for different purposes. For example, one pool can be for the Marketing department, another for Research and Development, and so on.
- Snapshot - A snapshot is a view of a virtual machine's operating system and all its applications at a point in time. It can be used to save the settings of a virtual machine before an upgrade or installing new applications. In case of problems, a snapshot can be used to restore the virtual machine to its original state.
- User Types - Red Hat Enterprise Virtualization supports multiple levels of administrators and users with distinct levels of permissions. System administrators can manage objects of the physical infrastructure, such as data centers, hosts, and storage. Users access virtual machines available from a virtual machine pool or standalone virtual machines made accessible by an administrator.
- Events and Monitors - Alerts, warnings, and other notices about activities help the administrator to monitor the performance and status of resources.
- Reports - A range of reports either from the reports module based on JasperReports, or from the data warehouse. Preconfigured or ad hoc reports can be generated from the reports module. Users can also generate reports using any query tool that supports SQL from a data warehouse that collects monitoring data for hosts, virtual machines, and storage.
1.4. Red Hat Enterprise Virtualization API Support Statement
Supported Interfaces for Read and Write Access
- Representational State Transfer (REST) API
- The REST API exposed by the Red Hat Enterprise Virtualization Manager is a fully supported interface for interacting with Red Hat Enterprise Virtualization Manager.
- Software Development Kit (SDK)
- The SDK provided by the rhevm-sdk package is a fully supported interface for interacting with Red Hat Enterprise Virtualization Manager.
- Command Line Shell
- The command line shell provided by the rhevm-cli package is a fully supported interface for interacting with the Red Hat Enterprise Virtualization Manager.
- VDSM Hooks
- The creation and use of VDSM hooks to trigger modification of virtual machines based on custom properties specified in the Administration Portal is supported on Red Hat Enterprise Linux virtualization hosts. The use of VDSM Hooks on virtualization hosts running Red Hat Enterprise Virtualization Hypervisor is not currently supported.
Supported Interfaces for Read Access
- Red Hat Enterprise Virtualization Manager History Database
- Read access to the Red Hat Enterprise Virtualization Manager history database using the database views specified in the Administration Guide is supported. Write access is not supported.
- Libvirt on Virtualization Hosts
- Read access to
libvirt
using thevirsh -r
command is a supported method of interacting with virtualization hosts. Write access is not supported.
Unsupported Interfaces
- The vdsClient Command
- Use of the
vdsClient
command to interact with virtualization hosts is not supported unless explicitly requested by Red Hat Support. - Red Hat Enterprise Virtualization Hypervisor Console
- Console access to Red Hat Enterprise Virtualization Hypervisor outside of the provided text user interface for configuration is not supported unless explicitly requested by Red Hat Support.
- Red Hat Enterprise Virtualization Manager Database
- Direct access to and manipulation of the Red Hat Enterprise Virtualization Manager database is not supported unless explicitly requested by Red Hat Support.
Important
1.5. Administering and Maintaining the Red Hat Enterprise Virtualization Environment
- Managing physical and virtual resources such as hosts and virtual machines. This includes upgrading and adding hosts, importing domains, converting virtual machines created on foreign hypervisors, and managing virtual machine pools.
- Monitoring the overall system resources for potential problems such as extreme load on one of the hosts, insufficient memory or disk space, and taking any necessary actions (such as migrating virtual machines to other hosts to lessen the load or freeing resources by shutting down machines).
- Responding to the new requirements of virtual machines (for example, upgrading the operating system or allocating more memory).
- Managing customized object properties using tags.
- Managing searches saved as public bookmarks.
- Managing user setup and setting permission levels.
- Troubleshooting for specific users or virtual machines for overall system functionality.
- Generating general and specific reports.
Chapter 2. Using the Administration Portal
2.1. Graphical User Interface Elements
Figure 2.1. Key Graphical User Interface Elements
Key Graphical User Interface Elements
- HeaderThe header bar contains the name of the currently logged in user, the Sign Out button, the About button, the Configure button, and the Guide button. The About shows information on the version of Red Hat Enterprise Virtualization, the Configure button allows you to configure user roles, and the Guide button provides a shortcut to the book you are reading now.
- Search BarThe search bar allows you to build queries for finding resources such as hosts and clusters in the Red Hat Enterprise Virtualization environment. Queries can be as simple as a list of all the hosts in the system, or more complex, such as a list of resources that match certain conditions. As you type each part of the search query, you are offered choices to assist you in building the search. The star icon can be used to save the search as a bookmark.
- Resource TabsAll resources can be managed using their associated tab. Moreover, the Events tab allows you to view events for each resource. The Administration Portal provides the following tabs: Data Centers, Clusters, Hosts, Networks, Storage, Disks, Virtual Machines, Pools, Templates, Volumes, Users, and Events, and a Dashboard tab if you have installed the data warehouse and reports.
- Results ListYou can perform a task on an individual item, multiple items, or all the items in the results list by selecting the items and clicking the relevant action button. Information on a selected item is displayed in the details pane.
- Details PaneThe details pane shows detailed information about a selected item in the results list. If no items are selected, this pane is hidden. If multiple items are selected, the details pane displays information on the first selected item only.
- System/Bookmarks/Tags PaneThe system pane displays a navigable hierarchy of the resources in the virtualized environment. Bookmarks are used to save frequently used or complicated searches for repeated use. Bookmarks can be added, edited, or removed. Tags are applied to groups of resources and are used to search for all resources associated with that tag. The System/Bookmarks/Tags Pane can be minimized using the arrow in the upper right corner of the panel.
- Alerts/Events PaneThe Alerts tab lists all high severity events such as errors or warnings. The Events tab shows a list of events for all resources. The Tasks tab lists the currently running tasks. You can view this panel by clicking the maximize/minimize button.
- Refresh RateThe refresh rate drop-down menu allows you to set the time, in seconds, between Administration Portal refreshes. To avoid the delay between a user performing an action and the result appearing the portal, the portal will automatically refresh upon an action or event regardless of the chosen refresh interval. You can set this interval by clicking the refresh symbol in top right of the portal.
Important
Note
2.2. Tree Mode and Flat Mode
Figure 2.2. Tree Mode
Figure 2.3. Flat Mode
2.3. Using the Guide Me Facility
Figure 2.4. New Data Center Guide Me Window
2.4. Performing Searches in Red Hat Enterprise Virtualization
Note
2.5. Saving a Query String as a Bookmark
A bookmark can be used to remember a search query, and shared with other users.
Procedure 2.1. Saving a Query String as a Bookmark
- Enter the desired search query in the search bar and perform the search.
- Click the star-shaped Bookmark button to the right of the search bar to open the New Bookmark window.
Figure 2.5. Bookmark Icon
- Enter the Name of the bookmark.
- Edit the Search string field (if applicable).
- Click OK to save the query as a bookmark and close the window.
- The search query is saved and displays in the Bookmarks pane.
You have saved a search query as a bookmark for future reuse. Use the Bookmark pane to find and select the bookmark.
Part I. Administering the Resources
Chapter 3. Data Centers
3.1. Introduction to Data Centers
Figure 3.1. Data Centers
Figure 3.2. Data Center Objects
3.2. The Storage Pool Manager
3.3. SPM Priority
3.4. Using the Events Tab to Identify Problem Objects in Data Centers
3.5. Data Center Tasks
3.5.1. Creating a New Data Center
This procedure creates a data center in your virtualization environment. The data center requires a functioning cluster, host, and storage domain to operate.
Note
Procedure 3.1. Creating a New Data Center
- Select the Data Centers resource tab to list all data centers in the results list.
- Click New to open the New Data Center window.
- Enter the Name and Description of the data center.
- Select the storage Type, Compatibility Version, and Quota Mode of the data center from the drop-down menus.
- Click OK to create the data center and open the New Data Center - Guide Me window.
- The Guide Me window lists the entities that need to be configured for the data center. Configure these entities or postpone configuration by clicking the Configure Later button; configuration can be resumed by selecting the data center and clicking the Guide Me button.
The new data center is added to the virtualization environment. It will remain Uninitialized until a cluster, host, and storage domain are configured for it; use Guide Me to configure these entities.
3.5.2. Explanation of Settings in the New Data Center and Edit Data Center Windows
Table 3.1. Data Center Properties
Field
|
Description/Action
|
---|---|
Name
|
The name of the data center. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
Description
| The description of the data center. This field is recommended but not mandatory. |
Type
|
The storage type. Choose one of the following:
The type of data domain dictates the type of the data center and cannot be changed after creation without significant disruption. Multiple types of storage domains (iSCSI, NFS, FC, POSIX, and Gluster) can be added to the same data center, though local and shared domains cannot be mixed.
|
Compatibility Version
|
The version of Red Hat Enterprise Virtualization. Choose one of the following:
|
Quota Mode
| Quota is a resource limitation tool provided with Red Hat Enterprise Virtualization. Choose one of:
|
3.5.3. Editing a Resource
Edit the properties of a resource.
Procedure 3.2. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click Edit to open the Edit window.
- Change the necessary properties and click OK.
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
3.5.4. Creating a New Logical Network in a Data Center or Cluster
Create a logical network and define its use in a data center, or in clusters in a data center.
Procedure 3.3. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click New to open the New Logical Network window.From the Clusters details pane, click Add Network to open the New Logical Network window.
- Enter a Name, Description and Comment for the logical network.
- In the Export section, select the Create on external provider check box to create the logical network on an external provider. Select the external provider from the External Provider drop-down menu.
- In the Network Parameters section, select the Enable VLAN tagging, VM network and Override MTU to enable these options.
- Enter a new label or select an existing label for the logical network in the Network Label text field.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- From the Subnet tab, enter a Name, CIDR and select an IP Version for the subnet that the logical network will provide.
- From the Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
You have defined a logical network as a resource required by a cluster or clusters in the data center. If you entered a label for the logical network, it will be automatically added to all host network interfaces with that label.
Note
3.5.5. Removing a Logical Network
Remove a logical network from the Manager.
Procedure 3.4. Removing Logical Networks
- Use the Data Centers resource tab, tree mode, or the search function to find and select the data center of the logical network in the results list.
- Click the Logical Networks tab in the details pane to list the logical networks in the data center.
- Select a logical network and click Remove to open the Remove Logical Network(s) window.
- Optionally, select the Remove external network(s) from the provider(s) as well check box to remove the logical network both from the Manager and from the external provider if the network is provided by an external provider.
- Click OK.
The logical network is removed from the Manager and is no longer available. If the logical network was provided by an external provider and you elected to remove the logical network from that external provider, it is removed from the external provider and is no longer available on that external provider as well.
3.5.6. Re-Initializing a Data Center: Recovery Procedure
This recovery procedure replaces the master data domain of your data center with a new master data domain; necessary in the event of data corruption of your master data domain. Re-initializing a data center allows you to restore all other resources associated with the data center, including clusters, hosts, and non-problematic storage domains.
Procedure 3.5. Re-Initializing a Data Center
- Click the Data Centers resource tab and select the data center to re-initialize.
- Ensure that any storage domains attached to the data center are in maintenance mode.
- Right-click the data center and select Re-Initialize Data Center from the drop-down menu to open the Data Center Re-Initialize window.
- The Data Center Re-Initialize window lists all available (detached; in maintenance mode) storage domains. Click the radio button for the storage domain you are adding to the data center.
- Select the Approve operation check box.
- Click OK to close the window and re-initialize the data center.
The storage domain is attached to the data center as the master data domain and activated. You can now import any backup or exported virtual machines or templates into your new master data domain.
3.5.7. Removing a Data Center
An active host is required to remove a data center. Removing a data center will not remove the associated resources.
Procedure 3.6. Removing a Data Center
- Ensure the storage domains attached to the data center is in maintenance mode.
- Click the Data Centers resource tab and select the data center to remove.
- Click Remove to open the Remove Data Center(s) confirmation window.
- Click OK.
The data center has been removed.
3.5.8. Force Removing a Data Center
A data center becomes Non Responsive
if the attached storage domain is corrupt or if the host becomes Non Responsive
. You cannot Remove the data center under either circumstance.
Procedure 3.7. Force Removing a Data Center
- Click the Data Centers resource tab and select the data center to remove.
- Click Force Remove to open the Force Remove Data Center confirmation window.
- Select the Approve operation check box.
- Click OK
The data center and attached storage domain are permanently removed from the Red Hat Enterprise Virtualization environment.
3.5.9. Changing the Data Center Compatibility Version
Red Hat Enterprise Virtualization data centers have a compatibility version. The compatibility version indicates the version of Red Hat Enterprise Virtualization that the data center is intended to be compatible with. All clusters in the data center must support the desired compatibility level.
Note
Procedure 3.8. Changing the Data Center Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
admin
user. - Click the Data Centers tab.
- Select the data center to change from the list displayed. If the list of data centers is too long to filter visually then perform a search to locate the desired data center.
- Click the Edit button.
- Change the Compatibility Version to the desired value.
- Click OK.
You have updated the compatibility version of the data center.
Warning
3.6. Data Centers and Storage Domains
3.6.1. Attaching an Existing Data Domain to a Data Center
Data domains that are Unattached can be attached to a data center. The data domain must be of the same Storage Type as the data center.
Procedure 3.9. Attaching an Existing Data Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click Attach Data to open the Attach Storage window.
- Select the check box for the data domain to attach to the data center. You can select multiple check boxes to attach multiple data domains.
- Click OK.
The data domain is attached to the data center and is automatically activated.
Note
3.6.2. Attaching an Existing ISO domain to a Data Center
An ISO domain that is Unattached can be attached to a data center. The ISO domain must be of the same Storage Type as the data center.
Procedure 3.10. Attaching an Existing ISO Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click Attach ISO to open the Attach ISO Library window.
- Click the radio button for the appropriate ISO domain.
- Click OK.
The ISO domain is attached to the data center and is automatically activated.
3.6.3. Attaching an Existing Export Domain to a Data Center
An export domain that is Unattached can be attached to a data center.
Procedure 3.11. Attaching an Existing Export Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click Attach Export to open the Attach Export Domain window.
- Click the radio button for the appropriate Export domain.
- Click OK.
The Export domain is attached to the data center and is automatically activated.
3.6.4. Detaching a Storage Domain from a Data Center
Detaching a storage domain from a data center will stop the data center from associating with that storage domain. The storage domain is not removed from the Red Hat Enterprise Virtualization environment; it can be attached to another data center.
Note
Procedure 3.12. Detaching a Storage Domain from a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains attached to the data center.
- Select the storage domain to detach. If the storage domain is
Active
, click Maintenance to open the Maintenance Storage Domain(s) confirmation window. - Click OK to initiate maintenance mode.
- Click Detach to open the Detach Storage confirmation window.
- Click OK.
You have detached the storage domain from the data center. It can take up to several minutes for the storage domain to disappear from the details pane.
3.6.5. Activating a Storage Domain from Maintenance Mode
Storage domains in maintenance mode must be activated to be used.
Procedure 3.13. Activating a Data Domain from Maintenance Mode
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains attached to the data center.
- Select the appropriate storage domain and click Activate.
The storage domain is activated and can be used in the data center.
3.7. Data Centers and Permissions
3.7.1. Managing System Permissions for a Data Center
- Create and remove clusters associated with the data center.
- Add and remove hosts, virtual machines, and pools associated with the data center.
- Edit user permissions for virtual machines associated with the data center.
Note
3.7.2. Data Center Administrator Roles Explained
The table below describes the administrator roles and privileges applicable to data center administration.
Table 3.2. Red Hat Enterprise Virtualization System Administrator Roles
Role | Privileges | Notes |
---|---|---|
DataCenterAdmin | Data Center Administrator | Can use, create, delete, manage all physical and virtual resources within a specific data center except for storage, including clusters, hosts, templates and virtual machines. |
NetworkAdmin | Network Administrator | Can configure and manage the network of a particular data center. A network administrator of a data center inherits network permissions for virtual machines within the data center as well. |
3.7.3. Assigning an Administrator or User Role to a Resource
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 3.14. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click Add to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click Go. Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click OK to assign the role and close the window.
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
3.7.4. Removing an Administrator or User Role from a Resource
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 3.15. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click Remove. The Remove Permission window opens to confirm permissions removal.
- Click OK to remove the user role.
You have removed the user's role, and the associated permissions, from the resource.
Chapter 4. Clusters
4.1. Introduction to Clusters
Figure 4.1. Cluster
4.2. Cluster Tasks
4.2.1. Creating a New Cluster
A data center can contain multiple clusters, and a cluster can contain multiple hosts. All hosts in a cluster must be of the same CPU type (Intel or AMD). It is recommended that you create your hosts before you create your cluster to ensure CPU type optimization. However, you can configure the hosts at a later time using the Guide Me button.
Procedure 4.1. Creating a New Cluster
- Select the Clusters resource tab.
- Click New to open the New Cluster window.
- Select the Data Center the cluster will belong to from the drop-down list.
- Enter the Name and Description of the cluster.
- Select the CPU Name and Compatibility Version from the drop-down lists. It is important to match the CPU processor family with the minimum CPU processor type of the hosts you intend to attach to the cluster, otherwise the host will be non-operational.
- Select either the Enable Virt Service or Enable Gluster Service radio button to define whether the cluster will be populated with virtual machine hosts or with Gluster-enabled nodes. Note that you cannot add Red Hat Enterprise Virtualization Hypervisor hosts to a Gluster-enabled cluster.
- Click the Optimization tab to select the memory page sharing threshold for the cluster, and optionally enable CPU thread handling and memory ballooning on the hosts in the cluster.
- Click the Cluster Policy tab to optionally configure a cluster policy, scheduler optimization settings, enable trusted service for hosts in the cluster, and enable HA Reservation.
- Click the Resilience Policy tab to select the virtual machine migration policy.
- Click the Console tab to optionally override the global SPICE proxy, if any, and specify the address of a SPICE proxy for hosts in the cluster.
- Click OK to create the cluster and open the New Cluster - Guide Me window.
- The Guide Me window lists the entities that need to be configured for the cluster. Configure these entities or postpone configuration by clicking the Configure Later button; configuration can be resumed by selecting the cluster and clicking the Guide Me button.
The new cluster is added to the virtualization environment.
4.2.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows
4.2.2.1. General Cluster Settings Explained
Figure 4.2. New Cluster window
Table 4.1. General Cluster Settings
Field
|
Description/Action
|
---|---|
Data Center
|
The data center that will contain the cluster.
|
Name
|
The name of the cluster. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
Description
| The description of the cluster. This field is recommended but not mandatory. |
CPU Name
| The CPU type of the cluster. Choose one of:
|
Compatibility Version
| The version of Red Hat Enterprise Virtualization. Choose one of:
|
Enable Virt Service
| If this radio button is selected, hosts in this cluster will be used to run virtual machines. |
Enable Gluster Service
| If this radio button is selected, hosts in this cluster will be used as Red Hat Storage Server nodes, and not for running virtual machines. You cannot add a Red Hat Enterprise Virtualization Hypervisor host to a cluster with this option enabled. |
Import existing gluster configuration
|
This check box is only available if the Enable Gluster Service radio button is selected. This option allows you to import an existing Gluster-enabled cluster and all its attached hosts to Red Hat Enterprise Virtualization Manager.
The following options are required for each host in the cluster that is being imported:
|
4.2.2.2. Optimization Settings Explained
Table 4.2. Optimization Settings
Field
|
Description/Action
|
---|---|
Memory Optimization
|
|
CPU Threads
|
Selecting the Count Threads As Cores check box allows hosts to run virtual machines with a total number of processor cores greater than the number of cores in the host.
The exposed host threads would be treated as cores which can be utilized by virtual machines. For example, a 24-core system with 2 threads per core (48 threads total) can run virtual machines with up to 48 cores each, and the algorithms to calculate host CPU load would compare load against twice as many potential utilized cores.
|
Memory Balloon
|
Selecting the Enable Memory Balloon Optimization check box enables memory overcommitment on virtual machines running on the hosts in this cluster. When this option is set, the Memory Overcommit Manager (MoM) will start ballooning where and when possible, with a limitation of the guaranteed memory size of every virtual machine.
To have a balloon running, the virtual machine needs to have a balloon device with relevant drivers. Each virtual machine in cluster level 3.2 and higher includes a balloon device, unless specifically removed. Each host in this cluster receives a balloon policy update when its status changes to
Up .
It is important to understand that in some scenarios ballooning may collide with KSM. In such cases MoM will try to adjust the balloon size to minimize collisions. Additionally, in some scenarios ballooning may cause sub-optimal performance for a virtual machine. Administrators are advised to use ballooning optimization with caution.
|
KSM control
|
Selecting the Enable KSM check box enables MoM to run Kernel Same-page Merging (KSM) when necessary and when it can yield a memory saving benefit that outweighs its CPU cost.
|
4.2.2.3. Resilience Policy Settings Explained
Note
Table 4.3. Resilience Policy Settings
Field
|
Description/Action
|
---|---|
Migrate Virtual Machines
|
Migrates all virtual machines in order of their defined priority.
|
Migrate only Highly Available Virtual Machines
|
Migrates only highly available virtual machines to prevent overloading other hosts.
|
Do Not Migrate Virtual Machines
| Prevents virtual machines from being migrated. |
4.2.2.4. Cluster Policy Settings Explained
Figure 4.3. Cluster Policy Settings: Power Saving and Evenly Distributed
Figure 4.4. Cluster Policy Settings: VM Evenly Distributed
Table 4.4. Cluster Policy Tab Properties
Field/Tab
|
Description/Action
|
---|---|
None
|
Set the policy value to None to have no load or power sharing between hosts. This is the default mode.
|
Evenly_Distributed
|
Distributes the CPU processing load evenly across all hosts in the cluster. Additional virtual machines attached to a host will not start if that host has reached the defined Maximum Service Level.
|
Power_Saving
|
Distributes the CPU processing load across a subset of available hosts to reduce power consumption on underutilized hosts. Hosts with a CPU load below the low utilization value for longer than the defined time interval will migrate all virtual machines to other hosts so that it can be powered down. Additional virtual machines attached to a host will not start if that host has reached the defined high utilization value.
|
VM_Evenly_Distributed
|
Distributes virtual machines evenly between hosts based on a count of the virtual machines.
The cluster is considered unbalanced if any host is running more virtual machines than the HighVmCount and there is at least one host with a virtual machine count that falls outside of the MigrationThreshold.
|
CpuOverCommitDurationMinutes
|
Sets the time (in minutes) that a host can run a CPU load outside of the defined utilization values before the cluster policy takes action. The defined time interval protects against temporary spikes in CPU load activating cluster policies and instigating unnecessary virtual machine migration. Maximum two characters.
|
HighUtilization
|
Expressed as a percentage. If the host runs with CPU usage at or above the high utilization value for the defined time interval, the Red Hat Enterprise Virtualization Manager migrates virtual machines to other hosts in the cluster until the host's CPU load is below the maximum service threshold.
|
LowUtilization
|
Expressed as a percentage. If the host runs below the low utilization value for the defined time interval, the Red Hat Enterprise Virtualization Manager will migrate virtual machines to other hosts in the cluster. The Manager will power down the original host machine, and restart it again when load balancing requires or there are not enough free hosts in the cluster.
|
Scheduler Optimization
|
Optimize scheduling for host weighing/ordering.
|
Enable Trusted Service
|
Enable integration with an OpenAttestation server. Before this can be enabled, use the
engine-config tool to enter the OpenAttestation server's details.
|
Enable HA Reservation
|
Enable the Manager to monitor cluster capacity for highly available virtual machines. The Manager ensures that appropriate capacity exists within a cluster for virtual machines designated as highly available to migrate in the event that their existing host fails unexpectedly.
|
mom.Controllers.Balloon - INFO Ballooning guest:half1 from 1096400 to 1991580
are logged to /etc/vdsm/mom.conf
. /etc/vdsm/mom.conf
is the Memory Overcommit Manager log file.
4.2.2.5. Cluster Console Settings Explained
Table 4.5. Console settings
Field Name
|
Description
|
---|---|
Define SPICE Proxy for Cluster
|
Select this check box to enable overriding the SPICE proxy defined in global configuration. This feature is useful in a case where the user (who is, for example, connecting via the user portal) is outside of the network where the hypervisors reside.
|
Overridden SPICE proxy address
|
The proxy which will be used by the SPICE client to connect to virtual machines. The address must be in the format of a fully qualified domain name or IP address.
|
4.2.3. Editing a Resource
Edit the properties of a resource.
Procedure 4.2. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click Edit to open the Edit window.
- Change the necessary properties and click OK.
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
4.2.4. Importing an Existing Red Hat Storage Cluster
You can import a Red Hat Storage cluster and all hosts belonging to the cluster into Red Hat Enterprise Virtualization Manager.
gluster peer status
command is executed on that host through SSH, then displays a list of hosts that are a part of the cluster. You must manually verify the fingerprint of each host and provide passwords for them. You will not be able to import the cluster if one of the hosts in the cluster is down or unreachable. As the newly imported hosts do not have VDSM installed, the bootstrap script installs all the necessary VDSM packages on the hosts after they have been imported, and reboots them.
Important
Procedure 4.3. Importing an Existing Red Hat Storage Cluster to Red Hat Enterprise Virtualization Manager
- Select the Clusters resource tab to list all clusters in the results list.
- Click New to open the New Cluster window.
- Select the Data Center the cluster will belong to from the drop-down menu.
- Enter the Name and Description of the cluster.
- Select the Enable Gluster Service radio button and the Import existing gluster configuration check box.The Import existing gluster configuration field is displayed only if you select Enable Gluster Service radio button.
Figure 4.5. Import Existing Cluster Configuration
- In the Address field, enter the hostname or IP address of any server in the cluster.The host Fingerprint displays to ensure you are connecting with the correct host. If a host is unreachable or if there is a network error, an error Error in fetching fingerprint displays in the Fingerprint field.
- Enter the Root Password for the server, and click OK.
- The Add Hosts window opens, and a list of hosts that are a part of the cluster displays.
Figure 4.6. Add Hosts Window
- For each host, enter the Name and the Root Password.
- If you wish to use the same password for all hosts, select the Use a Common Password check box to enter the password in the provided text field.Click Apply to set the entered password all hosts.Make sure the fingerprints are valid and submit your changes by clicking OK.
The bootstrap script installs all the necessary VDSM packages on the hosts after they have been imported, and reboots them. You have now successfully imported an existing Red Hat Storage cluster into Red Hat Enterprise Virtualization Manager.
4.2.5. Explanation of Settings in the Add Hosts Window
Figure 4.7. Add Hosts Window
Table 4.6. Add Gluster Hosts Settings
Field | Description |
---|---|
Use a common password | Tick this check box to use the same password for all hosts belonging to the cluster. Enter the password in the Password field, then click the Apply button to set the password on all hosts. |
Name | Enter the name of the host. |
Hostname/IP | This field is automatically populated with the fully qualified domain name or IP of the host you provided in the New Cluster window. |
Root Password | Enter a password in this field to use a different root password for each host. This field overrides the common password provided for all hosts in the cluster. |
Fingerprint | The host fingerprint is displayed to ensure you are connecting with the correct host. This field is automatically populated with the fingerprint of the host you provided in the New Cluster window. |
4.2.6. Setting Load and Power Management Policies for Hosts in a Cluster
Cluster policies allow you to specify acceptable CPU usage values, both high and low, and what happens when those levels are reached. Define the cluster policy to enable automatic load balancing across the hosts in a cluster.
Procedure 4.4. Setting Load and Power Management Policies for Hosts
- Use the resource tabs, tree mode, or the search function to find and select the cluster in the results list.
- Click the Edit button to open the Edit Cluster window.
Figure 4.8. Edit Cluster Policy
- Select one of the following policies:
- None
- Evenly_Distributed - Enter CPU utilization percentage at which virtual machines start migrating to other hosts in the HighUtilization text field.
- Power Saving - Enter the CPU utilization percentage below which the host will be considered under-utilized in the LowUtilization text field. Enter the CPU utilization percentage at which virtual machines start migrating to other hosts in the HighUtilization text field
- Specify the time interval in minutes at which the selected policy will be triggered in the CpuOverCommitDurationMinutes text field.
- If you are using an OpenAttestation server to verify your hosts, and have set up the server's details using the
engine-config
tool, select the Enable Trusted Service check box. - Click OK.
You have updated the cluster policy for the cluster.
4.2.7. Creating a New Logical Network in a Data Center or Cluster
Create a logical network and define its use in a data center, or in clusters in a data center.
Procedure 4.5. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click New to open the New Logical Network window.From the Clusters details pane, click Add Network to open the New Logical Network window.
- Enter a Name, Description and Comment for the logical network.
- In the Export section, select the Create on external provider check box to create the logical network on an external provider. Select the external provider from the External Provider drop-down menu.
- In the Network Parameters section, select the Enable VLAN tagging, VM network and Override MTU to enable these options.
- Enter a new label or select an existing label for the logical network in the Network Label text field.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- From the Subnet tab, enter a Name, CIDR and select an IP Version for the subnet that the logical network will provide.
- From the Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
You have defined a logical network as a resource required by a cluster or clusters in the data center. If you entered a label for the logical network, it will be automatically added to all host network interfaces with that label.
Note
4.2.8. Removing a Cluster
Move all hosts out of a cluster before removing it.
Note
Procedure 4.6. Removing a Cluster
- Use the resource tabs, tree mode, or the search function to find and select the cluster in the results list.
- Ensure there are no hosts in the cluster.
- Click Remove to open the Remove Cluster(s) confirmation window.
- Click OK
The cluster is removed.
4.2.9. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
Specify the traffic type for the logical network to optimize the network traffic flow.
Procedure 4.7. Assigning or Unassigning a Logical Network to a Cluster
- Use the Clusters resource tab, tree mode, or the search function to find and select the cluster in the results list.
- Select the Logical Networks tab in the details pane to list the logical networks assigned to the cluster.
- Click Manage Networks to open the Manage Networks window.
Figure 4.9. Manage Networks
- Select appropriate check boxes.
- Click OK to save the changes and close the window.
You have optimized the network traffic flow by assigning a specific type of traffic to be carried on a specific logical network.
Note
4.2.10. Explanation of Settings in the Manage Networks Window
Table 4.7. Manage Networks Settings
Field
|
Description/Action
|
---|---|
Assign
|
Assigns the logical network to all hosts in the cluster.
|
Required
|
A Network marked "required" must remain operational in order for the hosts associated with it to function properly. If a required network ceases to function, any hosts associated with it become non-operational.
|
VM Network
| A logical network marked "VM Network" carries network traffic relevant to the virtual machine network. |
Display Network
| A logical network marked "Display Network" carries network traffic relevant to SPICE and to the virtual network controller. |
Migration Network
| A logical network marked "Migration Network" carries virtual machine traffic and storage migration traffic. |
4.2.11. Changing the Cluster Compatibility Version
Red Hat Enterprise Virtualization clusters have a compatibility version. The cluster compatibility version indicates the features of Red Hat Enterprise Virtualization supported by all of the hosts in the cluster. The cluster compatibility is set according to the version of the least capable host operating system in the cluster.
Note
Procedure 4.8. Changing the Cluster Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
admin
user. - Click the Clusters tab.
- Select the cluster to change from the list displayed. If the list of clusters is too long to filter visually then perform a search to locate the desired cluster.
- Click the Edit button.
- Change the Compatibility Version to the desired value.
- Click OK to open the Change Cluster Compatibility Version confirmation window.
- Click OK to confirm.
You have updated the compatibility version of the cluster. Once you have updated the compatibility version of all clusters in a data center, then you are also able to change the compatibility version of the data center itself.
Warning
4.3. Clusters and Permissions
4.3.1. Managing System Permissions for a Cluster
- Create and remove associated clusters.
- Add and remove hosts, virtual machines, and pools associated with the cluster.
- Edit user permissions for virtual machines associated with the cluster.
Note
4.3.2. Cluster Administrator Roles Explained
The table below describes the administrator roles and privileges applicable to cluster administration.
Table 4.8. Red Hat Enterprise Virtualization System Administrator Roles
Role | Privileges | Notes |
---|---|---|
ClusterAdmin | Cluster Administrator |
Can use, create, delete, manage all physical and virtual resources in a specific cluster, including hosts, templates and virtual machines. Can configure network properties within the cluster such as designating display networks, or marking a network as required or non-required.
However, a ClusterAdmin does not have permissions to attach or detach networks from a cluster, to do so NetworkAdmin permissions are required.
|
NetworkAdmin | Network Administrator | Can configure and manage the network of a particular cluster. A network administrator of a cluster inherits network permissions for virtual machines within the cluster as well. |
4.3.3. Assigning an Administrator or User Role to a Resource
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 4.9. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click Add to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click Go. Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click OK to assign the role and close the window.
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
4.3.4. Removing an Administrator or User Role from a Resource
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 4.10. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click Remove. The Remove Permission window opens to confirm permissions removal.
- Click OK to remove the user role.
You have removed the user's role, and the associated permissions, from the resource.
Chapter 5. Logical Networks
5.1. Introduction to Logical Networks
rhevm
. The rhevm
network carries all traffic, until another logical network is created. It is meant especially for management communication between the Red Hat Enterprise Virtualization Manager and hosts.
Figure 5.1. Data Center Objects
Warning
Important
- Directory Services
- DNS
- Storage
5.2. Port Mirroring
Important
5.3. Required Networks, Optional Networks, and Virtual Machine Networks
Note
5.4. VNIC Profiles and QoS
5.4.1. VNIC Profile Overview
Note
5.4.2. Creating a VNIC Profile
Create a Virtual Network Interface Controller (VNIC) profile to regulate network bandwidth for users and groups.
Procedure 5.1. Creating a VNIC Profile
- Use the Networks resource tab, tree mode, or the search function to select a logical network in the results pane.
- Select the Profiles tab in the details pane to display available VNIC profiles. If you selected the logical network in tree mode, you can select the VNIC Profiles tab in the results list.
- Click New to open the VM Interface Profile window.
Figure 5.2. The VM Interface Profile window
- Enter the Name and Description of the profile.
- Use the QoS drop-down menu to select the relevant Quality of Service policy to apply to the VNIC profile.
- Use the Port Mirroring and Allow all users to use this Profile check boxes to toggle these options.
- The custom device properties drop-down menu, which displays Please select a key... by default, is only active if custom properties have been defined on the Manager or if the logical network for which the profile is being created has been imported from an OpenStack network service. Use the drop-down menu to select the custom property, and the + and - buttons to add or remove custom properties.
- Click OK to save the profile and close the window.
You have created a VNIC profile. Apply this profile to users and groups to regulate their network bandwidth.
5.4.3. Assigning Security Groups to VNIC Profiles
Note
You can assign security groups to the VNIC profile of networks that have been imported from an OpenStack network service and that use the Linux Bridge or Open vSwitch plug-ins. A security group is a collection of strictly enforced rules that allow you to filter inbound and outbound traffic over a network interface. The following procedure outlines how to attach a security group to a VNIC profile.
Note
# neutron security-group-list
Procedure 5.2. Assigning Security Groups to VNIC Profiles
- Click the Networks tab and select a logical network in the results list.
- Click the vNIC Profiles tab in the details pane.
- Click New or select an existing VNIC profile and click Edit to open the VM Interface Profile window.
- From the custom properties drop-down menu, select SecurityGroups.
- In the text field to the right of the custom properties drop-down menu, enter the ID of the security group to attach to the VNIC profile.
- Click OK.
You have attached a security group to the VNIC profile and all traffic through the logical network to which that profile is attached will be filtered in accordance with the rules defined for that security group.
5.4.4. Explanation of Settings in the VM Interface Profile Window
Table 5.1. VM Interface Profile Window
Field Name
|
Description
|
---|---|
Network
|
A drop-down menu of the available networks to apply the VNIC profile.
|
Name
|
The name of the VNIC profile. This must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores between 1 and 50 characters.
|
Description |
The description of the VNIC profile. This field is recommended but not mandatory.
|
QoS |
A drop-down menu of the available Network Quality of Service policies to apply to the VNIC profile. QoS policies regulate inbound and outbound network traffic of the VNIC.
|
Port Mirroring |
A check box to toggle port mirroring. Port mirroring copies layer 3 network traffic on the logical network to a virtual interface on a virtual machine. It it not selected by default.
|
Device Custom Properties |
A drop-down menu to select available custom properties to apply to the VNIC profile. Use the + and - buttons to add and remove properties respectively.
|
Allow all users to use this Profile |
A check box to toggle the availability of the profile to all users in the environment. It is selected by default.
|
5.4.5. Removing a VNIC Profile
Remove a VNIC profile to delete it from your virtualized environment.
Procedure 5.3. Removing a VNIC Profile
- Use the Networks resource tab, tree mode, or the search function to select a logical network in the results pane.
- Select the Profiles tab in the details pane to display available VNIC profiles. If you selected the logical network in tree mode, you can select the vNIC Profiles tab in the results list.
- Select one or more profiles and click Remove to open the Remove VM Interface Profile(s) window.
- Click OK to remove the profile and close the window.
You have removed the VNIC profile.
5.4.6. User Permissions for VNIC Profiles
Configure user permissions to assign users to certain VNIC profiles. Assign the VnicProfileUser role to a user to enable them to use the profile. Restrict users from certain profiles by removing their permission for that profile.
Procedure 5.4. User Permissions for VNIC Profiles
- Use tree mode to select a logical network.
- Select the vNIC Profiles resource tab to display the VNIC profiles.
- Select the Permissions tab in the details pane to show the current user permissions for the profile.
- Use the Add button to open the Add Permission to User window, and the Remove button to open the Remove Permission window, to affect user permissions for the VNIC profile.
You have configured user permissions for a VNIC profile.
5.4.7. QoS Overview
Important
5.4.8. Adding QoS
Create a QoS profile to regulate network traffic when applied to a VNIC (Virtual Network Interface Controller) profile, also known as VM (Virtual Machine) Interface profile.
Procedure 5.5. Creating a QoS profile
- Use the Data Centers resource tab, tree mode, or the search function to display and select a data center in the results list.
- Select the Network QoS tab in the details pane to display the available QoS profiles.
- Click New to open the New Network QoS window.
- Enter the Name of the profile.
- Enter the limits for the Inbound and Outbound network traffic.
- Click OK to save the changes and close the window.
You have created a QoS Profile that can be used in a VNIC (Virtual Network Interface Controller) profile, also known as VM (Virtual Machine) Interface profile.
5.4.9. Settings in the New Network QoS and Edit Network QoS Windows Explained
Table 5.2. Network QoS Settings
Field Name
|
Description
|
---|---|
Data Center
|
The data center to which the Network QoS policy is to be added. This field is configured automatically according to the selected data center.
|
Name
|
A name to represent the network QoS policy within the Manager.
|
Inbound
|
The settings to be applied to inbound traffic. Select or clear the Inbound check box to enable or disable these settings.
|
Outbound
|
The settings to be applied to outbound traffic. Select or clear the Outbound check box to enable or disable these settings.
|
5.4.10. Removing QoS
Remove a QoS profile from your virtualized environment.
Procedure 5.6. Removing a QoS profile
- Use the Data Centers resource tab, tree mode, or the search function to display and select a data center in the results list.
- Select the Network QoS tab in the details pane to display the available QoS profiles.
- Select the QoS profile to remove and click Remove to open the Remove Network QoS window. This window will list what, if any, VNIC profiles are using the selected QoS profile.
- Click OK to save the changes and close the window.
You have removed the QoS profile.
5.5. Logical Network Tasks
5.5.1. Creating a New Logical Network in a Data Center or Cluster
Create a logical network and define its use in a data center, or in clusters in a data center.
Procedure 5.7. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click New to open the New Logical Network window.From the Clusters details pane, click Add Network to open the New Logical Network window.
- Enter a Name, Description and Comment for the logical network.
- In the Export section, select the Create on external provider check box to create the logical network on an external provider. Select the external provider from the External Provider drop-down menu.
- In the Network Parameters section, select the Enable VLAN tagging, VM network and Override MTU to enable these options.
- Enter a new label or select an existing label for the logical network in the Network Label text field.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- From the Subnet tab, enter a Name, CIDR and select an IP Version for the subnet that the logical network will provide.
- From the Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
You have defined a logical network as a resource required by a cluster or clusters in the data center. If you entered a label for the logical network, it will be automatically added to all host network interfaces with that label.
Note
5.5.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows
5.5.2.1. Logical Network General Settings Explained
Table 5.3. New Logical Network and Edit Logical Network Settings
Field Name
|
Description
|
---|---|
Name
|
The name of the logical network. This text field has a 15-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
Description
|
The description of the logical network. This text field has a 40-character limit.
|
Comment
|
A field for adding plain text, human-readable comments regarding the logical network.
|
Create on external provider
|
Allows you to create the logical network to an OpenStack network service that has been added to the Manager as an external provider.
External Provider - Allows you to select the external provider on which the logical network will be created.
|
Enable VLAN tagging
|
VLAN tagging is a security feature that gives all network traffic carried on the logical network a special characteristic. VLAN-tagged traffic cannot be read by interfaces that do not also have that characteristic. Use of VLANs on logical networks also allows a single network interface to be associated with multiple, differently VLAN-tagged logical networks. Enter a numeric value in the text entry field if VLAN tagging is enabled.
|
VM Network
|
Select this option if only virtual machines use this network. If the network is used for traffic that does not involve virtual machines, such as storage communications, do not select this check box.
|
Override MTU
|
Set a custom maximum transmission unit for the logical network. You can use this to match the maximum transmission unit supported by your new logical network to the maximum transmission unit supported by the hardware it interfaces with. Enter a numeric value in the text entry field if Override MTU is selected.
|
Network Label
|
Allows you to specify a new label for the network or select from a existing labels already attached to host network interfaces. If you select an existing label, the logical network will be automatically assigned to all host network interfaces with that label.
|
5.5.2.2. Logical Network Cluster Settings Explained
Table 5.4. New Logical Network and Edit Logical Network Settings
Field Name
|
Description
|
---|---|
Attach/Detach Network to/from Cluster(s)
|
Allows you to attach or detach the logical network from clusters in the data center and specify whether the logical network will be a required network for individual clusters.
Name - the name of the cluster to which the settings will apply. This value cannot be edited.
Attach All - Allows you to attach or detach the logical network to or from all clusters in the data center. Alternatively, select or clear the Attach check box next to the name of each cluster to attach or detach the logical network to or from a given cluster.
Required All - Allows you to specify whether the logical network is a required network on all clusters. Alternatively, select or clear the Required check box next to the name of each cluster to specify whether the logical network is a required network for a given cluster.
|
5.5.2.3. Logical Network vNIC Profiles Settings Explained
Table 5.5. New Logical Network and Edit Logical Network Settings
Field Name
|
Description
|
---|---|
vNIC Profiles
|
Allows you to specify one or more vNIC profiles for the logical network. You can add or remove a vNIC profile to or from the logical network by clicking the plus or minus button next to the vNIC profile. The first field is for entering a name for the vNIC profile.
Public - Allows you to specify whether the profile is available to all users.
QoS - Allows you to specify a network quality of service (QoS) profile to the vNIC profile.
|
5.5.3. Editing a Logical Network
Edit the settings of a logical network.
Procedure 5.8. Editing a Logical Network
- Use the Data Centers resource tab, tree mode, or the search function to find and select the data center of the logical network in the results list.
- Click the Logical Networks tab in the details pane to list the logical networks in the data center.
- Select a logical network and click Edit to open the Edit Logical Network window.
- Edit the necessary settings.
- Click OK to save the changes.
You have updated the settings of your logical network.
Note
5.5.4. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
Specify the traffic type for the logical network to optimize the network traffic flow.
Procedure 5.9. Assigning or Unassigning a Logical Network to a Cluster
- Use the Clusters resource tab, tree mode, or the search function to find and select the cluster in the results list.
- Select the Logical Networks tab in the details pane to list the logical networks assigned to the cluster.
- Click Manage Networks to open the Manage Networks window.
Figure 5.3. Manage Networks
- Select appropriate check boxes.
- Click OK to save the changes and close the window.
You have optimized the network traffic flow by assigning a specific type of traffic to be carried on a specific logical network.
Note
5.5.5. Explanation of Settings in the Manage Networks Window
Table 5.6. Manage Networks Settings
Field
|
Description/Action
|
---|---|
Assign
|
Assigns the logical network to all hosts in the cluster.
|
Required
|
A Network marked "required" must remain operational in order for the hosts associated with it to function properly. If a required network ceases to function, any hosts associated with it become non-operational.
|
VM Network
| A logical network marked "VM Network" carries network traffic relevant to the virtual machine network. |
Display Network
| A logical network marked "Display Network" carries network traffic relevant to SPICE and to the virtual network controller. |
Migration Network
| A logical network marked "Migration Network" carries virtual machine traffic and storage migration traffic. |
5.5.6. Adding Multiple VLANs to a Single Network Interface Using Logical Networks
Multiple VLANs can be added to a single network interface to separate traffic on the one host.
Important
Procedure 5.10. Adding Multiple VLANs to a Network Interface using Logical Networks
- Use the Hosts resource tab, tree mode, or the search function to find and select in the results list a host associated with the cluster to which your VLAN-tagged logical networks are assigned.
- Click the Network Interfaces tab in the details pane to list the physical network interfaces attached to the data center.
- Click Setup Host Networks to open the Setup Host Networks window.
- Drag your VLAN-tagged logical networks into the Assigned Logical Networks area next to the physical network interface. The physical network interface can have multiple logical networks assigned due to the VLAN tagging.
Figure 5.4. Setup Host Networks
- Edit the logical networks by hovering your cursor over an assigned logical network and clicking the pencil icon to open the Edit Network window.If your logical network definition is not synchronized with the network configuration on the host, select the Sync network check box.Select a Boot Protocol from:Click OK.
- None,
- DHCP, or
- Static,Provide the IP and Subnet Mask.
- Select the Verify connectivity between Host and Engine check box to run a network check; this will only work if the host is in maintenance mode.
- Select the Save network configuration check box
- Click OK.
You have added multiple VLAN-tagged logical networks to a single interface. This process can be repeated multiple times, selecting and editing the same network interface each time on each host to add logical networks with different VLAN tags to a single network interface.
5.5.7. Network Labels
5.5.7.1. Network Labels
Network Label Associations
- When you attach a label to a logical network, that logical network will be automatically associated with any physical host network interfaces with the given label.
- When you attached a label to a physical host network interface, any logical networks with the given label will be automatically associated with that physical host network interface.
- Changing the label attached to a logical network or physical host network interface acts in the same way as removing a label and adding a new label. The association between related logical networks or physical host network interfaces is updated.
Network Labels and Clusters
- When a labeled logical network is added to a cluster and there is a physical host network interface in that cluster with the same label, the logical network is automatically added to that physical host network interface.
- When a labeled logical network is detached from a cluster and there is a physical host network interface in that cluster with the same label, the logical network is automatically detached from that physical host network interface.
Network Labels and Logical Networks With Roles
- When a labeled logical network is assigned to act as a display network or migration network, that logical network is then configured on the physical host network interface using DHCP so that the logical network can be assigned an IP address.
5.5.7.2. Adding Network Labels to Host Network Interfaces
Using network labels allows you to greatly simplify the administrative workload associated with assigning logical networks to host network interfaces.
Procedure 5.11. Adding Network Labels to Host Network Interfaces
- Use the Hosts resource tab, tree mode, or the search function to find and select in the results list a host associated with the cluster to which your VLAN-tagged logical networks are assigned.
- Click the Network Interfaces tab in the details pane to list the physical network interfaces attached to the data center.
- Click Setup Host Networks to open the Setup Host Networks window.
- Edit a physical network interface by hovering your cursor over a physical network interface and clicking the pencil icon to open the Edit Interface window.
Figure 5.5. The Edit Interface Window
- Enter a name for the network label in the Label text field and use the + and - buttons to add or remove additional network labels.
- Click OK.
You have added a network label to a host network interface. Any newly created logical networks with the same label will be automatically assigned to all host network interfaces with that label. Also, removing a label from a logical network will automatically remove that logical network from all host network interfaces with that label.
5.5.8. Using the Networks Tab
- Attaching or detaching the networks to clusters and hosts
- Removing network interfaces from virtual machines and templates
- Adding and removing permissions for users to access and manage networks
5.6. External Provider Networks
5.6.1. Importing Networks From External Providers
If an external provider offering networking services has been registered in the Manager, the networks provided by that provider can be imported into the Manager and used by virtual machines.
Procedure 5.12. Importing a Network From an External Provider
- Click the Networks tab.
- Click the Import button to open the Import Networks window.
Figure 5.6. The Import Networks Window
- From the Network Provider drop-down list, select an external provider. The networks offered by that provider are automatically discovered and listed in the Provider Networks list.
- Using the check boxes, select the networks to import in the Provider Networks list and click the down arrow to move those networks into the Networks to Import list.
- From the Data Center drop-down list, select the data center into which the networks will be imported.
- Optionally, clear the Allow All check box for a network in the Networks to Import list to prevent that network from being available to all users.
- Click the Import button.
The selected networks are imported into the target data center and can now be used in the Manager.
Important
5.6.2. Limitations to Using External Provider Networks
- Logical networks offered by external providers must be used as virtual machine networks, and cannot be used as display networks.
- The same logical network can be imported more than once, but only to different data centers.
- You cannot edit logical networks offered by external providers in the Manager. To edit the details of a logical network offered by an external provider, you must edit the logical network directly from the OpenStack network service that provides that logical network.
- Port mirroring is not available for virtual network interface cards connected to logical networks offered by external providers.
- If a virtual machine uses a logical network offered by an external provider, that provider cannot be deleted from the Manager while the logical network is still in use by the virtual machine.
- Networks offered by external providers are non-required. As such, scheduling for clusters in which such logical networks have been imported will not take those logical networks into account during host selection. Moreover, it is the responsibility of the user to ensure the availability of the logical network on hosts in clusters in which such logical networks have been imported.
Important
Important
5.6.3. Configuring Subnets on External Provider Logical Networks
5.6.3.1. Configuring Subnets on External Provider Logical Networks
5.6.3.2. Adding Subnets to External Provider Logical Networks
Create a subnet on a logical network provided by an external provider
Procedure 5.13. Adding Subnets to External Provider Logical Networks
- Click the Networks tab.
- Click the logical network provided by an external provider to which the subnet will be added.
- Click the Subnets tab in the details pane.
- Click the New button to open the New External Subnet window.
Figure 5.7. The New External Subnet Window
- Enter a Name and CIDR for the new subnet.
- From the IP Version drop-down menu, select either IPv4 or IPv6.
- Click OK.
A new subnet is created on the logical network.
5.6.3.3. Removing Subnets from External Provider Logical Networks
Remove a subnet from a logical network provided by an external provider
Procedure 5.14. Removing Subnets from External Provider Logical Networks
- Click the Networks tab.
- Click the logical network provided by an external provider from which the subnet will be removed.
- Click the Subnets tab in the details pane.
- Click the subnet to remove.
- Click the Remove button and click OK when prompted.
The subnet is removed from the logical network.
5.7. Logical Networks and Permissions
5.7.1. Managing System Permissions for a Network
- Create, edit and remove networks.
- Edit the configuration of the network, including configuring port mirroring.
- Attach and detach networks from resources including clusters and virtual machines.
5.7.2. Network Administrator and User Roles Explained
The table below describes the administrator and user roles and privileges applicable to network administration.
Table 5.7. Red Hat Enterprise Virtualization Network Administrator and User Roles
Role | Privileges | Notes |
---|---|---|
NetworkAdmin | Network Administrator for data center, cluster, host, virtual machine, or template. The user who creates a network is automatically assigned NetworkAdmin permissions on the created network. | Can configure and manage the network of a particular data center, cluster, host, virtual machine, or template. A network administrator of a data center or cluster inherits network permissions for virtual pools within the cluster. To configure port mirroring on a virtual machine network, apply the NetworkAdmin role on the network and the UserVmManager role on the virtual machine. |
NetworkUser | Logical network and network interface user for virtual machine and template. | Can attach or detach network interfaces from specific logical networks. |
5.7.3. Assigning an Administrator or User Role to a Resource
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 5.15. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click Add to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click Go. Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click OK to assign the role and close the window.
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
5.7.4. Removing an Administrator or User Role from a Resource
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 5.16. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click Remove. The Remove Permission window opens to confirm permissions removal.
- Click OK to remove the user role.
You have removed the user's role, and the associated permissions, from the resource.
Chapter 6. Hosts
6.1. Introduction to Red Hat Enterprise Virtualization Hosts
Important
virtio serial
channel. Any Guest Agents installed on Windows guests on Red Hat Enterprise Linux hosts will lose their connection to the Manager when the Red Hat Enterprise Linux hosts are upgraded from version 5 to version 6.
- Must belong to only one cluster in the system.
- Must have CPUs that support the AMD-V or Intel VT hardware virtualization extensions.
- Must have CPUs that support all functionality exposed by the virtual CPU type selected upon cluster creation.
- Has a minimum of 2 GB RAM.
- Can have an assigned system administrator with system permissions.
6.2. Red Hat Enterprise Virtualization Hypervisor Hosts
Important
6.3. Foreman Host Provider Hosts
Important
6.4. Red Hat Enterprise Linux Hosts
6.5. Host Tasks
6.5.1. Adding a Red Hat Enterprise Linux Host
A Red Hat Enterprise Linux host is based on a standard "basic" installation of Red Hat Enterprise Linux. The physical host must be set up before you can add it to the Red Hat Enterprise Virtualization environment.
Procedure 6.1. Adding a Red Hat Enterprise Linux Host
- Click the Hosts resource tab to list the hosts in the results list.
- Click New to open the New Host window.
- Use the drop-down menus to select the Data Center and Host Cluster for the new host.
- Enter the Name, Address, and SSH Port of the new host.
- Select an authentication method to use with the host.
- Enter the root user's password to use password authentication.
- Copy the key displayed in the SSH PublicKey field to
/root/.ssh/authorized_keys
on the host to use public key authentication.
- You have now completed the mandatory steps to add a Red Hat Enterprise Linux host. Click the Advanced Parameters button to expand the advanced host settings.
- Optionally disable automatic firewall configuration.
- Optionally add a host SSH fingerprint to increase security. You can add it manually, or fetch it automatically.
- You can configure the Power Management and SPM using the applicable tabs now; however, as these are not fundamental to adding a Red Hat Enterprise Linux host, they are not covered in this procedure.
- Click OK to add the host and close the window.
The new host displays in the list of hosts with a status of Installing
. When installation is complete, the status updates to Reboot
. The host must be activated for the status to change to Up
.
Note
6.5.2. Adding a Foreman Host Provider Host
The process for adding a Foreman host provider host is almost identical to that of adding a Red Hat Enterprise Linux host except for the method by which the host is identified in the Manager. The following procedure outlines how to add a host provided by a Foreman host provider.
Procedure 6.2. Adding a Foreman Host Provider Host
- Click the Hosts resource tab to list the hosts in the results list.
- Click New to open the New Host window.
- Use the drop-down menus to select the Data Center and Host Cluster for the new host.
- Select the Use External Providers check box to display the options for adding a Foreman host provider host and select the external provider from which the host is to be added.
- Select the host to be added from the External Hosts drop-down list. Any details regarding the host that can be retrieved from the external provider are automatically set.
- Enter the Name, Address, and SSH Port of the new host.
- Select an authentication method to use with the host.
- Enter the root user's password to use password authentication.
- Copy the key displayed in the SSH PublicKey field to
/root/.ssh/authorized_hosts
on the host to use public key authentication.
- You have now completed the mandatory steps to add a Red Hat Enterprise Linux host. Click the Advanced Parameters drop-down button to show the advanced host settings.
- Optionally disable automatic firewall configuration.
- Optionally add a host SSH fingerprint to increase security. You can add it manually, or fetch it automatically.
- You can configure the Power Management and SPM using the applicable tabs now; however, as these are not fundamental to adding a Red Hat Enterprise Linux host, they are not covered in this procedure.
- Click OK to add the host and close the window.
The new host displays in the list of hosts with a status of Installing
. Once installation is complete, the status will update to Reboot
. The host must be activated for the status to change to Up
.
Note
6.5.3. Approving a Hypervisor
It is not possible to run virtual machines on a Hypervisor until the addition of it to the environment has been approved in Red Hat Enterprise Virtualization Manager.
Procedure 6.3. Approving a Hypervisor
- Log in to the Red Hat Enterprise Virtualization Manager Administration Portal.
- From the Hosts tab, click on the host to be approved. The host should currently be listed with the status of Pending Approval.
- Click the Approve button. The Edit and Approve Hosts dialog displays. You can use the dialog to set a name for the host, fetch its SSH fingerprint before approving it, and configure power management, where the host has a supported power management card. For information on power management configuration, refer to Section 6.5.4.2, “Host Power Management Settings Explained”.
- Click OK. If you have not configured power management you will be prompted to confirm that you wish to proceed without doing so, click OK.
The status in the Hosts tab changes to Installing, after a brief delay the host status changes to Up.
6.5.4. Explanation of Settings and Controls in the New Host and Edit Host Windows
6.5.4.1. Host General Settings Explained
Table 6.1. General settings
Field Name
|
Description
|
---|---|
Data Center
|
The data center to which the host belongs. Red Hat Enterprise Virtualization Hypervisor hosts cannot be added to Gluster-enabled clusters.
|
Host Cluster
|
The cluster to which the host belongs.
|
Use External Providers
|
Select or clear this check box to view or hide options for adding hosts provided by external providers. Upon selection, a drop-down list of external providers that have been added to the Manager displays. The following options are also available:
|
Name
|
The name of the cluster. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
Comment
|
A field for adding plain text, human-readable comments regarding the host.
|
Address
|
The IP address, or resolvable hostname of the host.
|
Password
|
The password of the host's root user. This can only be given when you add the host; it cannot be edited afterwards.
|
SSH PublicKey
|
Copy the contents in the text box to the
/root/.known_hosts file on the host to use the Manager's ssh key instead of using a password to authenticate with the host.
|
Automatically configure host firewall
|
When adding a new host, the Manager can open the required ports on the host's firewall. This is enabled by default. This is an Advanced Parameter.
|
SSH Fingerprint
|
You can fetch the host's SSH fingerprint, and compare it with the fingerprint you expect the host to return, ensuring that they match. This is an Advanced Parameter.
|
6.5.4.2. Host Power Management Settings Explained
Table 6.2. Power Management Settings
Field Name
|
Description
|
---|---|
Primary/ Secondary
|
Prior to Red Hat Enterprise Virtualization 3.2, a host with power management configured only recognized one fencing agent. Fencing agents configured on version 3.1 and earlier, and single agents, are treated as primary agents. The secondary option is valid when a second agent is defined.
|
Concurrent
|
Valid when there are two fencing agents, for example for dual power hosts in which each power switch has two agents connected to the same power switch.
|
Address
|
The address to access your host's power management device. Either a resolvable hostname or an IP address.
|
User Name
|
User account with which to access the power management device. You can set up a user on the device, or use the default user.
|
Password
|
Password for the user accessing the power management device.
|
Type
|
The type of power management device in your host.
Choose one of the following:
|
Port
|
The port number used by the power management device to communicate with the host.
|
Options
|
Power management device specific options. Enter these as 'key=value' or 'key'. See the documentation of your host's power management device for the options available.
|
Secure
|
Tick this check box to allow the power management device to connect securely to the host. This can be done via ssh, ssl, or other authentication protocols depending on and supported by the power management agent.
|
Source
|
Specifies whether the host will search within its cluster or data center for a fencing proxy. Use the Up and Down buttons to change the sequence in which the resources are used.
|
Disable policy control of power management
|
Power management is controlled by the Cluster Policy of the host's cluster. If power management is enabled and the defined low utilization value is reached, the Manager will power down the host machine, and restart it again when load balancing requires or there are not enough free hosts in the cluster. Tick this check box to disable policy control.
|
6.5.4.3. SPM Priority Settings Explained
Table 6.3. SPM settings
Field Name
|
Description
|
---|---|
SPM Priority
|
Defines the likelihood that the host will be given the role of Storage Pool Manager(SPM). The options are Low, Normal, and High priority. Low priority means that there is a reduced likelihood of the host being assigned the role of SPM, and High priority means there is an increased likelihood. The default setting is Normal.
|
6.5.4.4. Host Console Settings Explained
Table 6.4. Console settings
Field Name
|
Description
|
---|---|
Override display address
|
Select this check box to override the display addresses of the host. This feature is useful in a case where the hosts are defined by internal IP and are behind a NAT firewall. When a user connects to a virtual machine from outside of the internal network, instead of returning the private address of the host on which the virtual machine is running, the machine returns a public IP or FQDN (which is resolved in the external network to the public IP).
|
Display address
|
The display address specified here will be used for all virtual machines running on this host. The address must be in the format of a fully qualified domain name or IP.
|
6.5.5. Configuring Host Power Management Settings
Configure your host power management device settings to perform host life-cycle operations (stop, start, restart) from the Administration Portal.
Important
maintenance mode
before configuring power management settings. Otherwise, all running virtual machines on that host will be stopped ungracefully upon restarting the host, which can cause disruptions in production environments. A warning dialog will appear if you have not correctly set your host to maintenance mode.
Procedure 6.4. Configuring Power Management Settings
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click Edit to open the Edit Host window.
- Click the Power Management tab to display the Power Management settings.
- Select the Enable Power Management check box to enable the fields.
- The Primary option is selected by default if you are configuring a new power management device. If you are adding a new device, set it to Secondary.
- Select the Concurrent check box to enable multiple fence agents to be used concurrently.
- Enter the Address, User Name, and Password of the power management device into the appropriate fields.
- Use the drop-down menu to select the Type of power management device.
- Enter the Port number used by the power management device to communicate with the host.
- Enter the Options for the power management device. Use a comma-separated list of 'key=value' or 'key'.
- Select the Secure check box to enable the power management device to connect securely to the host.
- Click Test to ensure the settings are correct.
- Click OK to save your settings and close the window.
You have configured the power management settings for the host. The Power Management drop-down menu is now enabled in the Administration Portal.
Note
6.5.6. Configuring Host Storage Pool Manager Settings
The Storage Pool Manager (SPM) is a management role given to one of the hosts in a data center to maintain access control over the storage domains. The SPM must always be available, and the SPM role will be assigned to another host if the SPM host becomes unavailable. As the SPM role uses some of the host's available resources, it is important to prioritize hosts that can afford the resources.
Procedure 6.5. Configuring SPM settings
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click Edit to open the Edit Host window.
- Click the SPM tab to display the SPM Priority settings.
- Use the radio buttons to select the appropriate SPM priority for the host.
- Click OK to save the settings and close the window.
You have configured the SPM priority of the host.
6.5.7. Editing a Resource
Edit the properties of a resource.
Procedure 6.6. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click Edit to open the Edit window.
- Change the necessary properties and click OK.
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
6.5.8. Approving Newly Added Red Hat Enterprise Virtualization Hypervisor Hosts
You have to install your Red Hat Enterprise Virtualization Hypervisor hosts before you can approve them in the Red Hat Enterprise Virtualization Manager. Read about installing Red Hat Enterprise Virtualization Hypervisors in the Red Hat Enterprise Virtualization Installation Guide.
Procedure 6.7. Approving newly added Red Hat Enterprise Virtualization Hypervisor hosts
- In the Hosts tab, select the host you recently installed using the Red Hat Enterprise Virtualization Hypervisor host installation media. This host shows a status of
Pending Approval
. - Click the Approve button.
The host's status changes to Up
and it can be used to run virtual machines.
Note
6.5.9. Moving a Host to Maintenance Mode
Many common maintenance tasks, including network configuration and deployment of software updates, require that hosts be placed into maintenance mode. When a host is placed into maintenance mode the Red Hat Enterprise Virtualization Manager attempts to migrate all running virtual machines to alternative hosts.
Procedure 6.8. Moving a Host to Maintenance Mode
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click Maintenance to open the Maintenance Host(s) confirmation window.
- Click OK to initiate maintenance mode.
All running virtual machines are migrated to alternative hosts. The Status field of the host changes to Preparing for Maintenance
, and finally Maintenance
when the operation completes successfully.
6.5.10. Activating a Host from Maintenance Mode
A host that has been placed into maintenance mode, or recently added to the environment, must be activated before it can be used.
Procedure 6.9. Activating a Host from Maintenance Mode
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click Activate.
The host status changes to Unassigned
, and finally Up
when the operation is complete. Virtual machines can now run on the host.
6.5.11. Removing a Host
Remove a host from your virtualized environment.
Procedure 6.10. Removing a host
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Place the host into maintenance mode.
- Click Remove to open the Remove Host(s) confirmation window.
- Select the Force Remove check box if the host is part of a Red Hat Storage cluster and has volume bricks on it, or if the host is non-responsive.
- Click OK.
Your host has been removed from the environment and is no longer visible in the Hosts tab.
6.5.12. Customizing Hosts with Tags
You can use tags to store information about your hosts. You can then search for hosts based on tags.
Procedure 6.11. Customizing hosts with tags
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click Assign Tags to open the Assign Tags window.
Figure 6.1. Assign Tags Window
- The Assign Tags window lists all available tags. Select the check boxes of applicable tags.
- Click OK to assign the tags and close the window.
You have added extra, searchable information about your host as tags.
6.6. Hosts and Networking
6.6.1. Refreshing Host Capabilities
When a network interface card is added to a host, the capabilities of the host must be refreshed to display that network interface card in the Manager.
Procedure 6.12. To Refresh Host Capabilities
- Use the resource tabs, tree mode, or the search function to find and select a host in the results list.
- Click the Refresh Capabilities button.
The list of network interface cards in the Network Interfaces tab of the details pane for the selected host is updated. Any new network interface cards can now be used in the Manager.
6.6.2. Editing Host Network Interfaces and Assigning Logical Networks to Hosts
You can change the settings of physical host network interfaces, move the management network from one physical host network interface to another, and assign logical networks to physical host network interfaces.
Important
Procedure 6.13. Editing Host Network Interfaces and Assigning Logical Networks to Hosts
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results.
- Click the Network Interfaces tab in the details pane.
- Click the Setup Host Networks button to open the Setup Host Networks window.
Figure 6.2. The Setup Host Networks window
- Attach a logical network to a physical host network interface by selecting and dragging the logical network into the Assigned Logical Networks area next to the physical host network interface.Alternatively, right-click the logical network and select a network interface from the drop-down menu.
- Configure the logical network:
- Hover your cursor over an assigned logical network and click the pencil icon to open the Edit Management Network window.
- Select a Boot Protocol from:
- None,
- DHCP, or
- Static.If you selected Static, enter the IP, Subnet Mask, and the Gateway.
- Click OK.
- If your logical network definition is not synchronized with the network configuration on the host, select the Sync network check box.
- Select the Verify connectivity between Host and Engine check box to check network connectivity; this action will only work if the host is in maintenance mode.
- Select the Save network configuration check box to make the changes persistent when the environment is rebooted.
- Click OK.
You have assigned logical networks to and configured a physical host network interface.
Note
6.6.3. Bonds
6.6.3.1. Bonding Logic in Red Hat Enterprise Virtualization
- Are either of the devices already carrying logical networks?
- Are the devices carrying compatible logical networks? A single device cannot carry both VLAN tagged and non-VLAN tagged logical networks.
Table 6.5. Bonding Scenarios and Their Results
Bonding Scenario | Result |
---|---|
NIC + NIC
|
The Create New Bond window is displayed, and you can configure a new bond device.
If the network interfaces carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
NIC + Bond
|
The NIC is added to the bond device. Logical networks carried by the NIC and the bond are all added to the resultant bond device if they are compatible.
If the bond devices carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
Bond + Bond
|
If the bond devices are not attached to logical networks, or are attached to compatible logical networks, a new bond device is created. It contains all of the network interfaces, and carries all logical networks, of the component bond devices. The Create New Bond window is displayed, allowing you to configure your new bond.
If the bond devices carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
6.6.3.2. Bonding Modes
- Mode 1 (active-backup policy) sets all interfaces to the backup state while one remains active. Upon failure on the active interface, a backup interface replaces it as the only active interface in the bond. The MAC address of the bond in mode 1 is visible on only one port (the network adapter), to prevent confusion for the switch. Mode 1 provides fault tolerance and is supported in Red Hat Enterprise Virtualization.
- Mode 2 (XOR policy) selects an interface to transmit packages to based on the result of an XOR operation on the source and destination MAC addresses modulo NIC slave count. This calculation ensures that the same interface is selected for each destination MAC address used. Mode 2 provides fault tolerance and load balancing and is supported in Red Hat Enterprise Virtualization.
- Mode 4 (IEEE 802.3ad policy) creates aggregation groups for which included interfaces share the speed and duplex settings. Mode 4 uses all interfaces in the active aggregation group in accordance with the IEEE 802.3ad specification and is supported in Red Hat Enterprise Virtualization.
- Mode 5 (adaptive transmit load balancing policy) ensures the outgoing traffic distribution is according to the load on each interface and that the current interface receives all incoming traffic. If the interface assigned to receive traffic fails, another interface is assigned the receiving role instead. Mode 5 is supported in Red Hat Enterprise Virtualization.
6.6.3.3. Creating a Bond Device Using the Administration Portal
You can bond compatible network devices together. This type of configuration can increase available bandwidth and reliability. You can bond multiple network interfaces, pre-existing bond devices, and combinations of the two.
Procedure 6.14. Creating a Bond Device using the Administration Portal
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the Network Interfaces tab in the details pane to list the physical network interfaces attached to the host.
- Click Setup Host Networks to open the Setup Host Networks window.
- Select and drag one of the devices over the top of another device and drop it to open the Create New Bond window. Alternatively, right-click the device and select another device from the drop-down menu.If the devices are incompatible, for example one is vlan tagged and the other is not, the bond operation fails with a suggestion on how to correct the compatibility issue.
Figure 6.3. Bond Devices Window
- Select the Bond Name and Bonding Mode from the drop-down menus.Bonding modes 1, 2, 4, and 5 can be selected. Any other mode can be configured using the Custom option.
- Click OK to create the bond and close the Create New Bond window.
- Assign a logical network to the newly created bond device.
- Optionally choose to Verify connectivity between Host and Engine and Save network configuration.
- Click OK accept the changes and close the Setup Host Networks window.
Your network devices are linked into a bond device and can be edited as a single interface. The bond device is listed in the Network Interfaces tab of the details pane for the selected host.
6.6.3.4. Example Uses of Custom Bonding Options with Host Interfaces
Example 6.1. xmit_hash_policy
mode=4 xmit_hash_policy=layer2+3
Example 6.2. ARP Monitoring
arp_interval
on the bond device of the host by selecting a Custom bonding mode, and entering the following into the text field:
mode=1 arp_interval=1 arp_ip_target=192.168.0.2
Example 6.3. Primary
mode=1 primary=eth0
6.6.4. Saving a Host Network Configuration
One of the options when configuring a host network is to save the configuration as you apply it, making the changes persistent.
Procedure 6.15. Saving a host network configuration
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the Network Interfaces tab on the Details pane to list the NICs on the host, their address, and other specifications.
- Click the Save Network Configuration button.
- The host network configuration is saved and the following message is displayed on the task bar: "Network changes were saved on host [Hostname]."
The host's network configuration is saved persistently and will survive reboots.
Note
6.7. Host Resilience
6.7.1. Host High Availability
6.7.2. Power Management by Proxy in Red Hat Enterprise Virtualization
- Any host in the same cluster as the host requiring fencing.
- Any host in the same data center as the host requiring fencing.
6.7.3. Setting Fencing Parameters on a Host
Procedure 6.16. Setting fencing parameters on a host
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click Edit to open the Edit Host window.
- Click the Power Management tab.
Figure 6.4. Power Management Settings
- Select the Enable Power Management check box to enable the fields.
- The Primary option is selected by default if you are configuring a new power management device. If you are adding a new device, set it to Secondary.
- Select the Concurrent check box to enable multiple fence agents to be used concurrently.
- Enter the Address, User Name, and Password of the power management device.
- Select the power management device Type from the drop-down menu.
- Enter the Port number used by the power management device to communicate with the host.
- Enter the specific Options of the power management device. Use a comma-separated list of 'key=value' or 'key' entries.
- Click the Test button to test the power management device. Test Succeeded, Host Status is: on will display upon successful verification.
Warning
Power management parameters (userid, password, options, etc) are tested by Red Hat Enterprise Virtualization Manager only during setup and manually after that. If you choose to ignore alerts about incorrect parameters, or if the parameters are changed on the power management hardware without the corresponding change in Red Hat Enterprise Virtualization Manager, fencing is likely to fail when most needed. - Click OK to save the changes and close the window.
You are returned to the list of hosts. Note that the exclamation mark next to the host's name has now disappeared, signifying that power management has been successfully configured.
6.7.4. Soft-Fencing Hosts
- On the first network failure, the status of the host changes to "connecting".
- The Manager then makes three attempts to ask VDSM for its status, or it waits for an interval determined by the load on the host. The formula for determining the length of the interval is configured by the configuration values TimeoutToResetVdsInSeconds (the default is 60 seconds) + [DelayResetPerVmInSeconds (the default is 0.5 seconds)]*(the count of running vms on host) + [DelayResetForSpmInSeconds (the default is 20 seconds)] * 1 (if host runs as SPM) or 0 (if the host does not run as SPM). To give VDSM the maximum amount of time to respond, the Manager chooses the longer of the two options mentioned above (three attempts to retrieve the status of VDSM or the interval determined by the above formula).
- If the host does not respond when that interval has elapsed,
vdsm restart
is executed via SSH. - If
vdsm restart
does not succeed in re-establishing the connection between the host and the Manager, the status of the host changes toNon Responsive
and, if power management is configured, fencing is handed off to the external fencing agent.
Note
6.7.5. Using Host Power Management Functions
When power management has been configured for a host, you can access a number of options from the Administration Portal interface. While each power management device has its own customizable options, they all support the basic options to start, stop, and restart a host.
Procedure 6.17. Using Host Power Management Functions
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the Power Management drop-down menu.
Figure 6.5. Restart
- Select one of the following options:
- Restart: This option stops the host and waits until the host's status changes to
Down
. When the agent has verified that the host is down, the highly available virtual machines are restarted on another host in the cluster. The agent then restarts this host. When the host is ready for use its status displays asUp
. - Start: This option starts the host and lets it join a cluster. When it is ready for use its status displays as
Up
. - Stop: This option powers off the host. Before using this option, ensure that the virtual machines running on the host have been migrated to other hosts in the cluster. Otherwise the virtual machines will crash and only the highly available virtual machines will be restarted on another host. When the host has been stopped its status displays as
Non-Operational
.
Important
When two fencing agents are defined on a host, they can be used concurrently or sequentially. For concurrent agents, both agents have to respond to the Stop command for the host to be stopped; and when one agent responds to the Start command, the host will go up. For sequential agents, to start or stop a host, the primary agent is used first; if it fails, the secondary agent is used. - Selecting one of the above options opens a confirmation window. Click OK to confirm and proceed.
The selected action is performed.
6.7.6. Manually Fencing or Isolating a Non Responsive Host
If a host unpredictably goes into a non-responsive state, for example, due to a hardware failure; it can significantly affect the performance of the environment. If you do not have a power management device, or it is incorrectly configured, you can reboot the host manually.
Warning
Procedure 6.18. Manually fencing or isolating a non-responsive host
- On the Hosts tab, select the host. The status must display as
non-responsive
. - Manually reboot the host. This could mean physically entering the lab and rebooting the host.
- On the Administration Portal, right-click the host entry and select the Confirm Host has been rebooted button.
Figure 6.6. The Host Right-click menu
- A message displays prompting you to ensure that the host has been shut down or rebooted. Select the Approve Operation check box and click OK.
You have manually rebooted your host, allowing highly available virtual machines to be started on active hosts. You confirmed your manual fencing action in the Administrator Portal, and the host is back online.
6.8. Hosts and Permissions
6.8.1. Managing System Permissions for a Host
- Edit the configuration of the host.
- Set up the logical networks.
- Remove the host.
6.8.2. Host Administrator Roles Explained
The table below describes the administrator roles and privileges applicable to host administration.
Table 6.6. Red Hat Enterprise Virtualization System Administrator Roles
Role | Privileges | Notes |
---|---|---|
HostAdmin | Host Administrator | Can configure, manage, and remove a specific host. Can also perform network-related operations on a specific host. |
6.8.3. Assigning an Administrator or User Role to a Resource
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 6.19. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click Add to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click Go. Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click OK to assign the role and close the window.
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
6.8.4. Removing an Administrator or User Role from a Resource
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 6.20. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click Remove. The Remove Permission window opens to confirm permissions removal.
- Click OK to remove the user role.
You have removed the user's role, and the associated permissions, from the resource.
Chapter 7. Storage
- Network File System (NFS)
- GlusterFS exports
- Other POSIX compliant file systems
- Internet Small Computer System Interface (iSCSI)
- Local storage attached directly to the virtualization hosts
- Fibre Channel Protocol (FCP)
- Parallel NFS (pNFS)
- Data Domain: A data domain holds the virtual hard disks and OVF files of all the virtual machines and templates in a data center. In addition, snapshots of the virtual machines are also stored in the data domain.The data domain cannot be shared across data centers. Storage domains of multiple types (iSCSI, NFS, FC, POSIX, and Gluster) can be added to the same data center, provided they are all shared, rather than local, domains.You must attach a data domain to a data center before you can attach domains of other types to it.
- ISO Domain: ISO domains store ISO files (or logical CDs) used to install and boot operating systems and applications for the virtual machines. An ISO domain removes the data center's need for physical media. An ISO domain can be shared across different data centers.
- Export Domain: Export domains are temporary storage repositories that are used to copy and move images between data centers and Red Hat Enterprise Virtualization environments. Export domains can be used to backup virtual machines. An export domain can be moved between data centers, however, it can only be active in one data center at a time.
Important
Support for export storage domains backed by storage on anything other than NFS is being deprecated. While existing export storage domains imported from Red Hat Enterprise Virtualization 2.2 environments remain supported new export storage domains must be created on NFS storage.
Important
7.1. Understanding Storage Domains
7.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
- V1 metadata (Red Hat Enterprise Virtualization 2.x series)Each storage domain contains metadata describing its own structure, and all of the names of physical volumes that are used to back virtual machine disk images.Master domains additionally contain metadata for all the domains and physical volume names in the storage pool. The total size of this metadata is limited to 2 kb, limiting the number of storage domains that can be in a pool.Template and virtual machine base images are read only.V1 metadata is applicable to NFS, iSCSI, and FC storage domains.
- V2 metadata (Red Hat Enterprise Virtualization 3.0)All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains.Physical volume names are no longer included in the metadata.Template and virtual machine base images are read only.V2 metadata is applicable to iSCSI, and FC storage domains.
- V3 metadata (Red Hat Enterprise Virtualization 3.1+)All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains.Virtual machine and template base images are no longer read only. This change enables live snapshots, live storage migration, and clone from snapshot.Support for unicode metadata is added, for non-English volume names.V3 metadata is applicable to NFS, GlusterFS, POSIX, iSCSI, and FC storage domains.
7.3. Preparing and Adding File-Based Storage
7.3.1. Preparing NFS Storage
These steps must be taken to prepare an NFS file share on a server running Red Hat Enterprise Linux 6 for use with Red Hat Enterprise Virtualization.
Procedure 7.1. Preparing NFS Storage
Install nfs-utils
NFS functionality is provided by the nfs-utils package. Before file shares can be created, check that the package is installed by querying the RPM database for the system:$
rpm -qi nfs-utils
If the nfs-utils package is installed then the package information will be displayed. If no output is displayed then the package is not currently installed. Install it usingyum
while logged in as theroot
user:#
yum install nfs-utils
Configure Boot Scripts
To ensure that NFS shares are always available when the system is operational both thenfs
andrpcbind
services must start at boot time. Use thechkconfig
command while logged in asroot
to modify the boot scripts.#
chkconfig --add rpcbind
#chkconfig --add nfs
#chkconfig rpcbind on
#chkconfig nfs on
Once the boot script configuration has been done, start the services for the first time.#
service rpcbind start
#service nfs start
Create Directory
Create the directory you wish to share using NFS.#
mkdir /exports/iso
Replace /exports/iso with the name, and path of the directory you wish to use.Export Directory
To be accessible over the network using NFS the directory must be exported. NFS exports are controlled using the/etc/exports
configuration file. Each export path appears on a separate line followed by a tab character and any additional NFS options. Exports to be attached to the Red Hat Enterprise Virtualization Manager must have the read, and write, options set.To grant read, and write access to/exports/iso
using NFS for example you add the following line to the/etc/exports
file./exports/iso *(rw)
Again, replace /exports/iso with the name, and path of the directory you wish to use.Reload NFS Configuration
For the changes to the/etc/exports
file to take effect the service must be told to reload the configuration. To force the service to reload the configuration run the following command asroot
:#
service nfs reload
Set Permissions
The NFS export directory must be configured for read write access and must be owned by vdsm:kvm. If these users do not exist on your external NFS server use the following command, assuming that/exports/iso
is the directory to be used as an NFS share.#
chown -R 36:36 /exports/iso
The permissions on the directory must be set to allow read and write access to both the owner and the group. The owner should also have execute access to the directory. The permissions are set using thechmod
command. The following command arguments set the required permissions on the/exports/iso
directory.#
chmod 0755 /exports/iso
The NFS file share has been created, and is ready to be attached by the Red Hat Enterprise Virtualization Manager.
7.3.2. Attaching NFS Storage
An NFS type Storage Domain is a mounted NFS share that is attached to a data center. It is used to provide storage for virtualized guest images and ISO boot media. Once NFS storage has been exported it must be attached to the Red Hat Enterprise Virtualization Manager using the Administration Portal.
Procedure 7.2. Attaching NFS Storage
- Click the Storage resource tab to list the existing storage domains.
- Click New Domain to open the New Domain window.
Figure 7.1. NFS Storage
- Enter the Name of the storage domain.
- Select the Data Center, Domain Function / Storage Type, and Use Host from the drop-down menus.If applicable, select the Format from the drop-down menu.
- Enter the Export Path to be used for the storage domain.The export path should be in the format of
192.168.0.10:/data or domain.example.com:/data
- Click Advanced Parameters to enable further configurable settings. It is recommended that the values of these parameters not be modified.
Important
All communication to the storage domain is from the selected host and not directly from the Red Hat Enterprise Virtualization Manager. At least one active host must be attached to the chosen Data Center before the storage is configured. - Click OK to create the storage domain and close the window.
The new NFS data domain is displayed on the Storage tab with a status of Locked
while the disk prepares. It is automatically attached to the data center upon completion.
7.3.3. Preparing Local Storage
A local storage domain can be set up on a host. When you set up host to use local storage, the host automatically gets added to a new data center and cluster that no other hosts can be added to. Multiple host clusters require that all hosts have access to all storage domains, which is not possible with local storage. Virtual machines created in a single host cluster cannot be migrated, fenced or scheduled.
Important
/data/images
. This directory already exists with the correct permissions on Hypervisor installations. The steps in this procedure are only required when preparing local storage on Red Hat Enterprise Linux virtualization hosts.
Procedure 7.3. Preparing Local Storage
- On the virtualization host, create the directory to be used for the local storage.
# mkdir -p /data/images
- Ensure that the directory has permissions allowing read/write access to the
vdsm
user (UID 36) andkvm
group (GID 36).# chown 36:36 /data /data/images
# chmod 0755 /data /data/images
Your local storage is ready to be added to the Red Hat Enterprise Virtualization environment.
7.3.4. Adding Local Storage
Storage local to your host has been prepared. Now use the Manager to add it to the host.
Procedure 7.4. Adding Local Storage
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click Maintenance to open the Maintenance Host(s) confirmation window.
- Click OK to initiate maintenance mode.
- Click Configure Local Storage to open the Configure Local Storage window.
Figure 7.2. Configure Local Storage Window
- Click the Edit buttons next to the Data Center, Cluster, and Storage fields to configure and name the local storage domain.
- Set the path to your local storage in the text entry field.
- If applicable, select the Memory Optimization tab to configure the memory optimization policy for the new local storage cluster.
- Click OK to save the settings and close the window.
Your host comes online in a data center of its own.
7.4. Adding POSIX Compliant File System Storage
Important
7.4.1. Attaching POSIX Compliant File System Storage
You want to use a POSIX compliant file system that is not exposed using NFS, iSCSI, or FCP as a storage domain.
Procedure 7.5. Attaching POSIX Compliant File System Storage
- Click the Storage resource tab to list the existing storage domains in the results list.
- Click New Domain to open the New Domain window.
Figure 7.3. POSIX Storage
- Enter the Name for the storage domain.
- Select the Data Center to be associated with the storage domain. The Data Center selected must be of type POSIX (POSIX compliant FS). Alternatively, select
(none)
. - Select
Data / POSIX compliant FS
from the Domain Function / Storage Type drop-down menu.If applicable, select the Format from the drop-down menu. - Select a host from the Use Host drop-down menu. Only hosts within the selected data center will be listed. The host that you select will be used to connect the storage domain.
- Enter the Path to the POSIX file system, as you would normally provide it to the
mount
command. - Enter the VFS Type, as you would normally provide it to the
mount
command using the-t
argument. Seeman mount
for a list of valid VFS types. - Enter additional Mount Options, as you would normally provide them to the
mount
command using the-o
argument. The mount options should be provided in a comma-separated list. Seeman mount
for a list of valid mount options. - Click OK to attach the new Storage Domain and close the window.
You have used a supported mechanism to attach an unsupported file system as a storage domain.
7.4.2. Preparing pNFS Storage
-o minorversion=1
-o v4.1
# chown 36:36 [path to pNFS resource]
$
lsmod | grep nfs_layout_nfsv41_files
7.4.3. Attaching pNFS Storage
A pNFS type Storage Domain is a mounted pNFS share attached to a data center. It provides storage for virtualized guest images and ISO boot media. After you have exported pNFS storage, it must be attached to the Red Hat Enterprise Virtualization Manager using the Administration Portal.
Procedure 7.6. Attaching pNFS Storage
- Click the Storage resource tab to list the existing storage domains.
- Click New Domain to open the New Domain window.
Figure 7.4. NFS Storage
- Enter the Name of the storage domain.
- Select the Data Center, Domain Function / Storage Type, and Use Host from the drop-down menus.If applicable, select the Format from the drop-down menu.
- Enter the Export Path to be used for the storage domain.The export path should be in the format of
192.168.0.10:/data
ordomain.example.com:/data
- In the VFS Type field, enter
nfs4
. - In the Mount Options field, enter
minorversion=1
.Important
All communication to the storage domain comes from the selected host and not from the Red Hat Enterprise Virtualization Manager. At least one active host must be attached to the chosen Data Center before the storage is configured. - Click OK to create the storage domain and close the window.
The new pNFS data domain is displayed on the Storage tab with a status of Locked
while the disk prepares. It is automatically attached to the data center upon completion.
7.5. Preparing and Adding Block Storage
7.5.1. Preparing iSCSI Storage
These steps must be taken to export iSCSI storage device from a server running Red Hat Enterprise Linux 6 to use as a storage domain with Red Hat Enterprise Virtualization.
Procedure 7.7. Preparing iSCSI Storage
- Install the scsi-target-utils package using the
yum
command as root on your storage server.# yum install -y scsi-target-utils
- Add the devices or files you want to export to the
/etc/tgt/targets.conf
file. Here is a generic example of a basic addition to thetargets.conf
file:<target iqn.YEAR-MONTH.com.EXAMPLE:SERVER.targetX> backing-store /PATH/TO/DEVICE1 # Becomes LUN 1 backing-store /PATH/TO/DEVICE2 # Becomes LUN 2 backing-store /PATH/TO/DEVICE3 # Becomes LUN 3 </target>
Targets are conventionally defined using the year and month they are created, the reversed fully qualified domain that the server is in, the server name, and a target number. - Start the tgtd service.
# service tgtd start
- Make the tgtd start persistently across reboots.
# chkconfig tgtd on
- Open an iptables firewall port to allow clients to access your iSCSI export. By default, iSCSI uses port 3260. This example inserts a firewall rule at position 6 in the INPUT table.
# iptables -I INPUT 6 -p tcp --dport 3260 -j ACCEPT
- Save the iptables rule you just created.
# service iptables save
You have created a basic iSCSI export. You can use it as an iSCSI data domain.
7.5.2. Adding iSCSI Storage
Red Hat Enterprise Virtualization platform supports iSCSI storage by creating a storage domain from a volume group made of pre-existing LUNs. Neither volume groups nor LUNs can be attached to more than one storage domain at a time.
Note
Procedure 7.8. Adding iSCSI Storage
- Click the Storage resource tab to list the existing storage domains in the results list.
- Click the New Domain button to open the New Domain window.
- Enter the Name of the new storage domain.
Figure 7.5. New iSCSI Domain
- Use the Data Center drop-down menu to select an iSCSI data center.If you do not yet have an appropriate iSCSI data center, select
(none)
. - Use the drop-down menus to select the Domain Function / Storage Type and the Format. The storage domain types that are not compatible with the chosen data center are not available.
- Select an active host in the Use Host field. If this is not the first data domain in a data center, you must select the data center's SPM host.
Important
All communication to the storage domain is via the selected host and not directly from the Red Hat Enterprise Virtualization Manager. At least one active host must exist in the system, and be attached to the chosen data center, before the storage is configured. - The Red Hat Enterprise Virtualization Manager is able to map either iSCSI targets to LUNs, or LUNs to iSCSI targets. The New Domain window automatically displays known targets with unused LUNs when iSCSI is selected as the storage type. If the target that you are adding storage from is not listed then you can use target discovery to find it, otherwise proceed to the next step.
iSCSI Target Discovery
- Click Discover Targets to enable target discovery options. When targets have been discovered and logged in to, the New Domain window automatically displays targets with LUNs unused by the environment.
Note
LUNs used externally to the environment are also displayed.You can use the Discover Targets options to add LUNs on many targets, or multiple paths to the same LUNs. - Enter the fully qualified domain name or IP address of the iSCSI host in the Address field.
- Enter the port to connect to the host on when browsing for targets in the Port field. The default is
3260
. - If the Challenge Handshake Authentication Protocol (CHAP) is being used to secure the storage, select the User Authentication check box. Enter the CHAP user name and CHAP password.
- Click the Discover button.
- Select the target to use from the discovery results and click the Login button.Alternatively, click the Login All to log in to all of the discovered targets.
- Click the + button next to the desired target. This will expand the entry and display all unused LUNs attached to the target.
- Select the check box for each LUN that you are using to create the storage domain.
- Click OK to create the storage domain and close the window.
The new iSCSI storage domain displays on the storage tab. This can take up to 5 minutes.
7.5.3. Adding FCP Storage
Red Hat Enterprise Virtualization platform supports SAN storage by creating a storage domain from a volume group made of pre-existing LUNs. Neither volume groups nor LUNs can be attached to more than one storage domain at a time.
Note
Procedure 7.9. Adding FCP Storage
- Click the Storage resource tab to list all storage domains in the virtualized environment.
- Click New Domain to open the New Domain window.
- Enter the Name of the storage domain
Figure 7.6. Adding FCP Storage
- Use the Data Center drop-down menu to select an FCP data center.If you do not yet have an appropriate FCP data center, select
(none)
. - Use the drop-down menus to select the Domain Function / Storage Type and the Format. The storage domain types that are not compatible with the chosen data center are not available.
- Select an active host in the Use Host field. If this is not the first data domain in a data center, you must select the data center's SPM host.
Important
All communication to the storage domain is via the selected host and not directly from the Red Hat Enterprise Virtualization Manager. At least one active host must exist in the system, and be attached to the chosen data center, before the storage is configured. - The New Domain window automatically displays known targets with unused LUNs when Data / Fibre Channel is selected as the storage type. Select the LUN ID check box to select all of the available LUNs.
- Click OK to create the storage domain and close the window.
The new FCP data domain displays on the Storage tab. It will remain with a Locked
status while it is being prepared for use. When ready, it is automatically attached to the data center.
7.5.4. Unusable LUNs in Red Hat Enterprise Virtualization
- LUNs that are already part of the current Red Hat Enterprise Virtualization environment are automatically prevented from being used.
Figure 7.7. Unusable LUNs in the Red Hat Enterprise Virtualization Administration Portal
- LUNs that are already being used by the SPM host will also display as in use. You can choose to forcefully over ride the contents of these LUNs, but the operation is not guaranteed to succeed.
7.6. Storage Tasks
7.6.1. Importing Existing ISO or Export Storage Domains
You have an ISO or export domain that you have been using with a different data center. You want to attach it to the data center you are using, and import virtual machines or use ISOs.
Procedure 7.10. Importing an Existing ISO or Export Storage Domain
- Click the Storage resource tab to list all the available storage domains in the results list.
- Click Import Domain to open the Import Pre-Configured Domain window.
Figure 7.8. Import Domain
- Select the appropriate Domain Function / Storage Type from the following:
- ISO
- Export
The Domain Function / Storage Type determines the availability of the Format field. - Select the SPM host from the Use host drop-down menu.
Important
All communication to the storage domain is via the selected host and not from the Red Hat Enterprise Virtualization Manager. At least one host must be active and have access to the storage before the storage can be configured. - Enter the Export path of the storage. The export path can be either a static IP address or a resolvable hostname. For example,
192.168.0.10:/Images/ISO
orstorage.demo.redhat.com:/exports/iso
. - Click OK to import the domain and close the window.
- The storage domain is imported and displays on the Storage tab. The next step is to attach it to a data center. This is described later in this chapter, .
You have imported your export or ISO domain to you data center. Attach it to a data center to use it.
7.6.2. Populating the ISO Storage Domain
An ISO storage domain is attached to a data center, ISO images must be uploaded to it. Red Hat Enterprise Virtualization provides an ISO uploader tool that ensures that the images are uploaded into the correct directory path, with the correct user permissions.
Procedure 7.11. Populating the ISO Storage Domain
- Copy the required ISO image to a temporary directory on the system running Red Hat Enterprise Virtualization Manager.
- Log in to the system running Red Hat Enterprise Virtualization Manager as the
root
user. - Use the
engine-iso-uploader
command to upload the ISO image. This action will take some time, the amount of time varies depending on the size of the image being uploaded and available network bandwidth.Example 7.1. ISO Uploader Usage
In this example the ISO imageRHEL6.iso
is uploaded to the ISO domain calledISODomain
using NFS. The command will prompt for an administrative user name and password. The user name must be provided in the form user name@domain.#
engine-iso-uploader
--iso-domain=ISODomain
upload
RHEL6.iso
The ISO image is uploaded and appears in the ISO storage domain specified. It is also available in the list of available boot media when creating virtual machines in the data center which the storage domain is attached to.
7.6.3. Moving Storage Domains to Maintenance Mode
Detaching and removing storage domains requires that they be in maintenance mode. This is required to redesignate another data domain as the master data domain.
Important
Procedure 7.12. Moving storage domains to maintenance mode
- Use the Storage resource tab, tree mode, or the search function to find and select the storage domain in the results list.
- Shut down and move all the virtual machines running on the storage domain.
- Click the Data Centers tab in the details pane.
- Click Maintenance to open the Maintenance Storage Domain(s) confirmation window.
- Click OK to initiate maintenance mode. The storage domain is deactivated and has an
Inactive
status in the results list.
You can now edit, detach, remove, or reactivate the inactive storage domains from the data center.
Note
7.6.4. Editing a Resource
Edit the properties of a resource.
Procedure 7.13. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click Edit to open the Edit window.
- Change the necessary properties and click OK.
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
7.6.5. Activating Storage Domains
If you have been making changes to a data center's storage, you have to put storage domains into maintenance mode. Activate a storage domain to resume using it.
- Use the Storage resource tab, tree mode, or the search function to find and select the inactive storage domain in the results list.
- Click the Data Centers tab in the details pane.
- Select the appropriate data center and click Activate.
Important
If you attempt to activate the ISO domain before activating the data domain, an error message displays and the domain is not activated.
Your storage domain is active and ready for use.
7.6.6. Removing a Storage Domain
You have a storage domain in your data center that you want to remove from the virtualized environment.
Procedure 7.14. Removing a Storage Domain
- Use the Storage resource tab, tree mode, or the search function to find and select the appropriate storage domain in the results list.
- Move the domain into maintenance mode to deactivate it.
- Detach the domain from the data center.
- Click Remove to open the Remove Storage confirmation window.
- Select a host from the list.
- Click OK to remove the storage domain and close the window.
The storage domain is permanently removed from the environment.
7.6.7. Destroying a Storage Domain
A storage domain encountering errors may not be able to be removed through the normal procedure. Destroying a storage domain will forcibly remove the storage domain from the virtualized environment without reference to the export directory.
Procedure 7.15. Destroying a Storage Domain
- Use the Storage resource tab, tree mode, or the search function to find and select the appropriate storage domain in the results list.
- Right-click the storage domain and select Destroy to open the Destroy Storage Domain confirmation window.
- Select the Approve operation check box and click OK to destroy the storage domain and close the window.
The storage domain has been destroyed. Manually clean the export directory for the storage domain to recycle it.
7.6.8. Detaching the Export Domain
Detach the export domain from the data center to import the templates to another data center.
Procedure 7.16. Detaching an Export Domain from the Data Center
- Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list.
- Click the Data Centers tab in the details pane and select the export domain.
- Click Maintenance to open the Maintenance Storage Domain(s) confirmation window.
- Click OK to initiate maintenance mode.
- Click Detach to open the Detach Storage confirmation window.
- Click OK to detach the export domain.
The export domain has been detached from the data center, ready to be attached to another data center.
7.6.9. Attaching an Export Domain to a Data Center
Attach the export domain to a data center.
Procedure 7.17. Attaching an Export Domain to a Data Center
- Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list.
- Click the Data Centers tab in the details pane.
- Click Attach to open the Attach to Data Center window.
- Select the radio button of the appropriate data center.
- Click OK to attach the export domain.
The export domain is attached to the data center and is automatically activated.
7.7. Storage and Permissions
7.7.1. Managing System Permissions for a Storage Domain
- Edit the configuration of the storage domain.
- Move the storage domain into maintenance mode.
- Remove the storage domain.
Note
7.7.2. Storage Administrator Roles Explained
The table below describes the administrator roles and privileges applicable to storage domain administration.
Table 7.1. Red Hat Enterprise Virtualization System Administrator Roles
Role | Privileges | Notes |
---|---|---|
StorageAdmin | Storage Administrator | Can create, delete, configure and manage a specific storage domain. |
GlusterAdmin | Gluster Storage Administrator | Can create, delete, configure and manage Gluster storage volumes. |
7.7.3. Assigning an Administrator or User Role to a Resource
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 7.18. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click Add to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click Go. Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click OK to assign the role and close the window.
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
7.7.4. Removing an Administrator or User Role from a Resource
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 7.19. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click Remove. The Remove Permission window opens to confirm permissions removal.
- Click OK to remove the user role.
You have removed the user's role, and the associated permissions, from the resource.
Chapter 8. Working with Red Hat Storage
8.1. Red Hat Storage Nodes
8.1.1. Adding Red Hat Storage Nodes
Add Red Hat Storage nodes to gluster-enabled clusters and incorporate GlusterFS volumes and bricks into your Red Hat Enterprise Virtualization environment.
Note
Procedure 8.1. Adding a Red Hat Storage Node
- Click the Hosts resource tab to list the hosts in the results list.
- Click New to open the New Host window.
- Use the drop-down menus to select the Data Center and Host Cluster for the Red Hat Storage node.
- Enter the Name, Address, and SSH Port of the Red Hat Storage node.
- Select an authentication method to use with the Red Hat Storage node.
- Enter the root user's password to use password authentication.
- Copy the key displayed in the SSH PublicKey field to
/root/.ssh/authorized_keys
on the Red Hat Storage node to use public key authentication.
- Click OK to add the node and close the window.
You have added a Red Hat Storage node to your Red Hat Enterprise Virtualization environment. You can now use the volume and brick resources of the node in your environment.
8.1.2. Removing a Red Hat Storage Node
Remove a Red Hat Storage node from your Red Hat Enterprise Virtualization environment.
Procedure 8.2. Removing a Red Hat Storage Node
- Use the Hosts resource tab, tree mode, or the search function to find and select the Red Hat Storage node in the results list.
- Place the Red Hat Storage node into maintenance mode by clicking Maintenance button.
- Click Remove to open the Remove Host(s) confirmation window.
- Select the Force Remove check box if the node has volume bricks on it, or if the node is non-responsive.
- Click OK to remove the node and close the window.
Your Red Hat Storage node has been removed from the environment and is no longer visible in the Hosts tab.
8.2. Using Red Hat Storage
8.2.1. Introduction to Red Hat Storage (GlusterFS) Volumes
8.2.2. Gluster Storage Terminology
Table 8.1. Data Center Properties
Term
|
Definition
|
---|---|
Brick
|
A brick is the GlusterFS basic unit of storage, represented by an export directory on a server in the trusted storage pool. A Brick is expressed by combining a server with an export directory in the following format:
SERVER:EXPORT
For example:
myhostname:/exports/myexportdir/
|
Block Storage
|
Block special files or block devices correspond to devices through which the system moves data in the form of blocks. These device nodes often represent addressable devices such as hard disks, CD-ROM drives, or memory-regions. Red Hat Storage supports XFS file system with extended attributes.
|
Cluster
|
A trusted pool of linked computers, working together closely thus in many respects forming a single computer. In Red Hat Storage terminology a cluster is called as trusted storage pool.
|
Client
|
The machine which mounts the volume (this may also be a server)
|
Distributed File System
|
A file system that allows multiple clients to concurrently access data spread across multiple servers/bricks in a trusted storage pool. Data sharing among multiple locations is fundamental to all distributed file system.
|
Geo-Replication
|
Geo-replication provides a continuous, asynchronous, and incremental replication service from site to another over Local Area Networks (LAN), Wide Area Network (WAN), and across the Internet.
|
glusterd
|
The Gluster management daemon that needs to run on all servers in the trusted storage pool.
|
Metadata
|
Metadata is data providing information about one or more other pieces of data.
|
N-way Replication
|
Local synchronous data replication typically deployed across campus or Amazon Web Services Availability Zones.
|
Namespace
|
Namespace is an abstract container or environment created to hold a logical grouping of unique identifiers or symbols. Each Red Hat Storage trusted storage pool exposes a single namespace as a POSIX mount point that contains every file in the trusted storage pool.
|
POSIX
|
Portable Operating System Interface (for Unix) is the name of a family of related standards specified by the IEEE to define the application programming interface (API), along with shell and utilities interfaces for software compatible with variants of the UNIX operating system. Red Hat Storage exports a fully POSIX compatible file system.
|
RAID
|
Redundant Array of Inexpensive Disks (RAID) is a technology that provides increased storage reliability through redundancy, combining multiple low-cost, less-reliable disk drives components into a logical unit where all drives in the array are interdependent.
|
RRDNS
|
Round Robin Domain Name Service (RRDNS) is a method to distribute load across application servers. RRDNS is implemented by creating multiple A records with the same name and different IP addresses in the zone file of a DNS server.
|
Server
|
The machine (virtual or bare metal) which hosts the actual file system in which data will be stored.
|
Scale-Up Storage
|
Increases the capacity of the storage device, but only in a single dimension. An example might be adding additional disk capacity to a single computer in a trusted storage pool.
|
Scale-Out Storage
|
Increases the capability of a storage device in multiple dimensions. For example adding a server to a trusted storage pool increases CPU, disk capacity, and throughput for the trusted storage pool.
|
Subvolume
|
A brick after being processed by at least one translator.
|
Translator
|
A translator connects to one or more subvolumes, does something with them, and offers a subvolume connection.
|
Trusted Storage Pool
|
A storage pool is a trusted network of storage servers. When you start the first server, the storage pool consists of that server alone.
|
User Space
|
Applications running in user space donât directly interact with hardware, instead using the kernel to moderate access. User Space applications are generally more portable than applications in kernel space. Gluster is a user space application.
|
Virtual File System (VFS)
|
VFS is a kernel software layer that handles all system calls related to the standard Linux file system. It provides a common interface to several kinds of file systems
|
Volfile
|
Volfile is a configuration file used by glusterfs process. Volfile will be usually located at
/var/lib/glusterd/vols/VOLNAME .
|
Volume
|
A volume is a logical collection of bricks. Most of the gluster management operations happen on the volume.
|
8.2.3. Creating a Storage Volume
You can create new volumes using the Administration Portal. When creating a new volume, you must specify the bricks that comprise the volume and specify whether the volume is to be distributed, replicated, or striped.
Important
Procedure 8.3. Creating A Storage Volume
- Click the Volumes resource tab to list existing volumes in the results list.
- Click New to open the New Volume window.
- Use the drop-down menus to select the Data Center and Volume Cluster.
- Enter the Name of the volume.
- Use the drop-down menu to select the Type of the volume.
- If active, select the appropriate Transport Type check box.
- Click the Add Bricks button to select bricks to add to the volume. Bricks must be created externally on the Red Hat Storage nodes.
- If active, use the Gluster, NFS, and CIFS check boxes to select the appropriate access protocols used for the volume.
- Enter the volume access control as a comma-separated list of IP addresses or hostnames in the Allow Access From field.You can use the * wildcard to specify ranges of addresses of IP addresses or hostnames.
- Select the Optimize for Virt Store option to set the parameters to optimize your volume for virtual machine storage. Select this if you intend to use this volume as a storage domain.
- Click OK to create the volume. The new volume is added and displays on the Volume tab.
You have added a Red Hat Storage volume. You can now use it for storage.
8.2.4. Adding Bricks to a Volume
You can expand your volumes by adding new bricks. You need to add at least one brick to a distributed volume, multiples of two bricks to replicated volumes, multiples of four bricks to striped volumes when expanding your storage space.
Procedure 8.4. Adding Bricks to a Volume
- On the Volumes tab on the navigation pane, select the volume to which you want to add bricks.
- Select the volume you want to add new bricks to. Click the Bricks tab from the Details pane.
- Click Add Bricks to open the Add Bricks window.
- Use the Server drop-down menu to select the server on which the brick resides.
- Enter the path of the Brick Directory. The directory must already exist.
- Click Add. The brick appears in the list of bricks in the volume, with server addresses and brick directory names.
- Click OK.
The new bricks are added to the volume and the bricks display in the volume's Bricks tab.
8.2.5. Explanation of Settings in the Add Bricks Window
Table 8.2. Add Bricks Tab Properties
Field Name
|
Description
|
---|---|
Volume Type
|
Displays the type of volume. This field cannot be changed, it was set when you created the volume.
|
Server
|
The server where the bricks are hosted.
|
Brick Directory |
The brick directory or mountpoint.
|
8.2.6. Optimizing Red Hat Storage Volumes to Store Virtual Machine Images
Important
8.2.7. Starting Volumes
After a volume has been created or an existing volume has been stopped, it needs to be started before it can be used.
Procedure 8.5. Starting Volumes
- In the Volumes tab, select the volume to be started.You can select multiple volumes to start by using
Shift
orCtrl
key. - Click the Start button.
Up
.
You can now use your volume for virtual machine storage.
8.2.8. Tuning Volumes
Tuning volumes allows you to affect their performance. To tune volumes, you add options to them.
Procedure 8.6. Tuning Volumes
- Click the Volumes tab.A list of volumes displays.
- Select the volume that you want to tune, and click the Volume Options tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Click Add to set an option. The Add Option dialog box displays. Select the Option Key from the drop down list and enter the option value.
- Click OK.The option is set and displays in the Volume Options tab.
You have tuned the options for your storage volume.
8.2.9. Editing Volume Options
You have tuned your volume by adding options to it. You can change the options for your storage volume.
Procedure 8.7. Editing Volume Options
- Click the Volumes tab.A list of volumes displays.
- Select the volume that you want to edit, and click the Volume Options tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Select the option you want to edit. Click Edit. The Edit Option dialog box displays. Enter a new value for the option.
- Click OK.The edited option displays in the Volume Options tab.
You have changed the options on your volume.
8.2.10. Reset Volume Options
You can reset options to revert them to their default values.
- Click the Volumes tab.A list of volumes displays.
- Select the volume and click the Volume Options tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Select the option you want to reset. Click Reset. A dialog box displays, prompting to confirm the reset option.
- Click OK.The selected option is reset.
Note
You have reset volume options to default.
8.2.11. Removing Bricks from a Volume
You can shrink volumes, as needed, while the cluster is online and available. For example, you might need to remove a brick that has become inaccessible in a distributed volume due to hardware or network failure.
Procedure 8.8. Removing Bricks from a Volume
- On the Volumes tab on the navigation pane, select the volume from which you wish to remove bricks.
- Click the Bricks tab from the Details pane.
- Select the bricks you wish to remove. Click Remove Bricks.
- A window opens, prompting to confirm the deletion. Click OK to confirm.
The bricks are removed from the volume.
8.2.12. Stopping Red Hat Storage Volumes
After a volume has been started, it can be stopped.
Procedure 8.9. Stopping Volumes
- In the Volumes tab, select the volume to be stopped.You can select multiple volumes to stop by using
Shift
orCtrl
key. - Click Stop.
The volume status changes is Down
.
8.2.13. Deleting Red Hat Storage Volumes
You can delete a volume or multiple volumes from your cluster.
- In the Volumes tab, select the volume to be deleted.
- Click Remove. A dialog box displays, prompting to confirm the deletion. Click OK.
The volume is removed from the cluster.
8.2.14. Rebalancing Volumes
If a volume has been expanded or shrunk by adding or removing bricks to or from that volume, the data on the volume must be rebalanced amongst the servers.
Procedure 8.10. Rebalancing a Volume
- Click the Volumes tab.A list of volumes displays.
- Select the volume to rebalance.
- Click Rebalance.
The selected volume is rebalanced.
8.3. Clusters and Gluster Hooks
8.3.1. Managing Gluster Hooks
- View a list of hooks available in the hosts.
- View the content and status of hooks.
- Enable or disable hooks.
- Resolve hook conflicts.
8.3.2. Listing Hooks
List the Gluster hooks in the details pane of your environment.
Procedure 8.11. Listing a Hook
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
You have listed the Gluster hooks in your environment.
8.3.3. Viewing the Content of Hooks
View the content of a Gluster hook in your environment.
Procedure 8.12. Viewing the Content of a Hook
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select a hook with content type Text and click the View Content button to open the Hook Content window.
You have viewed the content of a hook in your environment.
8.3.4. Enabling or Disabling Hooks
Toggle the activity of a Gluster hook by enabling or disabling it.
Procedure 8.13. Enabling or Disabling a Hook
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select a hook and click one of the Enable or Disable buttons. The hook is enabled or disabled on all nodes of the cluster.
You have toggled the activity of a Gluster hook in your environment.
8.3.5. Refreshing Hooks
By default, the Manager checks the status of installed hooks on the engine and on all servers in the cluster and detects new hooks by running a periodic job every hour. You can refresh hooks manually by clicking the Sync button.
Procedure 8.14. Refreshing a Hook
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Click the Sync button.
The hooks are synchronized and updated in the details pane.
8.3.6. Resolving Conflicts
- Content Conflict - the content of the hook is different across servers.
- Missing Conflict - one or more servers of the cluster do not have the hook.
- Status Conflict - the status of the hook is different across servers.
- Multiple Conflicts - a hook has a combination of two or more of the aforementioned conflicts.
8.3.7. Resolving Content Conflicts
A hook that is not consistent across the servers and engine will be flagged as having a conflict. To resolve the conflict, you must select a version of the hook to be copied across all servers and the engine.
Procedure 8.15. Resolving a Content Conflict
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select the conflicting hook and click the Resolve Conflicts button to open the Resolve Conflicts window.
- Select the engine or a server from the list of sources to view the content of that hook and establish which version of the hook to copy.
Note
The content of the hook will be overwritten in all servers and in the engine. - Use the Use content from drop-down menu to select the preferred server or the engine.
- Click OK to resolve the conflict and close the window.
The hook from the selected server is copied across all servers and the engine to be consistent across the environment.
8.3.8. Resolving Missing Hook Conflicts
A hook that is not present on all the servers and the engine will be flagged as having a conflict. To resolve the conflict, either select a version of the hook to be copied across all servers and the engine, or remove the missing hook entirely.
Procedure 8.16. Resolving a Missing Hook Conflict
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select the conflicting hook and click the Resolve Conflicts button to open the Resolve Conflicts window.
- Select any source with a status of Enabled to view the content of the hook.
- Select the appropriate radio button, either Copy the hook to all the servers or Remove the missing hook. The latter will remove the hook from the engine and all servers.
- Click OK to resolve the conflict and close the window.
Depending on your chosen resolution, the hook has either been removed from the environment entirely, or has been copied across all servers and the engine to be consistent across the environment.
8.3.9. Resolving Status Conflicts
A hook that does not have a consistent status across the servers and engine will be flagged as having a conflict. To resolve the conflict, select a status to be enforced across all servers in the environment.
Procedure 8.17. Resolving a Status Conflict
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select the conflicting hook and click the Resolve Conflicts button to open the Resolve Conflicts window.
- Set Hook Status to Enable or Disable.
- Click OK to resolve the conflict and close the window.
The selected status for the hook is enforced across the engine and the servers to be consistent across the environment.
8.3.10. Resolving Multiple Conflicts
A hook may have a combination of two or more conflicts. These can all be resolved concurrently or independently through the Resolve Conflicts window. This procedure will resolve all conflicts for the hook so that it is consistent across the engine and all servers in the environment.
Procedure 8.18. Resolving Multiple Conflicts
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select the conflicting hook and click the Resolve Conflicts button to open the Resolve Conflicts window.
- Choose a resolution to each of the affecting conflicts, as per the appropriate procedure.
- Click OK to resolve the conflicts and close the window.
You have resolved all of the conflicts so that the hook is consistent across the engine and all servers.
8.3.11. Managing Gluster Sync
Note
Chapter 9. Virtual Machines
9.1. Introduction to Virtual Machines
9.2. Supported Virtual Machine Operating Systems
Table 9.1. Operating systems that can be used as guest operating systems
Operating System | Architecture | SPICE support |
---|---|---|
Red Hat Enterprise Linux 3
|
32-bit, 64-bit
|
Yes
|
Red Hat Enterprise Linux 4
|
32-bit, 64-bit
|
Yes
|
Red Hat Enterprise Linux 5
|
32-bit, 64-bit
|
Yes
|
Red Hat Enterprise Linux 6
|
32-bit, 64-bit
|
Yes
|
SUSE Linux Enterprise Server 10 (select Other Linux for the guest type in the user interface)
|
32-bit, 64-bit
|
No
|
SUSE Linux Enterprise Server 11 (SPICE drivers (QXL) are not supplied by Red Hat. However, the distribution's vendor may provide SPICE drivers as part of their distribution.)
|
32-bit, 64-bit
|
No
|
Ubuntu 12.04 (Precise Pangolin LTS)
|
32-bit, 64-bit
|
Yes
|
Ubuntu 12.10 (Quantal Quetzal)
|
32-bit, 64-bit
|
Yes
|
Ubuntu 13.04 (Raring Ringtail)
|
32-bit, 64-bit
|
No
|
Ubuntu 13.10 (Saucy Salamander)
|
32-bit, 64-bit
|
Yes
|
Windows XP Service Pack 3 and newer
|
32-bit
|
Yes
|
Windows 7
|
32-bit, 64-bit
|
Yes
|
Windows 8
|
32-bit, 64-bit
|
No
|
Windows 8.1
|
32-bit, 64-bit
|
No
|
Windows Server 2003 Service Pack 2 and newer
| |
Yes
|
Windows Server 2003 R2
| |
Yes
|
Windows Server 2008
|
32-bit, 64-bit
|
Yes
|
Windows Server 2008 R2
|
64-bit
|
Yes
|
Windows Server 2012
|
64-bit
|
No
|
Windows Server 2012 R2
|
64-bit
|
No
|
Table 9.2. Guest operating systems that are supported by Global Support Services
Operating System | Architecture |
---|---|
Red Hat Enterprise Linux 3
|
32-bit, 64-bit
|
Red Hat Enterprise Linux 4
|
32-bit, 64-bit
|
Red Hat Enterprise Linux 5
|
32-bit, 64-bit
|
Red Hat Enterprise Linux 6
|
32-bit, 64-bit
|
SUSE Linux Enterprise Server 10 (select Other Linux for the guest type in the user interface)
|
32-bit, 64-bit
|
SUSE Linux Enterprise Server 11 (SPICE drivers (QXL) are not supplied by Red Hat. However, the distribution's vendor may provide SPICE drivers as part of their distribution.)
|
32-bit, 64-bit
|
Windows XP Service Pack 3 and newer
|
32-bit
|
Windows 7
|
32-bit, 64-bit
|
Windows 8
|
32-bit, 64-bit
|
Windows 8.1
|
32-bit, 64-bit
|
Windows Server 2003 Service Pack 2 and newer
| |
Windows Server 2003 R2
| |
Windows Server 2008
|
32-bit, 64-bit
|
Windows Server 2008 R2
|
64-bit
|
Windows Server 2012
|
64-bit
|
Windows Server 2012 R2
|
64-bit
|
Note
Note
9.3. Virtual Machine Performance Parameters
Table 9.3. Supported virtual machine parameters
Parameter | Number | Note |
---|---|---|
Virtualized CPUs | 160 | per virtual machine |
Virtualized RAM | 2TB | For a 64 bit virtual machine |
Virtualized RAM | 4GB | per 32 bit virtual machine. Note, the virtual machine may not register the entire 4GB. The amount of RAM that the virtual machine recognizes is limited by its operating system. |
Virtualized storage devices | 8 | per virtual machine |
Virtualized network interface controllers | 8 | per virtual machine |
Virtualized PCI devices | 32 | per virtual machine |
9.4. Creating Virtual Machines
9.4.1. Creating a Virtual Machine
You can create a virtual machine using a blank template and configure all of its settings.
Procedure 9.1. Creating a Virtual Machine
- Click the Virtual Machines tab.
- Click the New VM button to open the New Virtual Machine window.
Figure 9.1. The New Virtual Machine Window
- On the General tab, fill in the Name and Operating System fields. You can accept the default settings for other fields, or change them if required.
- Alternatively, click the Initial Run, Console, Host, Resource Allocation, Boot Options, and Custom Properties tabs in turn to define options for your virtual machine.
- Click OK to create the virtual machine and close the window.
- The New Virtual Machine - Guide Me window opens. Use the Guide Me buttons to complete configuration or click Configure Later to close the window.
The new virtual machine is created and displays in the list of virtual machines with a status of Down
. Before you can use this virtual machine, add at least one network interface and one virtual disk, and install an operating system.
9.4.2. Creating a Virtual Machine Based on a Template
You can create virtual machines based on templates. This allows you to create virtual machines that are pre-configured with an operating system, network interfaces, applications and other resources.
Note
Procedure 9.2. Creating a Virtual Machine Based on a Template
- Click the Virtual Machines tab.
- Click the New VM button to open the New Virtual Machine window.
- Select the Cluster on which the virtual machine will run.
- Select a template from the Based on Template drop-down menu.
- Select a template sub version from the Template Sub Version drop-down menu.
- Enter a Name, Description and any Comments, and accept the default values inherited from the template in the rest of the fields. You can change them if needed.
- Click the Resource Allocation tab.
Figure 9.2. Provisioning - Thin
- Select the Thin radio button in the Storage Allocation area.
- Select the disk provisioning policy from the Allocation Policy drop-down menu. This selection affects the speed of the clone operation and the amount of disk space the new virtual machine will initially require.
- Selecting Thin Provision results in a faster clone operation and provides optimized usage of storage capacity. Disk space is allocated only as it is required. This is the default selection.
- Selecting Preallocated results in a slower clone operation and provides optimized virtual machine read and write operations. All disk space requested in the template is allocated at the time of the clone operation.
- Select the storage domain on which the virtual disk for the virtual machine will be stored from the Target drop-down menu.
- Click OK.
The virtual machine is created and displayed in the list in the Virtual Machines tab. You can now log on to the virtual machine and begin using it, or assign users to it.
9.4.3. Creating a Cloned Virtual Machine Based on a Template
Cloned virtual machines are similar to virtual machines based on templates. However, while a cloned virtual machine inherits settings in the same way as a virtual machine based on a template, a cloned virtual machine does not depend on the template on which it was based after it has been created.
Note
Procedure 9.3. Cloning a Virtual Machine Based on a Template
- Click the Virtual Machines tab.
- Click the New VM button to open the New Virtual Machine window.
- Select the Cluster on which the virtual machine will run.
- Select a template from the Based on Template drop-down menu.
- Select a template sub version from the Template Sub Version drop-down menu.
- Enter a Name, Description and any Comments, and accept the default values inherited from the template in the rest of the fields. You can change them if needed.
- Click the Resource Allocation tab.
Figure 9.3. Provisioning - Clone
- Select the Clone radio button in the Storage Allocation area.
- Select the disk provisioning policy from the Allocation Policy drop-down menu. This selection affects the speed of the clone operation and the amount of disk space the new virtual machine will initially require.
- Selecting Thin Provision results in a faster clone operation and provides optimized usage of storage capacity. Disk space is allocated only as it is required. This is the default selection.
- Selecting Preallocated results in a slower clone operation and provides optimized virtual machine read and write operations. All disk space requested in the template is allocated at the time of the clone operation.
- Select the storage domain on which the virtual disk for the virtual machine will be stored from the Target drop-down menu.
- Click OK.
Note
The virtual machine is created and displayed in the list in the Virtual Machines tab. You can now assign users to it, and can begin using it when the clone operation is complete.
9.5. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine Windows
9.5.1. Virtual Machine General Settings Explained
Table 9.4. Virtual Machine: General Settings
Field Name
|
Description
|
---|---|
Cluster
|
The name of the host cluster to which the virtual machine is attached. Virtual machines are hosted on any physical machine in that cluster in accordance with policy rules.
|
Based on Template
|
The template on which the virtual machine will be based. This field is set to
Blank by default, which allows you to create a virtual machine on which an operating system has not yet been installed.
|
Template Sub Version
|
The version of the template on which the virtual machine will be based. This field is set to the most recent version for the given template by default. If no versions other than the base template are available, this field is set to
base template by default. Each version is marked by a number in brackets that indicates the relative order of the versions, with higher numbers indicating more recent versions.
|
Operating System
|
The operating system. Valid values include a range of Red Hat Enterprise Linux and Windows variants.
|
Optimized for
|
The type of system for which the virtual machine is to be optimized. There are two options: Server, and Desktop, and the field is set to Server by default. Virtual machines optimized to act as servers have no sound card, use a cloned disk image and are not stateless. In contrast, virtual machines optimized to act as desktop machines do have a sound card, use an image (thin allocation) and are stateless.
|
Name
|
The name of virtual machine. Names must not contain any spaces, and must contain at least one character from A-Z or 0-9. The maximum length of a virtual machine name is 64 characters.
|
Description
|
A meaningful description of the new virtual machine.
|
Comment
|
A field for adding plain text, human-readable comments regarding the virtual machine.
|
Stateless
|
Select this check box if the virtual machine is to run in stateless mode. The stateless mode is used primarily for desktop virtual machines. Running a stateless desktop or server creates a new COW layer on the virtual machine hard disk image where new and changed data is stored. Shutting down the stateless virtual machine deletes the new COW layer, returning the virtual machine to its original state. This type of virtual machine is useful when creating virtual machines that need to be used for a short time, or by temporary staff.
|
Start in Pause Mode
|
Select this check box to always start the VM in pause mode. This option is suitable for virtual machines which require a long time to establish a SPICE connection, for example virtual machines in remote locations.
|
Delete Protection
|
Select this check box to make deletion of the virtual machine impossible. It is possible to delete the virtual machine only when this check box is not selected.
|
9.5.2. Virtual Machine System Settings Explained
Table 9.5. Virtual Machine: System Settings
Field Name
|
Description
|
---|---|
Memory Size
|
The amount of memory assigned to the virtual machine. When allocating memory, consider the processing and storage needs of the applications that are intended to run on the virtual machine.
Maximum guest memory is constrained by the selected guest architecture and the cluster compatibility level.
|
Total Virtual CPUs
|
The processing power allocated to the virtual machine as CPU Cores. Do not assign more cores to a virtual machine than are present on the physical host.
|
Cores per Virtual Socket
|
The number of cores assigned to each virtual socket.
|
Virtual Sockets
|
The number of CPU sockets for the virtual machine. Do not assign more sockets to a virtual machine than are present on the physical host.
|
9.5.3. Virtual Machine Initial Run Settings Explained
Table 9.6. Virtual Machine: Initial Run Settings
Field Name
|
Description
|
---|---|
Use Cloud-Init/Sysprep
|
This check box toggles whether Cloud-Init or Sysprep will be used to initialize the virtual machine.
|
VM Hostname
|
Allows you to specify a host name for the virtual machine.
|
Configure Time Zone
|
Allows you to apply a specific time zone for the virtual machine. Select this check box and select a time zone from the Time Zone drop-down menu to specify the time zone.
|
Authentication |
Allows you to configure authentication details for the virtual machine. Click the disclosure arrow to display the settings for this option.
|
Networks
|
Allows you to specify network-related settings for the virtual machine. Click the disclosure arrow to display the settings for this option.
|
Custom Script
|
Allows you to enter custom scripts that will be run on the virtual machine when it starts. The scripts entered in this field are custom YAML sections that are added to those produced by the Manager, and allow you to automate tasks such as creating users and files, configuring yum repositories and running commands. For more information on the format of scripts that can be entered in this field, see the Custom Script documentation.
|
9.5.4. Virtual Machine Console Settings Explained
Table 9.7. Virtual Machine: Console Settings
Field Name
|
Description
|
---|---|
Protocol
|
Defines the display protocol to be used. SPICE is the recommended protocol for Linux and Windows virtual machines, excepting Windows 8 and Windows Server 2012. Optionally, select VNC for Linux virtual machines. A VNC client is required to connect to a virtual machine using the VNC protocol.
|
VNC Keyboard Layout
|
Defines the keyboard layout for the virtual machine. This option is only available when using the VNC protocol.
|
USB Support
|
Defines whether USB devices can be used on the virtual machine. This option is only available for virtual machines using the SPICE protocol. Select either:
|
Monitors
|
The number of monitors for the virtual machine. This option is only available for virtual desktops using the SPICE display protocol. You can choose 1, 2 or 4. Since Windows 8 and Windows Server 2012 virtual machines do not support the SPICE protocol, they do not support multiple monitors.
|
Smartcard Enabled
|
Smart cards are an external hardware security feature, most commonly seen in credit cards, but also used by many businesses as authentication tokens. Smart cards can be used to protect Red Hat Enterprise Virtualization virtual machines. Tick or untick the check box to activate and deactivate Smart card authentication for individual virtual machines.
|
Disable strict user checking
|
Click the Advanced Parameters arrow and select the check box to use this option. With this option selected, the virtual machine does not need to be rebooted when a different user connects to it.
By default, strict checking is enabled so that only one user can connect to the console of a virtual machine. No other user is able to open a console to the same virtual machine until it has been rebooted. The exception is that a
SuperUser can connect at any time and replace a existing connection. When a SuperUser has connected, no normal user can connect again until the virtual machine is rebooted.
Disable strict checking with caution, because you can expose the previous user's session to the new user.
|
Soundcard Enabled
|
A sound card device is not necessary for all virtual machine use cases. If it is for yours, enable a sound card here.
|
VirtIO Console Device Enabled
|
The VirtIO console device is a console over VirtIO transport for communication between the host user space and guest user space. It has two parts: device emulation in QEMU that presents a virtio-pci device to the guest, and a guest driver that presents a character device interface to user space applications. Tick the check box to attach a VirtIO console device to your virtual machine.
|
9.5.5. Virtual Machine Host Settings Explained
Table 9.8. Virtual Machine: Host Settings
Field Name
|
Description
|
---|---|
Start Running On
|
Defines the preferred host on which the virtual machine is to run. Select either:
|
Migration Options
|
Defines options to run and migrate the virtual machine. If the options here are not used, the virtual machine will run or migrate according to its cluster's policy.
The Use Host CPU check box allows virtual machines to take advantage of the features of the physical CPU of the host on which they are situated. This option can only be enabled when Allow manual migration only or Do not allow migration are selected.
The Use custom migration downtime check box allows you to specify the maximum number of milliseconds the virtual machine can be down during live migration. Configure different maximum downtimes for each virtual machine according to its workload and SLA requirements. The VDSM default value is 0.
|
9.5.6. Virtual Machine High Availability Settings Explained
Table 9.9. Virtual Machine: High Availability Settings
Field Name
|
Description
|
---|---|
Highly Available
|
Select this check box if the virtual machine is to be highly available. For example, in cases of host maintenance or failure, the virtual machine will be automatically moved to or re-launched on another host. If the host is manually shut down by the system administrator, the virtual machine is not automatically moved to another host.
Note that this option is unavailable if the Migration Options setting in the Hosts tab is set to either Allow manual migration only or No migration. For a virtual machine to be highly available, it must be possible for the Manager to migrate the virtual machine to other available hosts as necessary.
|
Priority for Run/Migration queue
|
Sets the priority level for the virtual machine to be migrated or restarted on another host.
|
Watchdog
|
Allows users to attach a watchdog card to a virtual machine. A watchdog is a timer that is used to automatically detect and recover from failures. Once set, a watchdog timer continually counts down to zero while the system is in operation, and is periodically restarted by the system to prevent it from reaching zero. If the timer reaches zero, it signifies that the system has been unable to reset the timer and is therefore experiencing a failure. Corrective actions are then taken to address the failure. This functionality is especially useful for servers that demand high availability.
Watchdog Model: The model of watchdog card to assign to the virtual machine. At current, the only supported model is i6300esb.
Watchdog Action: The action to take if the watchdog timer reaches zero. The following actions are available:
|
9.5.7. Virtual Machine Resource Allocation Settings Explained
Table 9.10. Virtual Machine: Resource Allocation Settings
Field Name
|
Sub-element
|
Description
|
---|---|---|
CPU Allocation
|
CPU Shares
|
Allows users the set the level of CPU resources a virtual machine can demand relative to other virtual machines.
|
CPU Pinning topology
|
Enables the virtual machine's virtual CPU (vCPU) to run on a specific physical CPU (pCPU) in a specific host. This option is not supported if the virtual machine's cluster compatibility version is set to 3.0. The syntax of CPU pinning is
v#p[_v#p] , for example:
In order to pin a virtual machine to a host, you must select Do not allow migration under Migration Options, and select the
Use Host CPU check box.
| |
Memory Allocation
| The amount of physical memory guaranteed for this virtual machine. | |
Storage Allocation
|
The Template Provisioning option is only available when the virtual machine is created from a template.
| |
Thin
|
Provides optimized usage of storage capacity. Disk space is allocated only as it is required.
| |
Clone
|
Optimized for the speed of guest read and write operations. All disk space requested in the template is allocated at the time of the clone operation.
| |
VirtIO-SCSI Enabled
|
Allows users to enable or disable the use of VirtIO-SCSI on the virtual machines.
|
9.5.8. Virtual Machine Boot Options Settings Explained
Table 9.11. Virtual Machine: Boot Options Settings
Field Name
|
Description
|
---|---|
First Device
|
After installing a new virtual machine, the new virtual machine must go into Boot mode before powering up. Select the first device that the virtual machine must try to boot:
|
Second Device
|
Select the second device for the virtual machine to use to boot if the first device is not available. The first device selected in the previous option does not appear in the options.
|
Attach CD
|
If you have selected CD-ROM as a boot device, tick this check box and select a CD-ROM image from the drop-down menu. The images must be available in the ISO domain.
|
9.5.9. Virtual Machine Custom Properties Settings Explained
Table 9.12. Virtual Machine: Custom Properties Settings
Field Name
|
Description
|
Recommendations and Limitations
|
---|---|---|
sap_agent
|
Enables SAP monitoring on the virtual machine. Set to true or false.
|
-
|
sndbuf
|
Enter the size of the buffer for sending the virtual machine's outgoing data over the socket. Default value is 0.
|
-
|
vhost
|
Disables vhost-net, which is the kernel-based virtio network driver on virtual network interface cards attached to the virtual machine. To disable vhost, the format for this property is:
LogicalNetworkName: falseThis will explicitly start the virtual machine without the vhost-net setting on the virtual NIC attached to LogicalNetworkName. |
vhost-net provides better performance than virtio-net, and if it is present, it is enabled on all virtual machine NICs by default. Disabling this property makes it easier to isolate and diagnose performance issues, or to debug vhost-net errors, for example if migration fails for virtual machines on which vhost does not exist.
|
viodiskcache
|
Caching mode for the virtio disk. writethrough writes data to the cache and the disk in parallel, writeback does not copy modifications from the cache to the disk, and none disables caching.
|
For Red Hat Enterprise Virtualization 3.1, if viodiskcache is enabled, the virtual machine cannot be live migrated.
|
Warning
9.6. Configuring Virtual Machines
9.6.1. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard Disks
Before you can use your newly created virtual machine, the Guide Me window prompts you to configure at least one network interface and one virtual disk for the virtual machine.
Procedure 9.4. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard Disks
- On the New Virtual Machine - Guide Me window, click the Configure Network Interfaces button to open the New Network Interface window. You can accept the default values or change them as necessary.
Figure 9.4. New Network Interface window
Enter the Name of the network interface. - Use the drop-down menus to select the Network and the Type of network interface for the new virtual machine. The Link State is set to Up by default when the NIC is defined on the virtual machine and connected to the network.
Note
The options on the Network and Type fields are populated by the networks available to the cluster, and the NICs available to the virtual machine. - If applicable, select the Specify custom MAC address check box and enter the network interface's MAC address.
- Click the arrow next to Advanced Parameters to configure the Port Mirroring and Card Status fields, if necessary.
- Click OK to close the New Network Interface window and open the New Virtual Machine - Guide Me window.
- Click the Configure Virtual Disk button to open the New Virtual Disk window.
- Add either an Internal virtual disk or an External LUN to the virtual machine.
Figure 9.5. New Virtual Disk Window
- Click OK to close the New Virtual Disk window. The New Virtual Machine - Guide Me window opens with changed context. There is no further mandatory configuration.
- Click Configure Later to close the window.
You have added a network interface and a virtual disk to your virtual machine.
9.6.2. Installing Windows on VirtIO-Optimized Hardware
The virtio-win.vfd
diskette image contains Windows drivers for VirtIO-optimized disk and network devices. These drivers provide a performance improvement over emulated device drivers.
virtio-win.vfd
is placed automatically on ISO storage domains that are hosted on the Manager server. It must be manually uploaded using the engine-iso-uploader tool to other ISO storage domains.
Red Hat VirtIO
network interface and a disk that uses the VirtIO
interface to your virtual machine.
Procedure 9.5. Installing VirtIO Drivers during Windows Installation
- Click the Virtual Machines tab and select a virtual machine.
- Click the Run Once button, and the Run Once window displays.
- Click Boot Options to expand the Boot Options configuration options.
- Click the Attach Floppy check box, and select
virtio-win.vfd
from the drop down selection box. - Click the Attach CD check box, and select from the drop down selection box the ISO containing the version of Windows you want to install.
- Move CD-ROM UP in the Boot Sequence field.
- Configure the rest of your Run Once options as required, and click OK to start your virtual machine, and then click the Console button to open a graphical console to your virtual machine.
Windows installations include an option to load additional drivers early in the installation process. Use this option to load drivers from the virtio-win.vfd
diskette that was attached to your virtual machine as A:
.
9.6.3. Virtual Machine Run Once Settings Explained
Table 9.13. Virtual Machine: Run Once Settings
Field Name
|
Description
|
---|---|
Boot Options
|
Defines the virtual machine's boot sequence, running options, and source images for installing the operating system and required drivers.
|
Linux Boot Options
|
The following options boot a Linux kernel directly instead of through the BIOS bootloader.
|
Initial Run
|
Allows you to specify whether Cloud-Init or Sysprep will be used to initialize the virtual machine. The Use Cloud-Init check box is the only main option in the Initial Run section; the following rows outline the settings for configuring this feature.
Authentication
Networks
Custom Script
|
Host
|
Defines the virtual machine's host.
|
Display Protocol
|
Defines the protocol to connect to virtual machines.
|
Custom Properties
|
Additional VDSM options for running virtual machines.
|
9.6.4. Configuring a Watchdog
9.6.4.1. Adding a Watchdog Card to a Virtual Machine
Add a watchdog card to a virtual machine.
Procedure 9.6. Adding a Watchdog Card to a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click Edit to open the Edit Virtual Machine window.
- Click Show Advanced Options to display all tabs and click the High Availability tab.
- From the Watchdog Model drop-down menu, select the watchdog model to use.
- From the Watchdog Action drop-down menu, select the action that the virtual machine will take when the watchdog is triggered.
- Click OK.
You have added a watchdog card to the virtual machine.
9.6.4.2. Configuring a Watchdog
To activate a watchdog card attached to a virtual machine, you must install the watchdog package on that virtual machine and start the watchdog
service.
Procedure 9.7. Configuring a Watchdog
- Log on to the virtual machine on which the watchdog card is attached.
- Run the following command to install the watchdog package and dependencies:
# yum install watchdog
- Edit the
/etc/watchdog.conf
file and uncomment the following line:watchdog-device = /dev/watchdog
- Save the changes.
- Run the following commands to start the
watchdog
service and ensure this service starts on boot:# service watchdog start # chkconfig watchdog on
You have configured the watchdog
service on a virtual machine.
9.6.4.3. Confirming Watchdog Functionality
Confirm that a watchdog card has been attached to a virtual machine and that the watchdog
service is active.
Warning
Procedure 9.8. Confirming Watchdog Functionality
- Log on to the virtual machine on which the watchdog card is attached.
- Run the following command to confirm that the watchdog card has been identified by the virtual machine:
# lspci | grep watchdog -i
- Run one of the following commands to confirm that the watchdog is active:
- Run the following command to trigger a kernel panic:
# echo c > /proc/sysrq-trigger
- Run the following command to terminate the
watchdog
service:# kill -9 `pgrep watchdog`
The watchdog timer can no longer be reset, so the watchdog counter reaches zero after a short period of time. When the watchdog counter reaches zero, the action specified in the Watchdog Action drop-down menu for that virtual machine is performed.
9.6.4.4. Parameters for Watchdogs in watchdog.conf
watchdog
service available in the /etc/watchdog.conf
file. To configure an option, you must ensure that option is uncommented and restart the watchdog
service after saving the changes.
Note
watchdog
service and using the watchdog
command, see the watchdog
man page.
Table 9.14. watchdog.conf variables
Variable name | Default Value | Remarks |
---|---|---|
ping | N/A | An IP address that the watchdog will attempt to ping to verify whether that address is reachable. You can specify multiple IP addresses by adding additional ping lines. |
interface | N/A | A network interface that the watchdog will monitor to verify the presence of network traffic. You can specify multiple network interfaces by adding additional interface lines. |
file | /var/log/messages | A file on the local system that the watchdog will monitor for changes. You can specify multiple files by adding additional file lines. |
change | 1407 | The number of watchdog intervals after which the watchdog checks for changes to files. A change line must be specified on the line directly after each file line, and applies to the file line directly above that change line. |
max-load-1 | 24 | The maximum average load that the virtual machine can sustain over a one-minute period. If this average is exceeded, the watchdog will be triggered. A value of 0 disables this feature. |
max-load-5 | 18 | The maximum average load that the virtual machine can sustain over a five-minute period. If this average is exceeded, the watchdog will be triggered. A value of 0 disables this feature. By default, the value of this variable is set to a value approximately three quarters that of max-load-1 . |
max-load-15 | 12 | The maximum average load that the virtual machine can sustain over a fifteen-minute period. If this average is exceeded, the watchdog will be triggered. A value of 0 disables this feature. By default, the value of this variable is set to a value approximately one half that of max-load-1 . |
min-memory | 1 | The minimum amount of virtual memory that must remain free on the virtual machine. This value is measured in pages. A value of 0 disables this feature. |
repair-binary | /usr/sbin/repair | The path and file name of a binary file on the local system that will be run when the watchdog is triggered. If the specified file resolves the issues preventing the watchdog from resetting the watchdog counter, the watchdog action will not be triggered. |
test-binary | N/A | The path and file name of a binary file on the local system that the watchdog will attempt to run during each interval. A test binary allows you to specify a file for running user-defined tests. |
test-timeout | N/A | The time limit, in seconds, for which user-defined tests can run. A value of 0 allows user-defined tests to continue for an unlimited duration. |
temperature-device | N/A | The path to and name of a device for checking the temperature of the machine on which the watchdog service is running. |
max-temperature | 120 | The maximum allowed temperature for the machine on which the watchdog service is running. The machine will be halted if this temperature is reached. Unit conversion is not taken into account, so you must specify a value that matches the watchdog card being used. |
admin | root | The email address to which email notifications will be sent. |
interval | 10 | The interval, in seconds, between updates to the watchdog device. The watchdog device expects an update at least once every minute, and if there are no updates over a one-minute period, the watchdog will be triggered. This one-minute period is hard-coded into the drivers for the watchdog device, and cannot be configured. |
logtick | 1 | When verbose logging is enabled for the watchdog service, the watchdog service periodically writes log messages to the local system. The logtick value represents the number of watchdog intervals after which a message is written. |
realtime | yes | Specifies whether the watchdog is locked in memory. A value of yes locks the watchdog in memory so that it is not swapped out of memory, while a value of no allows the watchdog to be swapped out of memory. If the watchdog is swapped out of memory and is not swapped back in before the watchdog counter reaches zero, the watchdog will be triggered. |
priority | 1 | The schedule priority when the value of realtime is set to yes . |
pidfile | /var/run/syslogd.pid | The path and file name of a PID file that the watchdog will monitor to see if the corresponding process is still active. If the corresponding process is not active, the watchdog will be triggered. |
9.7. Editing Virtual Machines
9.7.1. Editing Virtual Machine Properties
Changes to storage, operating system or networking parameters can adversely affect the virtual machine. Ensure that you have the correct details before attempting to make any changes. Virtual machines must be powered off before some changes can be made to them. This procedure explains how to edit a virtual machine. It is necessary to edit virtual machines when you want to change the settings of the virtual machine.
- Name
- Description
- Comment
- Delete Protection
- Network Interfaces
- Use Cloud-Init/Sysprep (and its properties)
- Use custom migration downtime
- Highly Available
- Priority for Run/Migration queue
- Watchdog Model
- Watchdog Action
- Physical Memory Guaranteed
- Memory Balloon Device Enabled
- VirtIO-SCSI Enabled
- First Device
- Second Device
- Attach CD
- kernel path
- initrd path
- kernel parameters
Procedure 9.9. Editing a virtual machine:
- Select the virtual machine to be edited. Click the Edit button to open the Edit Virtual Machine window.
- Change the General, System, Initial Run, Console, Host, High Availability, Resource Allocation, Boot Options, and Custom Options fields as required.
- Click OK to save your changes. Your changes will be applied once you restart your virtual machine.
You have changed the settings of a virtual machine by editing it.
9.7.2. Network Interfaces
9.7.2.1. Adding and Editing Virtual Machine Network Interfaces
You can add network interfaces to virtual machines. Doing so allows you to put your virtual machine on multiple logical networks. You can also edit a virtual machine's network interface card to change the details of that network interface card. This procedure can be performed on virtual machines that are running, but some actions can be performed only on virtual machines that are not running.
Procedure 9.10. Adding Network Interfaces to Virtual Machines
- Click the Virtual Machines tab and select a virtual machine.
- Select the Network Interfaces tab in the details pane to display a list of network interfaces that are currently associated with the virtual machine.
- Click New to open the New Network Interface window.
Figure 9.6. New Network Interface window
- Enter the Name of the network interface.
- Use the drop-down menus to select the Profile and the Type of network interface for the new network interface.The Link State is set to Up by default when the network interface card is defined on the virtual machine and connected to the network.
Note
The Profile and Type fields are populated in accordance with the profiles and network types available to the cluster and the network interface cards available to the virtual machine. - Select the Custom MAC address check box and enter a MAC address for the network interface card as required.
- Click OK to close the New Network Interface window.
Your new network interface is listed in the Network Interfaces tab in the details pane of the virtual machine.
9.7.2.2. Editing a Network Interface
This procedure describes editing a network interface. In order to change any network settings, you must edit the network interface.
Procedure 9.11. Editing a Network Interface
- Click the Virtual Machines tab and select a virtual machine.
- Click the Network Interfaces tab of the details pane and select the network interface to edit.
- Click Edit to open the Edit Network Interface window. This dialog contains the same fields as the New Network Interface dialog.
- After you have made the required changes, click OK to save your changes.
You have now changed the network interface by editing it.
9.7.2.3. Removing a Network Interface
This procedure describes how to remove a network interface.
Procedure 9.12. Removing a Network Interface
- Click the Virtual Machines tab and select a virtual machine.
- Click the Network Interfaces tab of the details pane and select the network interface to remove.
- Click Remove and click OK when prompted.
You have removed a network interface from a virtual machine.
9.7.2.4. Explanation of Settings in the Virtual Machine Network Interface Window
Table 9.15. Add a network interface to a virtual machine entries
Field Name
|
Description
|
---|---|
Name
|
The name of the network interface. This text field has a 21-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
Network
|
Logical network that the network interface is placed on. By default, all network interfaces are put on the rhevm management network.
|
Link State
|
Whether or not the network interface is connected to the logical network.
|
Type
|
The virtual interface the network interface presents to virtual machines. VirtIO is faster but requires VirtIO drivers. Red Hat Enterprise Linux 5 and higher includes VirtIO drivers. Windows does not include VirtIO drivers, but they can be installed from the guest tools ISO or virtual floppy disk. rtl8139 and e1000 device drivers are included in most operating systems.
|
Specify custom MAC address
|
Choose this option to set a custom MAC address. The Red Hat Enterprise Virtualization Manager automatically generates a MAC address that is unique to the environment to identify the network interface. Having two devices with the same MAC address online in the same network causes networking conflicts.
|
Port Mirroring
|
A security feature that allows all network traffic going to or leaving from virtual machines on a given logical network and host to be copied (mirrored) to the network interface. If the host also uses the network, then traffic going to or leaving from the host is also copied.
Port mirroring only works on network interfaces with IPv4 IP addresses.
|
Card Status
|
Whether or not the network interface is defined on the virtual machine.
|
9.7.2.5. Hot Plugging Network Interfaces
You can hot plug network interfaces. Hot plugging means enabling and disabling network interfaces while a virtual machine is running.
Procedure 9.13. Hot plugging network interfaces
- Click the Virtual Machines tab and select a virtual machine.
- Select the Network Interfaces tab from the details pane of the virtual machine.
- Select the network interface you would like to hot plug and click Edit to open the Edit Network Interface window.
- Click the Advanced Parameters arrow to access the Card Status option. Set the Card Status to Plugged to enable the network interface, or set it to Unplugged to disable the network interface.
You have enabled or disabled a virtual network interface.
9.7.2.6. Removing Network Interfaces From Virtual Machines
You can remove network interfaces from virtual machines.
Procedure 9.14. Removing Network Interfaces From Virtual Machines
- Click the Virtual Machines tab and select a virtual machine.
- Select the Network Interfaces tab in the virtual machine details pane.
- Select the network interface to remove.
- Click the Remove button and click OK when prompted.
The network interface is no longer attached to the virtual machine.
9.7.3. Virtual Disks
9.7.3.1. Adding and Editing Virtual Machine Disks
It is possible to add disks to virtual machines. You can add new disks, or previously created floating disks to a virtual machine. This allows you to provide additional space to and share disks between virtual machines. You can also edit disks to change some of their details.
Procedure 9.15. Adding Disks to Virtual Machines
- Click the Virtual Machines tab and select a virtual machine.
- Click the Disks tab in the details pane to display a list of virtual disks currently associated with the virtual machine.
- Click Add to open the Add Virtual Disk window.
Figure 9.7. Add Virtual Disk Window
- Use the appropriate radio buttons to switch between Internal and the External (Direct Lun) disks.
- Select the Attach Disk check box to choose an existing disk from the list and select the Activate check box.Alternatively, enter the Size, Alias, and Description of a new disk and use the drop-down menus and check boxes to configure the disk.
- Click OK to add the disk and close the window.
Your new disk is listed in the Virtual Disks tab in the details pane of the virtual machine.
9.7.3.2. Hot Plugging Virtual Machine Disks
You can hot plug virtual machine disks. Hot plugging means enabling or disabling devices while a virtual machine is running.
Procedure 9.16. Hot Plugging Virtual Machine Disks
- Click the Virtual Machines tab and select a virtual machine.
- Select the Disks tab from the details pane of the virtual machine.
- Select the virtual machine disk you would like to hot plug.
- Click the Activate button, or click the Deactivate button and click OK when prompted.
You have enabled or disabled a virtual machine disk.
9.7.3.3. Removing Virtual Disks From Virtual Machines
You can remove virtual disks from virtual machines.
Procedure 9.17. Removing Virtual Disks From Virtual Machines
- Click the Virtual Machines tab and select a virtual machine.
- Select the Disks tab in the virtual machine details pane.
- Select the virtual disk to remove.
- Click the Deactivate button and click OK when prompted.
- Click the Remove button and click OK when prompted. Optionally, select the Remove Permanently option to completely remove the virtual disk from the environment. If you do not select this option - for example, because the disk is a shared disk - the virtual disk will remain in the Disks resource tab.
The disk is no longer attached to the virtual machine.
9.7.4. Extending the Size of an Online Virtual Disk
This procedure explains how to extend the size of a virtual drive while the virtual drive is attached to a virtual machine.
Procedure 9.18. Extending the Size of an Online Virtual Disk
- Click the Virtual Machines tab and select a virtual machine.
- Select the Disks tab in the details pane.
- Select a target disk from the list in the details pane.
- Click the Edit button in the details pane.
- Enter a value in the
Extend size by(GB)
field. - Click OK button.
The target disk's status becomes locked
for a short time, during which the drive is resized. When the resizing of the drive is complete, the status of the drive becomes OK
.
9.7.5. Floating Disks
9.7.6. Associating a Virtual Disk with a Virtual Machine
This procedure explains how to associate a virtual disk with a virtual machine. Once the virtual disk is associated with the virtual machine, the virtual machine is able to access it.
Procedure 9.19. Associating a Virtual Disk with a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- In the details pane, select the Disks tab.
- Click Add in the menu at the top of the Details Pane.
- Type the size in GB of the disk into the Size(GB) field.
- Type the disk alias into the Alias field.
- Click OK in the bottom right corner of the Add Virtual Disk window.
- The disk you have associated with the virtual machine appears in the details pane after a short time.
The virtual disk is associated with the virtual machine.
Note
Note
9.7.7. Changing the CD for a Virtual Machine
You can change the CD accessible to a virtual machine while that virtual machine is running.
Note
Procedure 9.20. Changing the CD for a Virtual Machine
- From the Virtual Machines tab, select a virtual machine that is currently running.
- Click the Change CD button to open the Change CD window.
Figure 9.8. The Change CD Window
- From the drop-down menu, select
[Eject]
to eject the CD currently accessible to the virtual machine, or select an ISO file from the list to eject the CD currently accessible to the virtual machine and mount that ISO file as a CD. - Click OK.
You have ejected the CD previously accessible to the virtual machine, or ejected the CD previously accessible to the virtual machine and made a new CD accessible to that virtual machine
9.7.8. Smart card Authentication
9.7.9. Enabling and Disabling Smart cards
The following procedure explains how to enable and disable the Smart card feature for virtual machines.
Procedure 9.21. Enabling and Disabling Smart cards
- Ensure that the Smart card hardware is plugged into the client machine and is installed according to manufacturer's directions.
- Select the desired virtual machine, and click the Edit button. The Edit Virtual Machine window will appear.
- Select the Console tab, and tick the check box labeled Smartcard enabled, then click Ok.
- Run the virtual machine by clicking the Console icon or through the User Portal; Smart card authentication is now passed from the client hardware to the virtual machine.
- To disable Smart card authentication, return to the Edit Virtual Machine window and untick the Smartcard enabled check box.
You can now enable and disable Smart card authentication on virtual machines.
Important
9.8. Running Virtual Machines
9.8.1. Installing Console Components
9.8.1.1. Console Components
9.8.1.2. Installing Remote Viewer on Linux
Red Hat Enterprise Linux Workstation (v. 6 for x86_64)
channel.
Procedure 9.22. Installing Remote Viewer on Linux
- Run the following command to install the spice-xpi package and dependencies:
# yum install spice-xpi
- Run the following command to check whether the virt-viewer package has already been installed on your system:
# rpm -q virt-viewer virt-viewer-0.5.2-18.el6_4.2.x86_64
If the virt-viewer package has not been installed, run the following command to install the package and its dependencies:# yum install virt-viewer
- Restart Firefox for your changes to take effect.
- The SPICE plug-in is now installed. You can now connect to your virtual machines using the SPICE protocol.
9.8.1.3. Installing Remote Viewer for Internet Explorer on Windows
The SPICE ActiveX component is required to run Remote Viewer, which opens a graphical console to virtual machines. Remote Viewer is a SPICE client installed together with the SPICE ActiveX component; both are provided in the SpiceX.cab
file.
Procedure 9.23. Installing Remote Viewer for Internet Explorer on Windows
- Open Internet Explorer and log in to the User Portal.
- Start a virtual machine and attempt to connect to the virtual machine using the Browser Client console option.
- Click the warning banner and click Install This Add-on when prompted.
- Click Install when prompted.
- Restart Internet Explorer for your changes to take effect.
You have installed the SPICE plug-in and Remote Viewer, and can now connect to virtual machines using the SPICE protocol from within Internet Explorer.
9.8.1.4. Installing Remote Viewer on Windows
Procedure 9.24. Installing Remote Viewer on Windows
- Open a web browser and download one of the following installers according to the architecture of your system.
- Virt Viewer for 32-bit Windows:
https://[your manager's address]/ovirt-engine/services/files/spice/virt-viewer-x86.msi
- Virt Viewer for 64-bit Windows:
https://[your manager's address]/ovirt-engine/services/files/spice/virt-viewer-x64.msi
- Open the folder where the file was saved.
- Double-click the file.
- Click Run if prompted by a security warning.
- Click Yes if prompted by User Account Control.
Remote Viewer is installed and can be accessed via Remote Viewer in the VirtViewer folder of All Programs in the start menu.
9.8.2. Guest Drivers and Agents
9.8.2.1. Installing Guest Agents and Drivers
- Installing the agents and drivers on Red Hat Enterprise Linux guests
- All of the drivers are included in the base channel for RHN registered Red Hat Enterprise Linux virtual machines. They can be installed using the
yum install rhevm-guest-agent
command.Your guest must be subscribed to theRed Hat Enterprise Virt Agent
channel to install the agents.In Red Hat Enterprise Linux 5, this channel is labeledrhel-x86_64-rhev-agent-5-server
. In Red Hat Enterprise Linux 6, the channel is labeledrhel-x86_64-rhev-agent-6-server
. - Installing the agents and drivers on Windows guests
- The agents and drivers are installed on Windows virtual machines using the
rhev-tools-setup.iso
disk image. The guest tools ISO is distributed using the Red Hat Network asrhev-guest-tools-iso.rpm
, an RPM file installed on the Red Hat Enterprise Virtualization Manager.After installing the Manager, the guest tools ISO can be found at/usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
. When setting up the Manager, if you have created a local storage share for an ISO storage domain, the ISO file is automatically copied to the ISO storage domain. In this case the ISO image is automatically attached to Windows guests when they are created. Otherwise, the ISO must be manually attached to Windows guests for the tools and agents to be installed.Updated versions of the ISO file must be manually attached to running Windows virtual machines to install updated versions of the tools and drivers. If the APT service is enabled on virtual machines, the updated ISO files will be automatically attached.
9.8.2.2. Automating Guest Additions on Windows Guests with Red Hat Enterprise Virtualization Application Provisioning Tool(APT)
9.8.2.3. Red Hat Enterprise Virtualization Guest Drivers and Guest Agents
Table 9.16. Red Hat Enterprise Virtualization Guest Drivers
Driver
|
Description
|
Works on
|
---|---|---|
virtio-net
|
Paravirtualized network driver provides enhanced performance over emulated devices like rtl.
|
Server and Desktop.
|
virtio-block
|
Paravirtualized HDD driver offers increased I/O performance over emulated devices like IDE by optimizing the coordination and communication between the guest and the hypervisor. The driver complements the software implementation of the virtio-device used by the host to play the role of a hardware device.
|
Server and Desktop.
|
virtio-scsi
|
Paravirtualized iSCSI HDD driver offers similar functionality to the virtio-block device, with some additional enhancements. In particular, this driver supports adding hundreds of devices, and names devices using the standard SCSI device naming scheme.
|
Server and Desktop.
|
virtio-serial
|
Virtio-serial provides support for multiple serial ports. The improved performance is used for fast communication between the guest and the host that avoids network complications. This fast communication is required for the guest agents and for other features such as clipboard copy-paste between the guest and the host and logging.
|
Server and Desktop.
|
virtio-balloon
|
Virtio-balloon is used to control the amount of memory a guest actually accesses. It offers improved memory over-commitment. The balloon drivers are installed for future compatibility but not used by default in Red Hat Enterprise Virtualization 3.1 or higher.
|
Server and Desktop.
|
qxl
|
A paravirtualized display driver reduces CPU usage on the host and provides better performance through reduced network bandwidth on most workloads.
|
Server and Desktop.
|
Table 9.17. Red Hat Enterprise Virtualization Guest Agents and Tools
Guest agent/tool
|
Description
|
Works on
|
---|---|---|
rhevm-guest-agent
|
Allows the Red Hat Enterprise Virtualization Manager to receive guest internal events and information such as IP address and installed applications. Also allows the Manager to execute specific commands, such as shut down or reboot, on a guest.
On Red Hat Enterprise Linux 6 and higher guests, the rhevm-guest-agent installs tuned on your virtual machine and configures it to use an optimized, virtualized-guest profile.
|
Server and Desktop.
|
spice-agent
|
The SPICE agent supports multiple monitors and is responsible for client-mouse-mode support to provide a better user experience and improved responsiveness than the QEMU emulation. Cursor capture is not needed in client-mouse-mode. The SPICE agent reduces bandwidth usage when used over a wide area network by reducing the display level, including color depth, disabling wallpaper, font smoothing, and animation. The SPICE agent enables clipboard support allowing cut and paste operations for both text and images between client and guest, and automatic guest display setting according to client-side settings. On Windows guests, the SPICE agent consists of vdservice and vdagent.
|
Server and Desktop.
|
rhev-sso
|
An agent that enables users to automatically log in to their virtual machines based on the credentials used to access the Red Hat Enterprise Virtualization Manager.
|
Desktop.
|
rhev-usb
|
A component that contains drivers and services for Legacy USB support (version 3.0 and earlier) on guests. It is needed for accessing a USB device that is plugged into the client machine.
RHEV-USB Client is needed on the client side.
|
Desktop.
|
9.8.2.4. Subscribing to Channels
9.8.2.4.1. Subscribing to Channels Using Subscription Manager
To install packages signed by Red Hat you must register the target system to Red Hat Network. You can then use an entitlement from your entitlement pool to subscribe the system to channels.
Procedure 9.25. Subscribing to Channels Using Subscription Manager
- Run the
subscription-manager
command to register the system with Red Hat Network. To complete registration successfully you will need to supply your Red Hat Network Username and Password when prompted.register
# subscription-manager register
Identify available entitlement pools
To subscribe the system to channels, you must locate the identifiers for the relevant entitlement pools. Use thelist
action of thesubscription-manager
to find these.For example, to identify available subscription pools forRed Hat Enterprise Virtualization
use the command:# subscription-manager list --available | grep -A8 "Red Hat Enterprise Virtualization"
Subscribe system to entitlement pools
Using the pool identifiers located in the previous step, subscribe the system to the required entitlements. When a system is subscribed to an entitlement pool, the system is automatically subscribed to the channels in the entitlement. The main channel is automatically enabled, other channels in the entitlement must be enabled manually. Use thesubscribe
action of thesubscription-manager
command, replacing POOLID with one of the pool identifiers each time the command is run:# subscription-manager subscribe --pool=POOLID
Enable additional subscription channels
When a system is subscribed to an entitlement with a main channel and some additional channel, only the main channel is enabled by default. Other channels are available, but disabled. The additional channels must be enabled using theyum-config-manager
command as theroot
user:# yum-config-manager --enable CHANNEL
The system is now registered with Red Hat Network and subscribed to the channels required.
9.8.2.4.2. Subscribing to Channels Using RHN Classic
To install packages you must first register the target system to Red Hat Network and subscribe to the software channels containing your packages.
Procedure 9.26. Subscribing to the channels using RHN Classic
- Run the
rhn_register
command to register the system with Red Hat Network. To complete registration successfully you will need to supply your Red Hat Network user name and password. Follow the on-screen prompts to complete registration of the system.# rhn_register
Subscribe to Required Channels
You must subscribe the system to the required channels using either the web interface to Red Hat Network or the command linerhn-channel
command.Using the
rhn-channel
CommandRun therhn-channel
command to subscribe the system to each of the required channels. The commands which need to be run are:# rhn-channel --add --channel=CHANNEL
Important
If you are not the administrator for the machine as defined in Red Hat Network, or the machine is not registered to Red Hat Network, then use of therhn-channel
command will result in an error:Error communicating with server. The message was: Error Class Code: 37 Error Class Info: You are not allowed to perform administrative tasks on this system. Explanation: An error has occurred while processing your request. If this problem persists please enter a bug report at bugzilla.redhat.com. If you choose to submit the bug report, please be sure to include details of what you were trying to do when this error occurred and details on how to reproduce this problem.
If you encounter this error when usingrhn-channel
then to add the channel to the system you must use the web user interface.Using the Web Interface to Red Hat Network
To add a channel subscription to a system from the web interface:- Log on to Red Hat Network (http://rhn.redhat.com).
- Move the mouse cursor over the Subscriptions link at the top of the screen, and then click the Registered Systems link in the menu that appears.
- Select the system to which you are adding channels from the list presented on the screen, by clicking the name of the system.
- Click Alter Channel Subscriptions in the Subscribed Channels section of the screen.
- Select the channels to be added from the list presented on the screen.
- Click the Change Subscription button to finalize the change.
The system is now registered with Red Hat Network and subscribed to the channels required.
9.8.3. Accessing Virtual machines
9.8.3.1. Starting a Virtual Machine
You can start a virtual machine from the Administration Portal.
Procedure 9.27. Starting a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine with a status of
Down
. - Click the run button.Alternatively, right-click the virtual machine and select Run.
The Status of the virtual machine changes to Up
, and the console protocol of the selected virtual machine is displayed. If the guest agent is installed on the virtual machine, the IP address of that virtual machine is also displayed.
9.8.3.2. Opening a Console to a Virtual Machine
Open a console to a virtual machine.
Procedure 9.28. Logging in to a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click the console button or right-click the virtual machine and select Console.
Figure 9.9. Connection Icon on the Virtual Machine Menu
- If Remote Viewer is installed, a console window will automatically open for the virtual machine.
You have opened a console to a virtual machine from the Administration Portal.
Note
console.vv
. You can then manually use Remote Viewer to open this file, or you can use a text editor to open the file and retrieve the connection information that file contains. This information can then be used to open a console to the virtual machine using a VNC client.
9.8.3.3. Shutting Down a Virtual Machine
If the guest agent is installed on a virtual machine or that virtual machine supports Advanced Configuration and Power Interface (ACPI), you can shut that virtual machine down from within the Administration Portal.
Procedure 9.29. Shutting Down a Virtual Machine
- Click the Virtual Machines tab and select a running virtual machine.
- Click the shut down ( ) button.Alternatively, right-click the virtual machine and select Shutdown.
The virtual machine shuts down gracefully and the Status of the virtual machine changes to Down
.
9.8.3.4. Pausing a Virtual Machine
If the guest agent is installed on a virtual machine or that virtual machine supports Advanced Configuration and Power Interface (ACPI), you can pause that virtual machine from within the Administration Portal. This is equal to placing that virtual machine into Hibernate mode.
Procedure 9.30. Pausing a Virtual Machine
- Click the Virtual Machines tab and select a running virtual machine.
- Click the Suspend ( ) button.Alternatively, right-click the virtual machine and select Suspend.
The Status of the virtual machine changes to Paused
.
9.8.3.5. Rebooting a Virtual Machine
If the guest agent is installed on a virtual machine, you can reboot that virtual machine from within the Administration Portal.
Procedure 9.31. Rebooting a Virtual Machine
- Click the Virtual Machines tab and select a running virtual machine.
- Click the Reboot ( ) button.Alternatively, right-click the virtual machine and select Reboot.
- Click OK in the Reboot Virtual Machine(s) confirmation window.
The Status of the virtual machine changes to Reboot In Progress
before returning to Up
.
9.9. Removing Virtual Machines
9.9.1. Removing a Virtual Machine
Remove a virtual machine from the Red Hat Enterprise Virtualization environment.
Important
Procedure 9.32. Removing a Virtual Machine
- Click the Virtual Machines tab and select the virtual machine to remove.
- Click the Remove button to open the Remove Virtual Machine(s) window.
- Optionally, select the Remove Disk(s) check box to remove the virtual disks attached to the virtual machine together with the virtual machine. If the Remove Disk(s) check box is cleared, the virtual disks will remain in the environment as floating disks.
- Click OK.
The virtual machine is removed from the environment and is no longer listed in the Virtual Machines resource tab. If you selected the Remove Disk(s) check box, the virtual disks attached to the virtual machine are also removed.
9.10. Virtual Machines and Permissions
9.10.1. Managing System Permissions for a Virtual Machine
- Create, edit, and remove virtual machines.
- Run, suspend, shutdown, and stop virtual machines.
Note
9.10.2. Virtual Machines Administrator Roles Explained
The table below describes the administrator roles and privileges applicable to virtual machine administration.
Table 9.18. Red Hat Enterprise Virtualization System Administrator Roles
Role | Privileges | Notes |
---|---|---|
DataCenterAdmin | Data Center Administrator | Possesses administrative permissions for all objects underneath a specific data center except for storage. |
ClusterAdmin | Cluster Administrator | Possesses administrative permissions for all objects underneath a specific cluster. |
NetworkAdmin | Network Administrator | Possesses administrative permissions for all operations on a specific logical network. Can configure and manage networks attached to virtual machines. To configure port mirroring on a virtual machine network, apply the NetworkAdmin role on the network and the UserVmManager role on the virtual machine. |
9.10.3. Virtual Machine User Roles Explained
The table below describes the user roles and privileges applicable to virtual machine users. These roles allow access to the User Portal for managing and accessing virtual machines, but they do not confer any permissions for the Administration Portal.
Table 9.19. Red Hat Enterprise Virtualization System User Roles
Role | Privileges | Notes |
---|---|---|
UserRole | Can access and use virtual machines and pools. | Can log in to the User Portal and use virtual machines and pools. |
PowerUserRole | Can create and manage virtual machines and templates. | Apply this role to a user for the whole environment with the Configure window, or for specific data centers or clusters. For example, if a PowerUserRole is applied on a data center level, the PowerUser can create virtual machines and templates in the data center. Having a PowerUserRole is equivalent to having the VmCreator, DiskCreator, and TemplateCreator roles. |
UserVmManager | System administrator of a virtual machine. | Can manage virtual machines, create and use snapshots, and migrate virtual machines. A user who creates a virtual machine in the User Portal is automatically assigned the UserVmManager role on the machine. |
UserTemplateBasedVm | Limited privileges to only use Templates. | Level of privilege to create a virtual machine by means of a template. |
VmCreator | Can create virtual machines in the User Portal. | This role is not applied to a specific virtual machine; apply this role to a user for the whole environment with the Configure window. When applying this role to a cluster, you must also apply the DiskCreator role on an entire data center, or on specific storage domains. |
NetworkUser | Logical network and network interface user for virtual machines. | If the Allow all users to use this Network option was selected when a logical network is created, NetworkUser permissions are assigned to all users for the logical network. Users can then attach or detach virtual machine network interfaces to or from the logical network. |
9.10.4. Assigning Virtual Machines to Users
- A User can connect to and use virtual machines. This role is suitable for desktop end users performing day-to-day tasks.
- A PowerUser can create virtual machines and view virtual resources. This role is suitable if you are an administrator or manager who needs to provide virtual resources for your employees.
- A UserVmManager can edit and remove virtual machines, assign user permissions, use snapshots and use templates. It is suitable if you need to make configuration changes to your virtual environment.
This procedure explains how to add permissions to users.
Procedure 9.33. Assigning Permissions to Users
- Click the Virtual Machines tab and select a virtual machine.
- On the details pane, select the Permissions tab.
- Click New. The Add Permission to User dialog displays. Enter a Name, or User Name, or part thereof in the Search text box, and click Go. A list of possible matches display in the results list.
- Select the check box of the user to be assigned the permissions. Scroll through the Role to Assign list and select UserRole. Click OK.
- The user's name and role display in the list of users permitted to access this virtual machine.
You have added permissions to a user.
Note
9.10.5. Removing Access to Virtual Machines from Users
This procedure explains how to remove user permissions.
Procedure 9.34. Removing Access to Virtual Machines from Users
- Click the Virtual Machines tab and select a virtual machine.
- On the details pane, select the Permissions tab.
- Click Remove. A warning message displays, asking you to confirm removal of the selected permissions.
- To proceed, click OK. To abort, click Cancel.
You have now removed permissions from a user.
9.11. Snapshots
9.11.1. Creating a Snapshot of a Virtual Machine
A snapshot is a view of a virtual machine's operating system and applications on any or all available disks at a given point in time. Take a snapshot of a virtual machine before you make a change to it that may have unintended consequences. You can use a snapshot to return a virtual machine to a previous state.
Note
Procedure 9.35. Creating a Snapshot of a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click Create Snapshot to open the Create Snapshot window.
Figure 9.10. Create snapshot
- Enter a description for the snapshot.
- Select Disks to include using the check boxes.
- Use the Save Memory check box to denote whether you wish to include the virtual machine's memory in the snapshot.
- Click OK to create the snapshot and close the window.
The virtual machine's operating system and applications on the selected disk/s are stored in a snapshot that can be previewed or restored. The snapshot is created with a status of Locked
, which changes to Ok
. When you click on the snapshot, its details are shown on the General, Disks, Network Interfaces, and Installed Applications tabs in the right side-pane of the details pane.
9.11.2. Using a Snapshot to Restore a Virtual Machine
A snapshot can be used to restore a virtual machine to its previous state.
Procedure 9.36. Using a snapshot to restore a virtual machine
- Click the Virtual Machines tab and select a virtual machine.
- Click the Snapshots tab in the details pane to list the available snapshots.
- Select a snapshot to restore in the left side-pane. The snapshot details display in the right side-pane.
- Click the drop down beside Preview to open the Custom Preview Snapshot window.
Figure 9.11. Custom preview snapshot
- Use the check boxes to select the VM Configuration, Memory, and Disk/s you wish to restore, then click OK. This allows you to create and restore from a customized snapshot using the configuration and disk/s from multiple snapshots.
Figure 9.12. Custom preview snapshot
The status of the snapshot will change toPreview Mode
. The status of the virtual machine briefly changes toImage Locked
before returning toDown
. - Start the virtual machine and it will run with the disk image of the snapshot.
- Click Commit to permanently restore the virtual machine to the condition of the snapshot. Any subsequent snapshots are erased.Alternatively, click the Undo button to deactivate the snapshot and return the virtual machine to its previous state.
The virtual machine is restored to its state at the time of the snapshot, or returned to its state before the preview of the snapshot.
9.11.3. Creating a Virtual Machine from a Snapshot
You have created a snapshot from a virtual machine. Now you can use that snapshot to create another virtual machine.
Procedure 9.37. Creating a virtual machine from a snapshot
- Click the Virtual Machines tab and select a virtual machine.
- Click the Snapshots tab in the details pane to list the available snapshots for the virtual machines.
- Select a snapshot in the list displayed and click Clone to open the Clone VM from Snapshot window.
- Enter the Name and Description of the virtual machine to be created.
Figure 9.13. Clone a Virtual Machine from a Snapshot
- Click OK to create the virtual machine and close the window.
After a short time, the cloned virtual machine appears in the Virtual Machines tab in the navigation pane. It appears in the navigation pane with a status of Image Locked
. The virtual machine will remain in this state until Red Hat Enterprise Virtualization completes the creation of the virtual machine. A virtual machine with a preallocated 20GB hard drive takes about fifteen minutes to create. Sparsely-allocated virtual disks take less time to create than do preallocated virtual disks.
Image Locked
to Down
in the Virtual Machines tab in the navigation pane.
9.11.4. Deleting a Snapshot
Important
- If the snapshot being deleted is contained in a RAW (preallocated) base image, a new volume is created that is the same size as the base image.
- If the snapshot being deleted is contained in a QCOW2 (thin provisioned) base image, the volume subsequent to the volume containing the snapshot being deleted is extended to the cumulative size of the successor volume and the base volume.
- If the snapshot being deleted is contained in a QCOW2 (thin provisioned) internal, non-base image, the successor volume is extended to the cumulative size of the successor volume and the volume containing the snapshot being deleted.
Procedure 9.38. Deleting a Snapshot
- Click the Virtual Machines tab and select a virtual machine.
- Click the Snapshots tab in the details pane to list the snapshots for that virtual machine.
Figure 9.14. Snapshot List
- Select the snapshot to delete.
- In the results list, shut down the running virtual machine associated with the snapshot to be deleted.
- Click Delete to open the Delete Snapshot confirmation window.
- Click OK.
9.12. Affinity Groups
9.12.1. Introduction to Virtual Machine Affinity
Note
9.12.2. Creating an Affinity Group
You can create new affinity groups for applying affinity policies to virtual machines.
Procedure 9.39. Creating an Affinity Group
- Click the Virtual Machines tab and select a virtual machine.
- Click the Affinity Groups tab in the details pane.
- Click the New button to open the New Affinity Group window.
- Enter a name and description for the affinity group in the Name text field and Description text field.
- Select the Positive check box to apply positive affinity, or ensure this check box is cleared to apply negative affinity.
- Select the Enforcing check box to apply hard enforcement, or ensure this check box is cleared to apply soft enforcement.
- Use the drop-down menu to select the virtual machines to be added to the affinity group. Use the + and - buttons to add or remove additional virtual machines.
- Click OK.
You have created a virtual machine affinity group and specified the parameters and conditions to be applied to the virtual machines that are members of that group.
9.12.3. Editing an Affinity Group
You can edit the settings of existing affinity groups.
Procedure 9.40. Editing an Affinity Group
- Click the Virtual Machines tab and select a virtual machine.
- Click the Affinity Groups tab in the details pane.
- Click the Edit button to open the Edit Affinity Group window.
- Change the Positive and Enforcing check boxes to the preferred values and use the + and - buttons to add or remove virtual machines to or from the affinity group.
- Click OK.
You have edited an affinity group.
9.12.4. Removing an Affinity Group
You can remove an existing affinity group.
Procedure 9.41. Removing an Affinity Group
- Click the Virtual Machines tab and select a virtual machine.
- Click the Affinity Groups tab in the details pane.
- Click the Remove button and click OK when prompted to remove the affinity group.
You have removed an affinity group, and the affinity policy that applied to the virtual machines that were members of that affinity group no longer applies.
9.13. Importing and Exporting Virtual Machines
9.13.1. Exporting and Importing Virtual Machines and Templates
- Export the virtual machine or template to an export domain.
- Detach the export domain from one data center, and attach it to another. You can attach it to a different data center in the same Red Hat Enterprise Virtualization environment, or attach it to a data center in a separate Red Hat Enterprise Virtualization environment that is managed by another installation of the Red Hat Enterprise Virtualization Manager.
- Import the virtual machine or template into the data center to which the export domain is attached.
Note
9.13.2. Overview of the Export and Import Process
Note
- An export domain exists, and is attached to the source data center.
- The virtual machine is shut down.
- If the virtual machine was created based on a template, that template must reside on the destination data center or be exported with the virtual machine.
9.13.3. Exporting and Importing Virtual Machines and Templates
This procedure provides a graphical overview of the steps required to export a virtual machine or template from one data center and import that virtual machine or template into another data center.
Procedure 9.42. Exporting and Importing Virtual Machines and Templates
- Attach the export domain to the source data center.
Figure 9.15. Attach Export Domain
- Export the virtual machine or template to the export domain.
Figure 9.16. Export the Virtual Resource
- Detach the export domain from the source data center.
Figure 9.17. Detach Export Domain
- Attach the export domain to the destination data center.
Figure 9.18. Attach the Export Domain
- Import the virtual machine or template into the destination data center.
Figure 9.19. Import the virtual resource
The virtual machine or template is imported to the destination data center.
9.13.4. Exporting a Virtual Machine to the Export Domain
Export a virtual machine to the export domain so that it can be imported into a different data center. Before you begin, the export domain must be attached to the data center that contains the virtual machine to be exported.
Procedure 9.43. Exporting a Virtual Machine to the Export Domain
- Click the Virtual Machines tab and select a virtual machine.
- Click Export to open the Export Virtual Machine window.
- Select the Force Override check box to override existing images of the virtual machine on the export domain.Select the Collapse Snapshots check box to create a single export volume per disk. Selecting this option will remove snapshot restore points and include the template in a template-based virtual machine. This removes any dependencies a virtual machine has on a template.
- Click OK to export the virtual machine and close the window.
The export of the virtual machine begins. The virtual machine displays in the Virtual Machines list with an Image Locked
status as it is exported. Depending on the size of your virtual machine hard disk images, and your storage hardware, this can take up to an hour. Use the Events tab to view the progress.
9.13.5. Importing a Virtual Machine into the Destination Data Center
You have a virtual machine on an export domain. Before the virtual machine can be imported to a new data center, the export domain must be attached to the destination data center.
Procedure 9.44. Importing a Virtual Machine into the Destination Data Center
- Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list. The export domain must have a status of
Active
- Select the VM Import tab in the details pane to list the available virtual machines to import.
- Select one or more virtual machines to import and click Import to open the Import Virtual Machine(s) window.
Figure 9.20. Import Virtual Machine
- Use the drop-down menus to select the Default Storage Domain and Cluster.
- Select the Collapse Snapshots check box to remove snapshot restore points and include templates in template-based virtual machines.
- Click the virtual machine to be imported and click on the Disks sub-tab. From this tab, you can use the Allocation Policy and Storage Domain drop-down lists to select whether the disk used by the virtual machine will be thinly provisioned or preallocated, and can also select the storage domain on which the disk will be stored. An icon is also displayed to indicate which of the disks to be imported acts as the boot disk for that virtual machine.
- Click OK to import the virtual machines.The Import Conflict window opens if the virtual machine exists in the virtualized environment.
Figure 9.21. Import Conflict Window
- Choose one of the following radio buttons:
- Don't import
- Clone and enter a unique name for the virtual machine in the New Name field.
Or select the Apply to all check box to import all duplicated virtual machines with the same suffix. - Click OK to import the virtual machines and close the window.
Important
You have imported the virtual machine to the destination data center. This may take some time to complete.
9.14. Migrating Virtual Machines Between Hosts
9.14.1. What is Live Migration?
9.14.2. Live Migration Prerequisites
- The source and destination host must both be members of the same cluster, ensuring CPU compatibility between them.
- The source and destination host must have a status of
Up
. - The source and destination host must have access to the same virtual networks and VLANs.
- The source and destination host must have access to the data storage domain on which the virtual machine resides.
- There must be enough CPU capacity on the destination host to support the virtual machine's requirements.
- There must be enough RAM on the destination host that is not in use to support the virtual machine's requirements.
- The migrating virtual machine must not have the
cache!=none
custom property set.
9.14.3. Automatic Virtual Machine Migration
9.14.4. Preventing Automatic Migration of a Virtual Machine
Red Hat Enterprise Virtualization Manager allows you to disable automatic migration of virtual machines. You can also disable manual migration of virtual machines by setting the virtual machine to run only on a specific host.
Procedure 9.45. Preventing automatic migration of a virtual machine
- Click the Virtual Machines tab and select a virtual machine.
- Click Edit to open the Edit Virtual Machine window.
Figure 9.22. Edit Virtual Machine Window
- Click the Host tab.
- Use the Run On radio buttons to designate the virtual machine to run on Any Host in Cluster or a Specific host. If applicable, select a specific host from the drop-down menu.
Warning
Explicitly assigning a virtual machine to a specific host and disabling migration is mutually exclusive with Red Hat Enterprise Virtualization high availability. Virtual machines that are assigned to a specific host can only be made highly available using third party high availability products like Red Hat High Availability. - Use the drop-down menu to affect the Migration Options. Select Do not allow migration to enable the Use Host CPU check box.
- If applicable, enter relevant CPU Pinning topology commands in the text field.
- Click OK to save the changes and close the window.
You have changed the migration settings for the virtual machine.
9.14.5. Manually Migrating Virtual Machines
A running virtual machine can be migrated to any host within its designated host cluster. This is especially useful if the load on a particular host is too high. When bringing a server down for maintenance, migration is triggered automatically, so manual migration is not required. Migration of virtual machines does not cause any service interruption.
cache!=none
custom property set.
Procedure 9.46. Manually Migrating Virtual Machines
- Click the Virtual Machines tab and select a running virtual machine.Click Migrate to open the Migrate Virtual Machine(s) window.
- Use the radio buttons to select whether to Select Host Automatically or to Select Destination Host, specifying the host using the drop-down menu.
Note
Virtual Machines migrate within their designated host cluster. When the Select Host Automatically option is selected, the system determines the host to which the virtual is migrated according to the load balancing and power management rules set up in the cluster policy. - Click OK to commence migration and close the window.
The virtual machine is migrated. Once migration is complete the Host column will update to display the host the virtual machine has been migrated to.
9.14.6. Setting Migration Priority
Red Hat Enterprise Virtualization Manager queues concurrent requests for migration of virtual machines off of a given host. Every minute the load balancing process runs. Hosts already involved in a migration event are not included in the migration cycle until their migration event has completed. When there is a migration request in the queue and available hosts in the cluster to action it, a migration event is triggered in line with the load balancing policy for the cluster.
Procedure 9.47. Setting Migration Priority
- Click the Virtual Machines tab and select a virtual machine.
- Click Edit to open the Edit Virtual Machine window.
- Select the High Availability tab.
- Use the radio buttons to set the Priority for Run/Migrate Queue of the virtual machine to one of Low, Medium, or High.
- Click OK to save changes and close the window.
The virtual machine's migration priority has been modified.
9.14.7. Canceling Ongoing Virtual Machine Migrations
A virtual machine migration is taking longer than you expected. You'd like to be sure where all virtual machines are running before you make any changes to your environment.
Procedure 9.48. Canceling Ongoing Virtual Machine Migrations
- Select the migrating virtual machine. It is displayed in the Virtual Machines resource tab with a status of Migrating from.
- Click the Cancel Migration button at the top of the results list. Alternatively, right-click on the virtual machine and select Cancel Migration from the context menu.
The virtual machine status returns from Migrating from status to Up status.
9.14.8. Event and Log Notification upon Automatic Migration of Highly Available Virtual Servers
Example 9.1. Notification in the Events Tab of the Web Admin Portal
Example 9.2. Notification in the Manager engine.log
/var/log/ovirt-engine/engine.log
:
9.15. Improving Uptime with Virtual Machine High Availability
9.15.1. Why Use High Availability?
- When a host becomes non-operational due to hardware failure.
- When a host is put into maintenance mode for scheduled downtime.
- When a host becomes unavailable because it has lost communication with an external storage resource.
9.15.2. What is High Availability?
9.15.3. High Availability Considerations
- Power management must be configured for the hosts running the highly available virtual machines.
- The host running the highly available virtual machine must be part of a cluster which has other available hosts.
- The destination host must be running.
- The source and destination host must have access to the data domain on which the virtual machine resides.
- The source and destination host must have access to the same virtual networks and VLANs.
- There must be enough CPUs on the destination host that are not in use to support the virtual machine's requirements.
- There must be enough RAM on the destination host that is not in use to support the virtual machine's requirements.
9.15.4. Configuring a Highly Available Virtual Machine
High availability must be configured individually for each virtual machine.
Procedure 9.49. Configuring a Highly Available Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click Edit to open the Edit Virtual Machine window.
- Click the High Availability tab.
Figure 9.23. Set virtual machine high availability
- Select the Highly Available check box to enable high availability for the virtual machine.
- Use the radio buttons to set the Priority for Run/Migrate Queue of the virtual machine to one of Low, Medium, or High. When migration is triggered, a queue is created in which the high priority virtual machines are migrated first. If a cluster is running low on resources, only the high priority virtual machines are migrated.
- Click OK.
You have configured high availability for a virtual machine. You can check if a virtual machine is highly available by selecting the virtual machine and clicking on the General tab in the details pane.
9.16. Other Virtual Machine Tasks
9.16.1. Enabling SAP monitoring for a virtual machine from the Administration Portal
Enable SAP monitoring on a virtual machine to be recognized by SAP monitoring systems.
Procedure 9.50. Enabling SAP monitoring for a Virtual Machine from the Administration Portal
- Click the Virtual Machines tab and select a virtual machine.
- Click Edit button to open the Edit Virtual Machine window.
- Select the Custom Properties tab.
Figure 9.24. Enable SAP
- Use the drop-down menu to select
sap_agent
. Ensure the secondary drop-down menu is set to True.If previous properties have been set, select the plus sign to add a new property rule and selectsap_agent
. - Click OK to save changes and close the window.
You have enabled SAP monitoring for your virtual machine.
9.16.2. Configuring Red Hat Enterprise Linux 5.4 or Higher Virtual Machines to use SPICE
9.16.2.1. Using SPICE on virtual machines running versions of Red Hat Enterprise Linux released prior to 5.4
Note
9.16.2.2. Installing qxl drivers on virtual machines
This procedure installs qxl drivers on virtual machines running Red Hat Enterprise Linux 5.4 or higher.
Procedure 9.51. Installing qxl drivers on a virtual machine
- Log in to a Red Hat Enterprise Linux virtual machine.
- Open a terminal.
- Run the following command as root:
#
yum install xorg-x11-drv-qxl
The qxl drivers have been installed and must now be configured.
9.16.2.3. Configuring qxl drivers on virtual machines
You can configure qxl drivers using either a graphical interface or the command line. Perform only one of the following procedures.
Procedure 9.52. Configuring qxl drivers in GNOME
- Click System.
- Click Administration.
- Click Display.
- Click the Hardware tab.
- Click Video Cards Configure.
- Select qxl and click OK.
- Restart X-Windows by logging out of the virtual machine and logging back in.
Procedure 9.53. Configuring qxl drivers on the command line:
- Back up
/etc/X11/xorg.conf
:#
cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup
- Make the following change to the Device section of
/etc/X11/xorg.conf
:Section "Device" Identifier "Videocard0" Driver "qxl" Endsection
You have configured qxl drivers to enable your virtual machine to use SPICE.
9.16.2.4. Configuring a virtual machine's tablet and mouse to use SPICE
Edit the /etc/X11/xorg.conf
file to enable SPICE for your virtual machine's tablet devices.
Procedure 9.54. Configuring a virtual machine's tablet and mouse to use SPICE
- Verify that the tablet device is available on your guest:
#
If there is no output from the command, do not continue configuring the tablet./sbin/lsusb -v | grep 'QEMU USB Tablet'
- Back up
/etc/X11/xorg.conf
by running this command:#
cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup
- Make the following changes to /etc/X11/xorg.conf:
Section "ServerLayout" Identifier "single head configuration" Screen 0 "Screen0" 0 0 InputDevice "Keyboard0" "CoreKeyboard" InputDevice "Tablet" "SendCoreEvents" InputDevice "Mouse" "CorePointer" EndSection Section "InputDevice" Identifier "Mouse" Driver "void" #Option "Device" "/dev/input/mice" #Option "Emulate3Buttons" "yes" EndSection Section "InputDevice" Identifier "Tablet" Driver "evdev" Option "Device" "/dev/input/event2" Option "CorePointer" "true" EndSection
- Log out and log back into the virtual machine to restart X-Windows.
You have enabled a tablet and a mouse device on your virtual machine to use SPICE.
9.16.3. KVM virtual machine timing management
pvclock
provides a stable source of timing for KVM guests that support it.
- Clocks can fall out of synchronization with the actual time which invalidates sessions and affects networks.
- Virtual machines with slower clocks may have issues migrating.
Important
ntpd
service:
# service ntpd start
# chkconfig ntpd on
ntpd
service should minimize the affects of clock skew in all cases.
Your CPU has a constant Time Stamp Counter if the constant_tsc
flag is present. To determine if your CPU has the constant_tsc
flag run the following command:
$ cat /proc/cpuinfo | grep constant_tsc
constant_tsc
bit. If no output is given follow the instructions below.
Systems without constant time stamp counters require additional configuration. Power management features interfere with accurate time keeping and must be disabled for virtual machines to accurately keep time with KVM.
Important
constant_tsc
bit, disable all power management features (BZ#513138). Each system has several timers it uses to keep time. The TSC is not stable on the host, which is sometimes caused by cpufreq
changes, deep C state, or migration to a host with a faster TSC. Deep C sleep states can stop the TSC. To prevent the kernel using deep C states append "processor.max_cstate=1
" to the kernel boot options in the grub.conf
file on the host:
term Red Hat Enterprise Linux Server (2.6.18-159.el5)
root (hd0,0)
kernel /vmlinuz-2.6.18-159.el5 ro root=/dev/VolGroup00/LogVol00 rhgb quiet processor.max_cstate=1
cpufreq
(only necessary on hosts without the constant_tsc
) by editing the /etc/sysconfig/cpuspeed
configuration file and change the MIN_SPEED
and MAX_SPEED
variables to the highest frequency available. Valid limits can be found in the /sys/devices/system/cpu/cpu*/cpufreq/scaling_available_frequencies
files.
engine-config
tool to receive alerts when hosts drift out of sync.
You can use the engine-config
tool to configure alerts when your hosts drift out of sync.
EnableHostTimeDrift
and HostTimeDriftInSec
. EnableHostTimeDrift
, with a default value of false, can be enabled to receive alert notifications of host time drift. The HostTimeDriftInSec
parameter is used to set the maximum allowable drift before alerts start being sent.
For certain Red Hat Enterprise Linux virtual machines, additional kernel parameters are required. These parameters can be set by appending them to the end of the /kernel line in the /boot/grub/grub.conf file of the virtual machine.
Note
ktune
package
ktune
package provides an interactive Bourne shell script, fix_clock_drift.sh
. When run as the superuser, this script inspects various system parameters to determine if the virtual machine on which it is run is susceptible to clock drift under load. If so, it then creates a new grub.conf.kvm
file in the /boot/grub/
directory. This file contains a kernel boot line with additional kernel parameters that allow the kernel to account for and prevent significant clock drift on the KVM virtual machine. After running fix_clock_drift.sh
as the superuser, and once the script has created the grub.conf.kvm
file, then the virtual machine's current grub.conf
file should be backed up manually by the system administrator, the new grub.conf.kvm
file should be manually inspected to ensure that it is identical to grub.conf
with the exception of the additional boot line parameters, the grub.conf.kvm
file should finally be renamed grub.conf
, and the virtual machine should be rebooted.
Red Hat Enterprise Linux | Additional virtual machine kernel parameters |
---|---|
5.4 AMD64/Intel 64 with the paravirtualized clock | Additional parameters are not required |
5.4 AMD64/Intel 64 without the paravirtualized clock | notsc lpj=n |
5.4 x86 with the paravirtualized clock | Additional parameters are not required |
5.4 x86 without the paravirtualized clock | clocksource=acpi_pm lpj=n |
5.3 AMD64/Intel 64 | notsc |
5.3 x86 | clocksource=acpi_pm |
4.8 AMD64/Intel 64 | notsc |
4.8 x86 | clock=pmtmr |
3.9 AMD64/Intel 64 | Additional parameters are not required |
3.9 x86 | Additional parameters are not required |
Windows uses the both the Real-Time Clock (RTC) and the Time Stamp Counter (TSC). For Windows virtual machines the Real-Time Clock can be used instead of the TSC for all time sources which resolves virtual machine timing issues.
boot.ini
file:
/use pmtimer
9.16.4. Monitoring Virtual Machine Login Activity Using the Sessions Tab
Figure 9.25. Virtual machines sessions tab
Chapter 10. Templates
10.1. Introduction to Templates
Note
10.2. Template Tasks
10.2.1. Creating a Template
Create a template from an existing virtual machine to use as a blueprint for creating additional virtual machines.
Procedure 10.1. Creating a Template from an Existing Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Ensure the virtual machine is powered down and has a status of
Down
. - Click Make Template to open the New Template window.
Figure 10.1. The New Template window
- Enter a Name, Description and Comment for the template.
- From the Cluster drop-down menu, select the cluster with which the template will be associated. By default, this will be the same as that of the source virtual machine.
- Optionally, select the Create as a Sub Template version check box, select a Root Template and enter a Sub Version Name to create the new template as a sub template of an existing template.
- In the Disks Allocation section, enter an alias for the disk in the Alias text field and select the storage domain on which the disk will be stored from the Target drop-down list. By default, these will be the same as those of the source virtual machine.
- The Allow all users to access this Template check box is selected by default. This makes the template public.
- The Copy VM permissions check box is not selected by default. Select this check box to copy the permissions of the source virtual machine to the template.
- Click OK.
The virtual machine displays a status of Image Locked
while the template is being created. The process of creating a template may take up to an hour depending on the size of the virtual machine disk and your storage hardware. When complete, the template is added to the Templates tab. You can now create new virtual machines based on the template.
Note
10.2.2. Explanation of Settings and Controls in the New Template Window
Table 10.1. New Template and Edit Template Settings
Field
|
Description/Action
|
---|---|
Name
|
The name of the template. This is the name by which the template is listed in the Templates tab in the Administration Portal and is accessed via the REST API. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
Description
|
A description of the template. This field is recommended but not mandatory.
|
Comment
|
A field for adding plain text, human-readable comments regarding the template.
|
Cluster
|
The cluster with which the template will be associated. This is the same as the original virtual machines by default. You can select any cluster in the data center.
|
Create as a Sub Template version
|
Allows you to specify whether the template will be created as a new version of an existing template. Select this check box to access the settings for configuring this option.
|
Disks Allocation
|
Alias - An alias for the virtual machine disk used by the template. By default, the alias is set to the same value as that of the source virtual machine.
Virtual Size - The current actual size of the virtual disk used by the template. This value cannot be edited, and is provided for reference only.
Target - The storage domain on which the virtual disk used by the template will be stored. By default, the storage domain is set to the same value as that of the source virtual machine. You can select any storage domain in the cluster.
|
Allow all users to access this Template
|
Allows you to specify whether a template is public or private. A public template can be accessed by all users, whereas a private template can only be accessed by users with the TemplateAdmin or SuperUser roles.
|
Copy VM permissions
|
Allows you to copy explicit permissions that have been set on the source virtual machine to the template.
|
10.2.3. Editing a Template
Once a template has been created, its properties can be edited. Because a template is a copy of a virtual machine, the options available when editing a template are identical to those in the Edit Virtual Machine window.
Procedure 10.2. Editing a Template
- Use the Templates resource tab, tree mode, or the search function to find and select the template in the results list.
- Click Edit to open the Edit Template window.
- Change the necessary properties and click OK.
The properties of the template are updated. The Edit Template window will not close if a property field is invalid.
10.2.4. Deleting a Template
Delete a template from your Red Hat Enterprise Virtualization environment.
Warning
Procedure 10.3. Deleting a Template
- Use the resource tabs, tree mode, or the search function to find and select the template in the results list.
- Click Remove to open the Remove Template(s) window.
- Click OK to remove the template.
You have removed the template.
10.2.5. Exporting Templates
10.2.5.1. Migrating Templates to the Export Domain
Export templates into the export domain to move them to another data domain, either in the same Red Hat Enterprise Virtualization environment, or another one.
Procedure 10.4. Exporting Individual Templates to the Export Domain
- Use the Templates resource tab, tree mode, or the search function to find and select the template in the results list.
- Click Export to open the Export Template window.
Note
Select the Force Override check box to replace any earlier version of the template on the export domain. - Click OK to begin exporting the template; this may take up to an hour, depending on the virtual machine disk image size and your storage hardware.
- Repeat these steps until the export domain contains all the templates to migrate before you start the import process.Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list and click the Template Import tab in the details pane to view all exported templates in the export domain.
The templates have been exported to the export domain.
10.2.5.2. Copying a Template's Virtual Hard Disk
If you are moving a virtual machine that was created from a template with the thin provisioning storage allocation option selected, the template's disks must be copied to the same storage domain as that of the virtual machine disk.
Procedure 10.5. Copying a Virtual Hard Disk
- Select the Disks tab.
- Select the template disk or disks to copy.
- Click the Copy button to display the Copy Disk window.
- Use the drop-down menu or menus to select the Target data domain.
A copy of the template's virtual hard disk has been created, either on the same, or a different, storage domain. If you were copying a template disk in preparation for moving a virtual hard disk, you can now move the virtual hard disk.
10.2.6. Importing Templates
10.2.6.1. Importing a Template into a Data Center
Import templates from a newly attached export domain.
Procedure 10.6. Importing a Template into a Data Center
- Use the resource tabs, tree mode, or the search function to find and select the newly attached export domain in the results list.
- Select the Template Import tab of the details pane to display the templates that migrated across with the export domain.
- Select a template and click Import to open the Import Template(s) window.
- Select the templates to import.
- Use the drop-down menus to select the Destination Cluster and Storage domain. Alter the Suffix if applicable.Alternatively, clear the Clone All Templates check box.
- Click OK to import templates and open a notification window. Click Close to close the notification window.
The template is imported into the destination data center. This can take up to an hour, depending on your storage hardware. You can view the import progress in the Events tab.
10.2.6.2. Importing a Virtual Disk Image from an OpenStack Image Service as a Template
Virtual disk images managed by an OpenStack Image Service can be imported into the Red Hat Enterprise Virtualization Manager if that OpenStack Image Service has been added to the Manager as an external provider.
- Click the Storage resource tab and select the OpenStack Image Service domain from the results list.
- Select the image to import in the Images tab of the details pane.
- Click Import to open the Import Image(s) window.
Figure 10.2. The Import Image(s) Window
- From the Data Center drop-down menu, select the data center into which the virtual disk image will be imported.
- From the Domain Name drop-down menu, select the storage domain in which the virtual disk image will be stored.
- Optionally, select a quota from the Quota drop-down menu to apply a quota to the virtual disk image.
- Select the Import as Template check box.
- From the Cluster drop-down menu, select the cluster in which the virtual disk image will be made available as a template.
- Click OK to import the virtual disk image.
The image is imported as a template and is displayed in the results list of the Templates resource. You can now create virtual machines based on the template.
10.3. Sealing Templates in Preparation for Deployment
10.3.1. Sealing a Linux Virtual Machine Manually for Deployment as a Template
Generalize (seal) a Linux virtual machine before making it into a template. This prevents conflicts between virtual machines deployed from the template.
Procedure 10.7. Sealing a Linux Virtual Machine
- Log in to the virtual machine. Flag the system for re-configuration by running the following command as root:
# touch /.unconfigured
- Remove ssh host keys. Run:
# rm -rf /etc/ssh/ssh_host_*
- Set
HOSTNAME=localhost.localdomain
in/etc/sysconfig/network
- Remove /etc/udev/rules.d/70-*. Run:
# rm -rf /etc/udev/rules.d/70-*
- Remove the
HWADDR=
line from/etc/sysconfig/network-scripts/ifcfg-eth*
. - Optionally delete all the logs from
/var/log
and build logs from/root
. - Shut down the virtual machine. Run:
# poweroff
The virtual machine is sealed and can be made into a template. You can deploy Linux virtual machines from this template without experiencing configuration file conflicts.
10.3.2. Sealing a Linux Virtual Machine for Deployment as a Template using sys-unconfig
Generalize (seal) a Linux virtual machine using the sys-unconfig
command before making it into a template. This prevents conflicts between virtual machines deployed from the template.
Procedure 10.8. Sealing a Linux Virtual Machine using sys-unconfig
- Log in to the virtual machine.
- Remove ssh host keys. Run:
# rm -rf /etc/ssh/ssh_host_*
- Set
HOSTNAME=localhost.localdomain
in/etc/sysconfig/network
- Remove the
HWADDR=
line from/etc/sysconfig/network-scripts/ifcfg-eth*
. - Optionally delete all the logs from
/var/log
and build logs from/root
. - Run the following command:
# sys-unconfig
The virtual machine shuts down; it is now sealed and can be made into a template. You can deploy Linux virtual machines from this template without experiencing configuration file conflicts.
10.3.3. Sealing a Windows Template
10.3.3.1. Considerations when Sealing a Windows Template with Sysprep
Important
- The Windows Sysprep parameters have been correctly defined.If not, click Edit and enter the required information in the Operating System and Domain fields.
- The correct product key has been defined in an override file under
/etc/ovirt-engine/osinfo.conf.d/10-productkeys.properties
on the Manager.If not, copy the default values for your Windows operating system from/etc/ovirt-engine/osinfo.conf.d/00-defaults.properties
into the override file, and input your values in theproductKey.value
andsysprepPath.value
fields.Example 10.1. Windows 7 Default Configuration Values
# Windows7(11, OsType.Windows, false),false os.windows_7.id.value = 11 os.windows_7.name.value = Windows 7 os.windows_7.derivedFrom.value = windows_xp os.windows_7.sysprepPath.value = ${ENGINE_USR}/conf/sysprep/sysprep.w7 os.windows_7.productKey.value = os.windows_7.devices.audio.value = ich6 os.windows_7.devices.diskInterfaces.value.3.3 = IDE, VirtIO_SCSI, VirtIO os.windows_7.devices.diskInterfaces.value.3.4 = IDE, VirtIO_SCSI, VirtIO os.windows_7.devices.diskInterfaces.value.3.5 = IDE, VirtIO_SCSI, VirtIO os.windows_7.isTimezoneTypeInteger.value = false
10.3.3.2. Sealing a Windows XP Template
Seal a Windows XP template using the Sysprep tool before using the template to deploy virtual machines.
Note
Procedure 10.9. Sealing a Windows XP Template
- Download
sysprep
to the virtual machine to be used as a template.The Windows XP Sysprep tool is available at http://www.microsoft.com/download/en/details.aspx?id=11282 - Create a new directory:
c:\sysprep
. - Open the
deploy.cab
file and add its contents toc:\sysprep
. - Execute
sysprep.exe
from within the folder and click OK on the welcome message to display the Sysprep tool. - Select the following check boxes:
- Don't reset grace period for activation
- Use Mini-Setup
- Ensure that the shutdown mode is set to
Shut down
and click Reseal. - Acknowledge the pop-up window to complete the sealing process; the virtual machine shuts down automatically upon completion.
The Windows XP template is sealed and ready for deploying virtual machines.
10.3.3.3. Sealing a Windows 7 or Windows 2008 Template
Seal a Windows 7 or Windows 2008 template before using the template to deploy virtual machines.
Procedure 10.10. Sealing a Windows 7 or Windows 2008 Template
- In the virtual machine to be used as a template, open a command line terminal and type
regedit
. - The Registry Editor window opens. On the left pane, expand HKEY_LOCAL_MACHINE → SYSTEM → SETUP.
- On the main window, right-click to add a new string value using New → String Value.
- Right-click on the file and select Modify to open the Edit String window.
- Enter the following information in the provided fields:
- Value name:
UnattendFile
- Value data:
a:\sysprep.inf
- Launch Sysprep from
C:\Windows\System32\sysprep\sysprep.exe
. - Enter the following information into the Sysprep tool:
- Under System Cleanup Action, select Enter System Out-of-Box-Experience (OOBE).
- Select the Generalize check box if you need to change the computer's system identification number (SID).
- Under Shutdown Options, select Shutdown.
Click OK to complete the sealing process; the virtual machine shuts down automatically upon completion.
The Windows 7 or Windows 2008 template is sealed and ready for deploying virtual machines.
10.3.4. Using Cloud-Init to Automate the Configuration of Virtual Machines
10.3.4.1. Cloud-Init Overview
10.3.4.2. Cloud-Init Use Case Scenarios
- Virtual Machines Created Based on Templates
- You can use the Cloud-Init options in the Initial Run section of the Run Once window to initialize a virtual machine that was created based on a template. This allows you to customize the virtual machine the first time that virtual machine is started.
- Virtual Machine Templates
- You can use the Use Cloud-Init/Sysprep options in the Initial Run tab of the New Template and Edit Template windows to specify options for customizing virtual machines created based on that template.
- Virtual Machine Pools
- You can use the Use Cloud-Init/Sysprep options in the Initial Run tab of the New Pool window to specify options for customizing virtual machines taken from that virtual machine pool. This allows you to specify a set of standard settings that will be applied every time a virtual machine is taken from that virtual machine pool. You can inherit or override the options specified for the template on which the virtual machine is based, or specify options for the virtual machine pool itself.
10.3.4.3. Installing Cloud-Init
Install Cloud-Init on a virtual machine.
Procedure 10.11. Installing Cloud-Init
- Log on to the virtual machine.
- Enable the Red Hat Common channel.
- With RHN Classic:
# rhn-channel --add --channel=rhel-x86_64-server-rh-common-6
- With Subscription Manager:
# subscription-manager repos --enable=rhel-6-server-rh-common-rpms
- Install the cloud-init package and dependencies:
# yum install cloud-init
You have installed the cloud-init package and dependencies.
10.3.4.4. Using Cloud-Init to Initialize a Virtual Machine
Use Cloud-Init to automate the initial configuration of a Linux virtual machine that has been provisioned based on a template.
Procedure 10.12. Using Cloud-Init to Initialize a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click Run Once to open the Run Virtual Machine(s) window.
- Expand the Initial Run section and select the Cloud-Init check box.
- Enter a host name in the VM Hostname text field.
- Select the Configure Time Zone check box and select a time zone from the Time Zone drop-down menu.
- Select the Use already configured password check box to user the existing credentials, or clear that check box and enter a root password in the Root Password and Verify Root Password text fields to specify a new root password.
- Enter any SSH keys to be added to the authorized hosts file on the virtual machine in the SSH Authorized Keys text area.
- Select the Regenerate SSH Keys check box to regenerate SSH keys for the virtual machine.
- Enter any DNS servers in the DNS Servers text field.
- Enter any DNS search domains in the DNS Search Domains text field.
- Select the Network check box and use the + and - buttons to add or remove network interfaces to or from the virtual machine.
- Enter any custom scripts in the Custom Script text area.
- Click OK.
Important
The virtual machine boots and the specified settings are applied.
10.3.4.5. Using Cloud-Init to Prepare a Template
Use Cloud-Init to specify a set of standard settings to be included in a template.
Note
Procedure 10.13. Using Cloud-Init to Prepare a Template
- Click the Virtual Machines tab and select a virtual machine.
- Click Edit to open the Edit Virtual Machine window.
- Click the Initial Run tab and select the Use Cloud-Init/Sysprep check box.
- Enter a host name in the VM Hostname text field.
- Select the Configure Time Zone check box and select a time zone from the Time Zone drop-down menu.
- Expand the Authentication section and select the Use already configured password check box to user the existing credentials, or clear that check box and enter a root password in the Root Password and Verify Root Password text fields to specify a new root password.
- Enter any SSH keys to be added to the authorized hosts file on the virtual machine in the SSH Authorized Keys text area.
- Select the Regenerate SSH Keys check box to regenerate SSH keys for the virtual machine.
- Expand the Networks section and enter any DNS servers in the DNS Servers text field.
- Enter any DNS search domains in the DNS Search Domains text field.
- Select the Network check box and use the + and - buttons to add or remove network interfaces to or from the virtual machine.
- Expand the Custom Script section and enter any custom scripts in the Custom Script text area.
- Click Ok.
Important
The virtual machine boots and the specified settings are applied.
10.4. Templates and Permissions
10.4.1. Managing System Permissions for a Template
- Create, edit, export, and remove associated templates.
- Import and export templates.
Note
10.4.2. Template Administrator Roles Explained
The table below describes the administrator roles and privileges applicable to template administration.
Table 10.2. Red Hat Enterprise Virtualization System Administrator Roles
Role | Privileges | Notes |
---|---|---|
TemplateAdmin | Can perform all operations on templates. | Has privileges to create, delete and configure a template's storage domain and network details, and to move templates between domains. |
NetworkAdmin | Network Administrator | Can configure and manage networks attached to templates. |
10.4.3. Template User Roles Explained
The table below describes the user roles and privileges applicable to using and administrating templates in the User Portal.
Table 10.3. Red Hat Enterprise Virtualization Template User Roles
Role | Privileges | Notes |
---|---|---|
TemplateCreator | Can create, edit, manage and remove virtual machine templates within assigned resources. | The TemplateCreator role is not applied to a specific template; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers, clusters, or storage domains. |
TemplateOwner | Can edit and delete the template, assign and manage user permissions for the template. | The TemplateOwner role is automatically assigned to the user who creates a template. Other users who do not have TemplateOwner permissions on a template cannot view or use the template. |
UserTemplateBasedVm | Can use the template to create virtual machines. | Cannot edit template properties. |
NetworkUser | Logical network and network interface user for templates. | If the Allow all users to use this Network option was selected when a logical network is created, NetworkUser permissions are assigned to all users for the logical network. Users can then attach or detach template network interfaces to or from the logical network. |
10.4.4. Assigning an Administrator or User Role to a Resource
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 10.14. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click Add to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click Go. Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click OK to assign the role and close the window.
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
10.4.5. Removing an Administrator or User Role from a Resource
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 10.15. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click Remove. The Remove Permission window opens to confirm permissions removal.
- Click OK to remove the user role.
You have removed the user's role, and the associated permissions, from the resource.
Chapter 11. Pools
11.1. Introduction to Virtual Machine Pools
Note
11.2. Virtual Machine Pool Tasks
11.2.1. Creating a Virtual Machine Pool
You can create a virtual machine pool that contains multiple virtual machines that have been created based on a common template.
Procedure 11.1. Creating a Virtual Machine Pool
- Click the Pools tab.
- Click the New button to open the New Pool window.
- Use the drop down-list to select the Cluster or use the selected default.
- Use the Based on Template drop-down menu to select a template or use the selected default. If you have selected a template, optionally use the Template Sub Version drop-down menu to select a version of that template. A template provides standard settings for all the virtual machines in the pool.
- Use the Operating System drop-down list to select an Operating System or use the default provided by the template.
- Use the Optimized for drop-down list to optimize virtual machines for either Desktop use or Server use.
- Enter a Name and Description, any Comments and the Number of VMs for the pool.
- Select the Maximum number of VMs per user that a single user is allowed to run in a session. The minimum is one.
- Optionally, click the Show Advanced Options button and perform the following steps:
- Select the Console tab. At the bottom of the tab window, select the Override SPICE Proxy check box to enable the Overriden SPICE proxy address text field and specify the address of a SPICE proxy to override the global SPICE proxy, if any.
- Click the Pool tab and select a Pool Type:
- Manual - The administrator is responsible for explicitly returning the virtual machine to the pool. The virtual machine reverts to the original base image after the administrator returns it to the pool.
- Automatic - When the virtual machine is shut down, it automatically reverts to its base image and is returned to the virtual machine pool.
- Click OK.
You have created and configured a virtual machine pool with the specified number of identical virtual machines. You can view these virtual machines in the Virtual Machines resource tab, or in the details pane of the Pools resource tab; a virtual machine in a pool is distinguished from independent virtual machines by its icon.
11.2.2. Explanation of Settings and Controls in the New Pool Window
11.2.2.1. New Pool General Settings Explained
Table 11.1. General settings
Field Name
|
Description
|
---|---|
Number of VMs
|
Allows you to specify the number of virtual machines in the virtual machine pool that will be created and made available to the virtual machine pool when that virtual machine pools is created. By default, the maximum number of virtual machines you can create in a pool is 1000. This value can be configured using the
MaxVmsInPool key of the engine-config command.
|
Maximum number of VMs per user
|
Allows you to specify the maximum number of virtual machines a single user can take from the virtual machine at any one time. The value of this field must be between
1 and 32,767 .
|
11.2.2.2. New Pool Pool Settings Explained
Table 11.2. Console settings
Field Name
|
Description
|
---|---|
Pool Type
|
This drop-down menu allows you to specify the type of the virtual machine pool. The following options are available:
|
11.2.2.3. New Pool and Edit Pool Console Settings Explained
Table 11.3. Console settings
Field Name
|
Description
|
---|---|
Override SPICE proxy
|
Select this check box to enable overriding the SPICE proxy defined in global configuration. This feature is useful in a case where the user (who is, for example, connecting via the User Portal) is outside of the network where the hypervisors reside.
|
Overridden SPICE proxy address
|
The proxy which will be used by the SPICE client to connect to virtual machines. The address must be in the format of a fully qualified domain name or IP address.
|
11.2.3. Editing a Virtual Machine Pool
After a virtual machine pool has been created, its properties can be edited. The properties available when editing a virtual machine pool are identical to those available when creating a new virtual machine pool except that the Number of VMs property is replaced by Increase number of VMs in pool by.
Procedure 11.2. Editing a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click Edit to open the Edit Pool window.
- Edit the properties of the virtual machine pool.
- Click Ok.
The properties of an existing virtual machine pool have been edited.
11.2.4. Explanation of Settings and Controls in the Edit Pool Window
11.2.4.1. Edit Pool General Settings Explained
Table 11.4. General settings
Field Name
|
Description
|
---|---|
Prestarted VMs
|
Allows you to specify the number of virtual machines in the virtual machine pool that will be started before they are taken and kept in that state to be taken by users. The value of this field must be between
0 and the total number of virtual machines in the virtual machine pool.
|
Increase number of VMs in pool by
|
Allows you to increase the number of virtual machines in the virtual machine pool by the specified number.
|
Maximum number of VMs per user
|
Allows you to specify the maximum number of virtual machines a single user can take from the virtual machine at any one time. The value of this field must be between
1 and 32,767 .
|
11.2.5. Prestarting Virtual Machines in a Pool
Prestarted virtual machines are suitable for environments in which users require immediate access to virtual machines which are not specifically assigned to them. Only automatic pools can have prestarted virtual machines.
Procedure 11.3. Prestarting Virtual Machines in a Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click Edit to open the Edit Pool window.
- Enter the number of virtual machines to be prestarted in the Prestarted VMs field.
- Select the Pool tab. Ensure Pool Type is set to Automatic.
- Click OK.
You have set a number of prestarted virtual machines in a pool. The prestarted machines are running and available for use.
11.2.6. Adding Virtual Machines to a Virtual Machine Pool
If you require more virtual machines than originally provisioned in a virtual machine pool, add more machines to the pool.
Procedure 11.4. Adding Virtual Machines to a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click Edit to open the Edit Pool window.
- Enter the number of additional virtual machines to add in the Increase number of VMs in pool by field.
- Click OK.
You have added more virtual machines to the virtual machine pool.
11.2.7. Detaching Virtual Machines from a Virtual Machine Pool
You can detach virtual machines from a virtual machine pool. Detaching a virtual machine removes it from the pool to become an independent virtual machine.
Procedure 11.5. Detaching Virtual Machines from a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Ensure the virtual machine has a status of
Down
because you cannot detach a running virtual machine.Click the Virtual Machines tab in the details pane to list the virtual machines in the pool. - Select one or more virtual machines and click Detach to open the Detach Virtual Machine(s) confirmation window.
- Click OK to detach the virtual machine from the pool.
Note
You have detached a virtual machine from the virtual machine pool.
11.2.8. Removing a Virtual Machine Pool
You can remove a virtual machine pool from a data center. You must first either delete or detach all of the virtual machines in the pool. Detaching virtual machines from the pool will preserve them as independent virtual machines.
Procedure 11.6. Removing a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click Remove to open the Remove Pool(s) confirmation window.
- Click OK to remove the pool.
You have removed the pool from the data center.
11.3. Pools and Permissions
11.3.1. Managing System Permissions for a Virtual Machine Pool
- Create, edit, and remove pools.
- Add and detach virtual machines from the pool.
Note
11.3.2. Virtual Machine Pool Administrator Roles Explained
The table below describes the administrator roles and privileges applicable to pool administration.
Table 11.5. Red Hat Enterprise Virtualization System Administrator Roles
Role | Privileges | Notes |
---|---|---|
VmPoolAdmin | System Administrator role of a virtual pool. | Can create, delete, and configure a virtual pool, assign and remove virtual pool users, and perform basic operations on a virtual machine. |
ClusterAdmin | Cluster Administrator | Can use, create, delete, manage all virtual machine pools in a specific cluster. |
11.3.3. Assigning an Administrator or User Role to a Resource
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 11.7. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click Add to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click Go. Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click OK to assign the role and close the window.
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
11.3.4. Removing an Administrator or User Role from a Resource
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 11.8. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click Remove. The Remove Permission window opens to confirm permissions removal.
- Click OK to remove the user role.
You have removed the user's role, and the associated permissions, from the resource.
11.4. Trusted Compute Pools
11.4.1. Creating a Trusted Cluster
Note
This procedure explains how to set up a trusted computing pool. Trusted computing pools permit the deployment of virtual machines on trusted hosts. With the addition of attestation, administrators can ensure that verified measurement of software is running in the hosts. This provides the foundation of the secure enterprise stack.
Procedure 11.9. Creating a Trusted Cluster
- In the navigation pane, select the Clusters tab.
- Click the New button.
- In the General tab, set the cluster name.
- In the General tab, select the Enable Virt Service radio button.
- In the Cluster Policy tab, select Enable Trusted Service check box.
- Click OK.
You have built a trusted computing pool.
11.4.2. Adding a Trusted Host
This procedure explains how to add a trusted host to your Red Hat Enterprise Virtualization environment.
Procedure 11.10.
- Select the Hosts tab.
- Click the New button.
- In the General tab, set the host's name.
- In the General tab, set the host's address.
Note
The host designated here must be trusted by the attestation server. - In the General tab, in the Host Cluster drop-down menu, select a trusted cluster.
- Click OK.
You have added a trusted host to your Red Hat Enterprise Virtualization environment.
Chapter 12. Virtual Machine Disks
12.1. Understanding Virtual Machine Storage
kpartx
, vgscan
, vgchange
and mount
to investigate the virtual machine's processes or problems.
12.2. Understanding Virtual Disks
- PreallocatedA preallocated virtual disk has reserved storage of the same size as the virtual disk itself. The backing storage device (file/block device) is presented as is to the virtual machine with no additional layering in between. This results in better performance because no storage allocation is required during runtime.On SAN (iSCSI, FCP) this is achieved by creating a block device with the same size as the virtual disk. On NFS this is achieved by filling the backing hard disk image file with zeros. Preallocating storage on an NFS storage domain presumes that the backing storage is not QCOW2 formatted and zeros will not be deduplicated in the hard disk image file. (If these assumptions are incorrect, do not select Preallocated for NFS virtual disks).
- Thin ProvisionedFor sparse virtual disks backing storage is not reserved and is allocated as needed during runtime. This allows for storage overcommitment under the assumption that most disks are not fully utilized and that storage capacity can be utilized better. This requires the backing storage to monitor write requests and can cause some performance issues. On NFS backing storage is achieved by using files. On SAN this is achieved by creating a block device smaller than the virtual disk's defined size and communicating with the hypervisor to monitor necessary allocations. This does not require support from the underlying storage devices.
Table 12.1. Permitted Storage Combinations
Storage | Format | Type | Note |
---|---|---|---|
NFS or iSCSI/FCP | RAW or Qcow2 | Sparse or Preallocated | |
NFS | RAW | Preallocated | A file with an initial size which equals the amount of storage defined for the virtual disk, and has no formatting. |
NFS | RAW | Sparse | A file with an initial size which is close to zero, and has no formatting. |
NFS | Qcow2 | Sparse | A file with an initial size which is close to zero, and has RAW formatting. Subsequent layers will be Qcow2 formatted. |
SAN | RAW | Preallocated | A block device with an initial size which equals the amount of storage defined for the virtual disk, and has no formatting. |
SAN | Qcow2 | Preallocated | A block device with an initial size which equals the amount of storage defined for the virtual disk, and has Qcow2 formatting. |
SAN | Qcow2 | Sparse | A block device with an initial size which is much smaller than the size defined for the VDisk (currently 1GB), and has Qcow2 formatting for which space is allocated as needed (currently in 1GB increments). |
12.3. Shareable Disks in Red Hat Enterprise Virtualization
12.4. Read Only Disks in Red Hat Enterprise Virtualization
12.5. Virtual Disk Tasks
12.5.1. Creating Floating Virtual Disks
You can create a virtual disk that does not belong to any virtual machines. You can then attach this disk to a single virtual machine, or to multiple virtual machines if the disk is shareable.
Procedure 12.1. Creating Floating Virtual Disks
- Select the Disks resource tab.
- Click Add to open the Add Virtual Disk window.
Figure 12.1. Add Virtual Disk Window
- Use the radio buttons to specify whether the virtual disk will be an Internal or External (Direct Lun) disk.
- Enter the Size(GB), Alias, and Description of the virtual disk.
- Use the drop-down menus to select the Interface, Allocation Policy, Data Center, and Storage Domain of the virtual disk.
- Select the Wipe After Delete, Is Bootable and Is Shareable check boxes to enable each of these options.
- Click OK.
You have created a virtual disk that can be attached to one or more virtual machines depending on its settings.
12.5.2. Explanation of Settings in the New Virtual Disk Window
Table 12.2. Add Virtual Disk Settings: Internal
Field Name
|
Description
|
---|---|
Size(GB)
|
The size of the new virtual disk in GB.
|
Alias
|
The name of the virtual disk, limited to 40 characters.
|
Description
|
A description of the virtual disk. This field is recommended but not mandatory.
|
Interface
|
The virtual interface the disk presents to virtual machines. VirtIO is faster, but requires drivers. Red Hat Enterprise Linux 5 and higher include these drivers. Windows does not include these drivers, but they can be installed from the guest tools ISO or virtual floppy disk. IDE devices do not require special drivers.
|
Allocation Policy
|
The provisioning policy for the new virtual disk. Preallocated allocates the entire size of the disk on the storage domain at the time the virtual disk is created. Thin Provision allocates 1 GB at the time the virtual disk is created and sets a maximum limit on the size to which the disk can grow. Preallocated virtual disks take more time to create than thinly provisioned virtual disks, but have better read and write performance. Preallocated virtual disks are recommended for servers. Thinly provisioned disks are faster to create than preallocated disks and allow for storage over-commitment. Thinly provisioned virtual disks are recommended for desktops.
|
Data Center
|
The data center in which the virtual disk will be available.
|
Storage Domain
|
The storage domain in which the virtual disk will be stored. The drop-down list shows all storage domains available in the given cluster, and also shows the total space and currently available space in the storage domain.
|
Wipe after delete
|
Allows you to enable enhanced security for deletion of sensitive material when the virtual disk is deleted.
|
Is bootable
|
Allows you to enable the bootable flag on the virtual disk.
|
Is Shareable
|
Allows you to attach the virtual disk to more than one virtual machine at a time.
|
Read Only
|
Allows you to set the disk as read-only. The same disk can be attached as read-only to one virtual machine, and as rewritable to another.
|
Table 12.3. Add Virtual Disk Settings: External (Direct Lun)
Field Name
|
Description
|
---|---|
Alias
|
The name of the virtual disk, limited to 40 characters.
|
Description
|
A description of the virtual disk. This field is recommended but not mandatory.
|
Interface
|
The virtual interface the disk presents to virtual machines. VirtIO is faster, but requires drivers. Red Hat Enterprise Linux 5 and higher include these drivers. Windows does not include these drivers, but they can be installed from the guest tools ISO or virtual floppy disk. IDE devices do not require special drivers.
|
Data Center
|
The data center in which the virtual disk will be available.
|
Use Host
|
The host on which the LUN will be mounted. You can select any host in the data center.
|
Storage Type
|
The type of external LUN to add. You can select from either iSCSI or Fibre Channel.
|
Discover Targets
|
This section can be expanded when you are using iSCSI external LUNs and Targets > LUNs is selected.
Address - The host name or IP address of the target server.
Port - The port by which to attempt a connection to the target server. The default port is 3260.
User Authentication - The iSCSI server requires User Authentication. The User Authentication field is visible when you are using iSCSI external LUNs.
CHAP user name - The user name of a user with permission to log in to LUNs. This field is accessible when the User Authentication check box is selected.
CHAP password - The password of a user with permission to log in to LUNs. This field is accessible when the User Authentication check box is selected.
|
Is bootable
|
Allows you to enable the bootable flag on the virtual disk.
|
Is Shareable
|
Allows you to attach the virtual disk to more than one virtual machine at a time.
|
Read Only
|
Allows you to set the disk as read-only. The same disk can be attached as read-only to one virtual machine, and as rewritable to another.
|
- Live storage migration of direct LUN hard disk images is not supported.
- Direct LUN disks are not included in virtual machine exports.
- Direct LUN disks are not included in virtual machine snapshots.
12.5.3. Overview of Live Storage Migration
Important
- Live storage migration creates a snapshot.
- You can live migrate multiple disks at one time.
- Multiple disks for the same virtual machine can reside across more than one storage domain, but the image chain for each disk must reside on a single storage domain.
- You can live migrate disks only between two file-based domains (NFS, POSIX, and GlusterFS) or between two block-based domains (FCP and iSCSI).
- You cannot live migrate direct LUN hard disk images or disks marked as shareable.
12.5.4. Moving a Virtual Disk
- You can move multiple disks at the same time.
- If the virtual machine is shut down, you can move disks between any two storage domains in the same data center. If the virtual machine is running, you can move disks only between two file-based domains (NFS, POSIX, and GlusterFS) or between two block-based domains (FCP and iSCSI).
- If the virtual disk is attached to a virtual machine that was created based on a template and used the thin provisioning storage allocation option, you must copy the disks for the template on which the virtual machine was based to the same storage domain as the virtual disk.
Procedure 12.2. Moving a Virtual Disk
- Select the Disks tab.
- Select one or more virtual disks to move.
- Click Move to open the Move Disk(s) window.
- From the Target list, select the storage domain to which the virtual disk(s) will be moved.
- From the Disk Profile list, select a profile for the disk(s), if applicable.
- Click OK.
Locked
while being moved. If you moved a disk that is connected to a running virtual machine, a snapshot of that disk is created automatically, and is visible in the Snapshots tab of the details pane for that virtual machine. For information on removing the snapshot, see Section 9.11.4, “Deleting a Snapshot”.
12.5.5. Copying a Virtual Disk
You can copy a virtual disk attached to a template from one storage domain to another.
Procedure 12.3. Copying a Virtual Disk
- Select the Disks tab.
- Select the virtual disks to copy.
- Click the Copy button to open the Copy Disk(s) window.
- Use the Target drop-down menus to select the storage domain to which the virtual disk will be moved.
- Click OK.
The virtual disks are copied to the target storage domain, and have a status of Locked
while being moved.
12.5.6. Importing a Virtual Disk Image from an OpenStack Image Service
Virtual disk images managed by an OpenStack Image Service can be imported into the Red Hat Enterprise Virtualization Manager if that OpenStack Image Service has been added to the Manager as an external provider.
- Click the Storage resource tab and select the OpenStack Image Service domain from the results list.
- Select the image to import in the Images tab of the details pane.
- Click Import to open the Import Image(s) window.
- From the Data Center drop-down menu, select the data center into which the virtual disk image will be imported.
- From the Domain Name drop-down menu, select the storage domain in which the virtual disk image will be stored.
- Optionally, select a quota from the Quota drop-down menu to apply a quota to the virtual disk image.
- Click OK to import the image.
The image is imported as a floating disk and is displayed in the results list of the Disks resource tab. It can now be attached to a virtual machine.
12.5.7. Exporting a Virtual Machine Disk to an OpenStack Image Service
Virtual machine disks can be exported to an OpenStack Image Service that has been added to the Manager as an external provider.
- Click the Disks resource tab.
- Select the disks to export.
- Click the Export button to open the Export Image(s) window.
- From the Domain Name drop-down list, select the OpenStack Image Service to which the disks will be exported.
- From the Quota drop-down list, select a quota for the disks if a quota is to be applied.
- Click OK.
The virtual machine disks are exported to the specified OpenStack Image Service where they are managed as virtual machine disk images.
Important
12.6. Virtual Disks and Permissions
12.6.1. Managing System Permissions for a Virtual Disk
- Create, edit, and remove virtual disks associated with a virtual machine or other resources.
- Edit user permissions for virtual disks.
Note
12.6.2. Virtual Disk User Roles Explained
The table below describes the user roles and privileges applicable to using and administrating virtual machine disks in the User Portal.
Table 12.4. Red Hat Enterprise Virtualization System Administrator Roles
Role | Privileges | Notes |
---|---|---|
DiskOperator | Virtual disk user. | Can use, view and edit virtual disks. Inherits permissions to use the virtual machine to which the virtual disk is attached. |
DiskCreator | Can create, edit, manage and remove virtual machine disks within assigned clusters or data centers. | This role is not applied to a specific virtual disk; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers, clusters, or storage domains. |
12.6.3. Assigning an Administrator or User Role to a Resource
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 12.4. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click Add to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click Go. Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click OK to assign the role and close the window.
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
12.6.4. Removing an Administrator or User Role from a Resource
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 12.5. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click Remove. The Remove Permission window opens to confirm permissions removal.
- Click OK to remove the user role.
You have removed the user's role, and the associated permissions, from the resource.
Chapter 13. External Providers
13.1. Introduction to External Providers in Red Hat Enterprise Virtualization
- Foreman for Host Provisioning
- Foreman is a tool for managing all aspects of the life cycle of both physical and virtual hosts. In Red Hat Enterprise Virtualization, hosts managed by Foreman can be added to and used by the Red Hat Enterprise Virtualization Manager as virtualization hosts. After you add a Foreman instance to the Manager, the hosts managed by the Foreman instance can be added by searching for available hosts on that Foreman instance when adding a new host.
- OpenStack Image Service (Glance) for Image Management
- OpenStack Image Service provides a catalog of virtual machine images. In Red Hat Enterprise Virtualization, these images can be imported into the Red Hat Enterprise Virtualization Manager and used as floating disks or attached to virtual machines and converted into templates. After you add an OpenStack Image Service to the Manager, it appears as a storage domain that is not attached to any data center. Virtual machine disks in a Red Hat Enterprise Virtualization environment can also be exported to an OpenStack Image Service as virtual machine disk images.
- OpenStack Networking (Neutron) for Network Provisioning
- OpenStack Networking provides software-defined networks. In Red Hat Enterprise Virtualization, networks provided by OpenStack Networking can be imported into the Red Hat Enterprise Virtualization Manager and used to carry all types of traffic and create complicated network topologies. After you add OpenStack Networking to the Manager, you can access the networks provided by OpenStack Networking by manually importing them.
Note
13.2. Enabling the Authentication of OpenStack Providers
Before you can access the resources offered by an OpenStack provider, you must specify the location of a Keystone endpoint for that provider in the Manager to enable authentication of the resources the provider will offer.
Procedure 13.1. Configuring the Location of a Keystone Endpoint
- Log in to the system running Red Hat Enterprise Virtualization Manager as the
root
user. - Configure the location of the Keystone server, including the port number and API version:
# engine-config --set KeystoneAuthUrl=http://[address to the endpoint]:35357/v2.0
- Configure the Manager to only consider required networks for VM scheduling:
# engine-config --set OnlyRequiredNetworksMandatoryForVdsSelection=true
- Restart the engine service:
# service ovirt-engine restart
You have configured the location of a Keystone endpoint against which the credentials of OpenStack providers can be authenticated.
Note
13.3. Adding External Providers
13.3.1. Adding an External Provider
13.3.2. Adding a Foreman Instance for Host Provisioning
Add a Foreman instance for host provisioning to the Red Hat Enterprise Virtualization Manager.
Procedure 13.2. Adding a Foreman Instance for Host Provisioning
- Select the External Providers entry in the tree pane.
- Click the Add button to open the Add Provider window.
Figure 13.1. The Add Provider Window
- Enter a Name and Description.
- From the Type drop-down menu, ensure that Foreman is selected.
- Enter the URL or fully qualified domain name of the machine on which the Foreman instance is installed in the Provider URL text field. You do not need to specify a port number.
- Enter the Username and Password for the Foreman instance. You must use the same username and password as you would use to log in to the Foreman provisioning portal.
- Test the credentials:
- Click the Test button to test whether you can authenticate successfully with the Foreman instance using the provided credentials.
- If the Foreman instance uses SSL, the Import provider certificates window opens; click OK to import the certificate that the Foreman instance provides.
Important
You must import the certificate that the Foreman instance provides to ensure the Manager can communicate with the instance.
- Click OK.
You have added the Foreman instance to the Red Hat Enterprise Virtualization Manager, and can work with the hosts it provides.
13.3.3. Adding an OpenStack Networking (Neutron) Instance for Network Provisioning
Add an OpenStack Networking (Neutron) instance for network provisioning to the Red Hat Enterprise Virtualization Manager.
Procedure 13.3. Adding an OpenStack Networking (Neutron) Instance for Network Provisioning
- Select the External Providers entry in the tree pane.
- Click the Add button to open the Add Provider window.
Figure 13.2. The Add Provider Window
- Enter a Name and Description.
- From the Type drop-down menu, select OpenStack Network.
- Click the text field for Networking Plugin and select either Linux Bridge or Open vSwitch in accordance with the plugin set up in your OpenStack environment.
- Enter the URL or fully qualified domain name of the machine on which the OpenStack Networking instance is installed in the Provider URL text field, followed by the port number.
- Optionally, select the Requires Authentication check box and enter the Username, Password and Tenant Name for the OpenStack Networking instance. You must use the username and password for the OpenStack Networking user registered in Keystone, and the tenant of which the OpenStack Networking instance is a member.
- Test the credentials:
- Click the Test button to test whether you can authenticate successfully with the Neutron instance using the provided credentials.
- If the Neutron instance uses SSL, the Import provider certificates window opens; click OK to import the certificate that the Neutron instance provides.
Important
You must import the certificate that the Neutron instance provides to ensure the Manager can communicate with the instance.
- Click the Agent Configuration tab.
Figure 13.3. The Agent Configuration Tab
- Enter the URL or fully qualified domain name of the host on which the QPID server is hosted in the Host text field.
- Enter the port number by which to connect to the QPID instance. This port number will be 5762 by default if QPID is not configured to use SSL, and 5761 if QPID is configured to use SSL.
- Enter the Username and Password of the OpenStack Networking user registered in the QPID instance.
- Click OK.
You have added the OpenStack Networking instance to the Red Hat Enterprise Virtualization Manager, and can use the networks it provides.
13.3.4. Adding an OpenStack Image Service (Glance) Instance for Image Management
Add an OpenStack Image Service (Glance) instance for image management to the Red Hat Enterprise Virtualization Manager.
Procedure 13.4. Adding an OpenStack Image Service (Glance) Instance for Image Management
- Select the External Providers entry in the tree pane.
- Click the Add button to open the Add Provider window.
Figure 13.4. The Add Provider Window
- Enter a Name and Description.
- From the Type drop-down menu, select OpenStack Image.
- Enter the URL or fully qualified domain name of the machine on which the Glance instance is installed in the Provider URL text field.
- Optionally, select the Requires Authentication check box and enter the Username, Password and Tenant Name for the Glance instance. You must use the username and password for the Glance user registered in Keystone, and the tenant of which the Glance instance is a member.
- Test the credentials:
- Click the Test button to test whether you can authenticate successfully with the Glance instance using the provided credentials.
- If the Glance instance uses SSL, the Import provider certificates window opens; click OK to import the certificate that the Glance instance provides.
Important
You must import the certificate that the Glance instance provides to ensure the Manager can communicate with the instance.
- Click OK.
You have added the Glance instance to the Red Hat Enterprise Virtualization Manager, and can work with the images it provides.
13.3.5. Add Provider General Settings Explained
Table 13.1. Add Provider: General Settings
Setting
|
Explanation
|
---|---|
Name
|
A name to represent the provider in the Manager.
|
Description
|
A plain text, human-readable description of the provider.
|
Type
|
The type of the provider. Changing this setting alters the available fields for configuring the provider.
Foreman
OpenStack Image
OpenStack Network
|
Test
|
Allows users to test the specified credentials. This button is available to all provider types.
|
13.3.6. Add Provider Agent Configuration Settings Explained
Table 13.2. Add Provider: General Settings
Setting
|
Explanation
|
---|---|
Interface Mappings
|
A comma-separated list of mappings in the format of label:interface.
|
Host
|
The URL or fully qualified domain name of the machine on which the QPID instance is installed.
|
Port
|
The remote port by which a connection with the above host is to be made. By default, this port will be 5762 if SSL is not enabled on the host, and 5761 if SSL is enabled.
|
Username
|
A username for authenticating the OpenStack Networking instance with the above QPID instance. By default, this username will be
neutron
|
Password
|
The password against which the above username is to be authenticated.
|
13.4. Editing External Providers
13.4.1. Editing an External Provider
This procedure describes how to edit external providers.
Procedure 13.5. Editing an External Provider
- Select the External Providers entry in the tree pane.
- Select the external provider to edit.
- Click the Edit button to open the Edit Provider window.
- Change the current values for the provider to the preferred values.
- Click OK.
You have updated the details for an external provider.
13.5. Removing External Providers
13.5.1. Removing an External Provider
This procedure describes how to remove external providers.
Procedure 13.6. Removing an External Provider
- Select the External Providers entry in the tree pane.
- Select the external provider to remove.
- Click Remove.
- Click OK in the Remove Provider(s) window to confirm the removal of this provider.
You have removed an external provider.
Part II. Administering the Environment
Chapter 14. Updating the Red Hat Enterprise Virtualization Environment
14.1. Upgrades between Minor Releases
14.1.1. Checking for Red Hat Enterprise Virtualization Manager Updates
Check for updates to the Red Hat Enterprise Virtualization Manager.
Procedure 14.1. Checking for Red Hat Enterprise Virtualization Manager Updates
- Run the following command on the machine on which the Red Hat Enterprise Virtualization Manager is installed:
# engine-upgrade-check
- If there are no updates are available, the command will output the text
No upgrade
:# engine-upgrade-check VERB: queue package rhevm-setup for update VERB: package rhevm-setup queued VERB: Building transaction VERB: Empty transaction VERB: Transaction Summary: No upgrade
- If updates are available, the command will list the packages to be updated:
# engine-upgrade-check VERB: queue package rhevm-setup for update VERB: package rhevm-setup queued VERB: Building transaction VERB: Transaction built VERB: Transaction Summary: VERB: updated - rhevm-lib-3.3.2-0.50.el6ev.noarch VERB: update - rhevm-lib-3.4.0-0.13.el6ev.noarch VERB: updated - rhevm-setup-3.3.2-0.50.el6ev.noarch VERB: update - rhevm-setup-3.4.0-0.13.el6ev.noarch VERB: install - rhevm-setup-base-3.4.0-0.13.el6ev.noarch VERB: install - rhevm-setup-plugin-ovirt-engine-3.4.0-0.13.el6ev.noarch VERB: updated - rhevm-setup-plugins-3.3.1-1.el6ev.noarch VERB: update - rhevm-setup-plugins-3.4.0-0.5.el6ev.noarch Upgrade available Upgrade available
You have checked for updates to the Red Hat Enterprise Virtualization Manager.
14.1.2. Updating the Red Hat Enterprise Virtualization Manager
Updates to the Red Hat Enterprise Virtualization Manager are released via Red Hat Network. Before installing an update from Red Hat Network, ensure you read the advisory text associated with it and the latest version of the Red Hat Enterprise Virtualization Release Notes and Red Hat Enterprise Virtualization Technical Notes. A number of actions must be performed to complete an upgrade, including:
- Stopping the
ovirt-engine
service. - Downloading and installing the updated packages.
- Backing up and updating the database.
- Performing post-installation configuration.
- Starting the
ovirt-engine
service.
Procedure 14.2. Updating Red Hat Enterprise Virtualization Manager
- Run the following command to update the rhevm-setup package:
# yum update rhevm-setup
- Run the following command to update the Red Hat Enterprise Virtualization Manager:
# engine-setup
Important
Important
You have successfully updated the Red Hat Enterprise Virtualization Manager.
14.1.3. Updating Red Hat Enterprise Virtualization Hypervisors
Updating Red Hat Enterprise Virtualization Hypervisors involves reinstalling the Hypervisor with a newer version of the Hypervisor ISO image. This includes stopping and restarting the Hypervisor. Virtual machines are automatically migrated to a different host, as a result it is recommended that Hypervisor updates are performed at a time when the host's usage is relatively low.
Warning
Important
Procedure 14.3. Updating Red Hat Enterprise Virtualization Hypervisors
- Log in to the system hosting Red Hat Enterprise Virtualization Manager as the
root
user. - Enable the
Red Hat Enterprise Virtualization Hypervisor (v.6 x86_64)
repository:- With RHN Classic:
# rhn-channel --add --channel=rhel-x86_64-server-6-rhevh
- With Subscription Manager, attach a
Red Hat Enterprise Virtualization
entitlement and run the following command:# subscription-manager repos --enable=rhel-6-server-rhevh-rpms
- Run the
yum
command with theupdate
rhev-hypervisor6
parameters to ensure that you have the most recent version of the rhev-hypervisor6 package installed.# yum update rhev-hypervisor6
- Use your web browser to log in to the Administration Portal as a Red Hat Enterprise Virtualization administrative user.
- Click the Hosts tab, and then select the host that you intend to upgrade. If the host is not displayed, or the list of hosts is too long to filter visually, perform a search to locate the host.
- With the host selected, click the General tab in the details pane.
- If the host requires updating, an alert message indicates that a new version of the Red Hat Enterprise Virtualization Hypervisor is available.
- If the host does not require updating, no alert message is displayed and no further action is required.
- Ensure the host remains selected and click the Maintenance button, if the host is not already in maintenance mode. This will cause any virtual machines running on the host to be migrated to other hosts. If the host is the SPM, this function will be moved to another host. The status of the host changes as it enters maintenance mode. When the host status is Maintenance, the message in the general tab changes, providing you with a link which when clicked will reinstall or upgrade the host.
- Ensure that the host remains selected, and that you are on the General tab of the details pane. Click the Upgrade link to open the Install Host window.
- Select
rhev-hypervisor.iso
, which is symbolically linked to the most recent hypervisor image. - Click OK to update and reinstall the host. The dialog closes, the details of the host are updated in the Hosts tab, and the status changes.The host status will transition through these stages:These are all expected, and each stage will take some time.
- Installing
- Reboot
- Non Responsive
- Up.
- Once successfully updated, the host displays a status of Up. Any virtual machines that were migrated off the host, are at this point able to be migrated back to it.
Important
After a Red Hat Enterprise Virtualization Hypervisor is successfully registered to the Red Hat Enterprise Virtualization Manager and then upgraded, it may erroneously appear in the Administration Portal with the status of Install Failed. Click on the Activate button, and the hypervisor will change to an Up status and be ready for use.
You have successfully updated a Red Hat Enterprise Virtualization Hypervisor. Repeat these steps for each Hypervisor in the Red Hat Enterprise Virtualization environment.
14.1.4. Updating Red Hat Enterprise Linux Virtualization Hosts
Red Hat Enterprise Linux hosts are using the yum
in the same way as regular Red Hat Enterprise Linux systems. It is highly recommended that you use yum
to update your systems regularly, to ensure timely application of security and bug fixes.
Procedure 14.4. Updating Red Hat Enterprise Linux Hosts
- From the Administration Portal, click the Hosts tab and select the host to be updated. Click Maintenance to place it into maintenance mode.
- On the Red Hat Enterprise Linux host, run the following command:
# yum update
- Restart the host to ensure all updates are correctly applied.
You have successfully updated the Red Hat Enterprise Linux host. Repeat this process for each Red Hat Enterprise Linux host in the Red Hat Enterprise Virtualization environment.
14.1.5. Updating the Red Hat Enterprise Virtualization Guest Tools
The guest tools comprise software that allows Red Hat Enterprise Virtualization Manager to communicate with the virtual machines it managers, providing information such as the IP addresses, memory usage, and applications installed on those virtual machines. The guest tools are distributed as an ISO file that can be attached to guests. This ISO file is packaged as an RPM file that can be installed and upgraded from the machine on which the Red Hat Enterprise Virtualization Manager is installed.
Procedure 14.5. Updating the Red Hat Enterprise Virtualization Guest Tools
- Run the following command on the machine on which the Red Hat Enterprise Virtualization Manager is installed:
# yum update -y rhev-guest-tools-iso*
- Run the following command to upload the ISO file to your ISO domain, replacing [ISODomain] with the name of your ISO domain:
engine-iso-uploader --iso-domain=[ISODomain] upload /usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
Note
Therhev-tools-setup.iso
file is a symbolic link to the most recently updated ISO file. The link is automatically changed to point to the newest ISO file every time you update the rhev-guest-tools-iso package. - Use the Administration Portal, User Portal, or REST API to attach the
rhev-tools-setup.iso
file to each of your virtual machines and upgrade the tools installed on each guest using the installation program on the ISO.
You have updated the rhev-tools-setup.iso
file, uploaded the updated ISO file to your ISO domain, and attached it to your virtual machines.
14.2. Upgrading to Red Hat Enterprise Virtualization 3.4
14.2.1. Red Hat Enterprise Virtualization Manager 3.4 Upgrade Overview
- Configuring channels and entitlements.
- Updating the required packages.
- Performing the upgrade.
engine-setup
, which provides an interactive interface. While the upgrade is in process, virtualization hosts and the virtual machines running on those virtualization hosts continue to operate independently. When the upgrade is complete, you can then upgrade your hosts to the latest versions of Red Hat Enterprise Linux or Red Hat Enterprise Virtualization Hypervisor.
14.2.2. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.4
Table 14.1. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.4
Feature | Description |
---|---|
Abort migration on error
|
This feature adds support for handling errors encountered during the migration of virtual machines.
|
Forced Gluster volume creation
|
This feature adds support for allowing the creation of Gluster bricks on root partitions. With this feature, you can choose to override warnings against creating bricks on root partitions.
|
Management of asynchronous Gluster volume tasks
|
This feature provides support for managing asynchronous tasks on Gluster volumes, such as rebalancing volumes or removing bricks. To use this feature, you must use GlusterFS version 3.5 or above.
|
Import Glance images as templates
|
This feature provides support for importing images from an OpenStack image service as templates.
|
File statistic retrieval for non-NFS ISO domains
|
This feature adds support for retrieving statistics on files stored in ISO domains that use a storage format other than NFS, such as a local ISO domain.
|
Default route support
|
This feature adds support for ensuring that the default route of the management network is registered in the main routing table and that registration of the default route for all other networks is disallowed. This ensures the management network gateway is set as the default gateway for hosts.
|
Virtual machine reboot
|
This feature adds support for rebooting virtual machines from the User Portal or Administration Portal via a new button. To use this action on a virtual machine, you must install the guest tools on that virtual machine.
|
14.2.3. Red Hat Enterprise Virtualization 3.4 Upgrade Considerations
Important
- Upgrading to version 3.4 can only be performed from version 3.3
- To upgrade a previous version of Red Hat Enterprise Virtualization earlier than Red Hat Enterprise Virtualization 3.3 to Red Hat Enterprise Virtualization 3.4, you must sequentially upgrade to any newer versions of Red Hat Enterprise Virtualization before upgrading to the latest version. For example, if you are using Red Hat Enterprise Virtualization 3.2, you must upgrade to Red Hat Enterprise Virtualization 3.3 before you can upgrade to Red Hat Enterprise Virtualization 3.4.
- Red Hat Enterprise Virtualization Manager cannot be installed on the same machine as IPA
- An error message displays if the ipa-server package is installed. Red Hat Enterprise Virtualization Manager 3.4 does not support installation on the same machine as Identity Management (IdM). To resolve this issue, you must migrate the IdM configuration to another system before re-attempting the upgrade.
- Upgrading to JBoss Enterprise Application Platform 6.2 is recommended
- Although Red Hat Enterprise Virtualization Manager 3.4 supports Enterprise Application Platform 6.1.0, upgrading to the latest supported version of JBoss is recommended.
14.2.4. Upgrading to Red Hat Enterprise Virtualization Manager 3.4
The following procedure outlines the process for upgrading Red Hat Enterprise Virtualization Manager 3.3 to Red Hat Enterprise Virtualization Manager 3.4. This procedure assumes that the system on which the Manager is installed is subscribed to the channels and entitlements for receiving Red Hat Enterprise Virtualization 3.3 packages at the start of the procedure.
Important
engine-setup
command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. For this reason, the channels required by Red Hat Enterprise Virtualization 3.3 must not be removed until after the upgrade is complete as outlined below. If the upgrade fails, detailed instructions display that explain how to restore your installation.
Procedure 14.6. Upgrading to Red Hat Enterprise Virtualization Manager 3.4
- Subscribe the system on which the Red Hat Enterprise Virtualization Manager is installed to the required channels and entitlements for receiving Red Hat Enterprise Virtualization Manager 3.4 packages.
- With RHN Classic:
# rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.4
- With Subscription Manager:
# yum-config-manager --enable rhel-6-server-rhevm-3.4-rpms
- Run the following command to ensure you have the most recent version of engine-setup by updating the rhevm-setup package.
# yum update rhevm-setup
- If you have installed Reports and the Data Warehouse, run the following command to ensure you have the most recent version of the rhevm-reports-setup and rhevm-dwh-setup packages:
# yum install rhevm-reports-setup rhevm-dwh-setup
- Run the following command and follow the prompts to upgrade the Red Hat Enterprise Virtualization Manager:
# engine-setup
- Remove or disable the Red Hat Enterprise Virtualization Manager 3.3 channel to ensure the system does not use any Red Hat Enterprise Virtualization Manager 3.3 packages.
- With RHN Classic:
# rhn-channel --remove --channel=rhel-x86_64-server-6-rhevm-3.3
- With Subscription Manager:
# yum-config-manager --disable rhel-6-server-rhevm-3.3-rpms
- Run the following command to ensure all packages are up to date:
# yum update
You have upgraded the Red Hat Enterprise Virtualization Manager.
14.3. Upgrading to Red Hat Enterprise Virtualization 3.3
14.3.1. Red Hat Enterprise Virtualization Manager 3.3 Upgrade Overview
- Configuring channels and entitlements.
- Updating the required packages.
- Performing the upgrade.
engine-setup
, which provides an interactive interface. While the upgrade is in process, virtualization hosts and the virtual machines running on those virtualization hosts continue to operate independently. When the upgrade is complete, you can then upgrade your hosts to the latest versions of Red Hat Enterprise Linux or Red Hat Enterprise Virtualization Hypervisor.
14.3.2. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.3
Table 14.2. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.3
Feature | Description |
---|---|
Libvirt-to-libvirt virtual machine migration
|
Perform virtual machine migration using libvirt-to-libvirt communication. This is safer, more secure, and has less host configuration requirements than native KVM migration, but has a higher overhead on the host CPU.
|
Isolated network to carry virtual machine migration traffic
|
Separates virtual machine migration traffic from other traffic types, like management and display traffic. Reduces chances of migrations causing a network flood that disrupts other important traffic types.
|
Define a gateway per logical network
|
Each logical network can have a gateway defined as separate from the management network gateway. This allows more customizable network topologies.
|
Snapshots including RAM
|
Snapshots now include the state of a virtual machine's memory as well as disk.
|
Optimized iSCSI device driver for virtual machines
|
Virtual machines can now consume iSCSI storage as virtual hard disks using an optimized device driver.
|
Host support for MOM management of memory overcommitment
|
MOM is a policy-driven tool that can be used to manage overcommitment on hosts. Currently MOM supports control of memory ballooning and KSM.
|
GlusterFS data domains.
|
Native support for the GlusterFS protocol was added as a way to create storage domains, allowing Gluster data centers to be created.
|
Custom device property support
|
In addition to defining custom properties of virtual machines, you can also define custom properties of virtual machine devices.
|
Multiple monitors using a single virtual PCI device
|
Drive multiple monitors using a single virtual PCI device, rather than one PCI device per monitor.
|
Updatable storage server connections
|
It is now possible to edit the storage server connection details of a storage domain.
|
Check virtual hard disk alignment
|
Check if a virtual disk, the filesystem installed on it, and its underlying storage are aligned. If it is not aligned, there may be a performance penalty.
|
Extendable virtual machine disk images
|
You can now grow your virtual machine disk image when it fills up.
|
OpenStack Image Service integration
|
Red Hat Enterprise Virtualization supports the OpenStack Image Service. You can import images from and export images to an Image Service repository.
|
Gluster hook support
|
You can manage Gluster hooks, which extend volume life cycle events, from Red Hat Enterprise Virtualization Manager.
|
Gluster host UUID support
|
This feature allows a Gluster host to be identified by the Gluster server UUID generated by Gluster in addition to identifying a Gluster host by IP address.
|
Network quality of service (QoS) support
|
Limit the inbound and outbound network traffic at the virtual NIC level.
|
Cloud-Init support
|
Cloud-Init allows you to automate early configuration tasks in your virtual machines, including setting hostnames, authorized keys, and more.
|
14.3.3. Red Hat Enterprise Virtualization 3.3 Upgrade Considerations
Important
- Upgrading to version 3.3 can only be performed from version 3.2
- Users of Red Hat Enterprise Virtualization 3.1 must migrate to Red Hat Enterprise Virtualization 3.2 before attempting to upgrade to Red Hat Enterprise Virtualization 3.3.
- Red Hat Enterprise Virtualization Manager cannot be installed on the same machine as IPA
- An error message displays if the ipa-server package is installed. Red Hat Enterprise Virtualization Manager 3.3 does not support installation on the same machine as Identity Management (IdM). To resolve this issue, you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information, see https://access.redhat.com/knowledge/articles/233143.
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.3 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
- Upgrading to JBoss Enterprise Application Platform 6.1.0 is recommended
- Although Red Hat Enterprise Virtualization Manager 3.3 supports Enterprise Application Platform 6.0.1, upgrading to the latest supported version of JBoss is recommended. For more information on upgrading to JBoss Enterprise Application Platform 6.1.0, see Upgrade the JBoss EAP 6 RPM Installation.
- The rhevm-upgrade command has been replaced by engine-setup
- From Version 3.3, installation of Red Hat Enterprise Virtualization Manager supports
otopi
, a standalone, plug-in-based installation framework for setting up system components. Under this framework, therhevm-upgrade
command used during the installation process has been updated toengine-setup
and is now obsolete.
14.3.4. Upgrading to Red Hat Enterprise Virtualization Manager 3.3
The following procedure outlines the process for upgrading Red Hat Enterprise Virtualization Manager 3.2 to Red Hat Enterprise Virtualization Manager 3.3. This procedure assumes that the system on which the Manager is hosted is subscribed to the channels and entitlements for receiving Red Hat Enterprise Virtualization 3.2 packages.
engine-setup
command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. For this reason, the channels required by Red Hat Enterprise Virtualization 3.2 must not be removed until after the upgrade is complete as outlined below. If the upgrade fails, detailed instructions display that explain how to restore your installation.
Procedure 14.7. Upgrading to Red Hat Enterprise Virtualization Manager 3.3
- Subscribe the system to the required channels and entitlements for receiving Red Hat Enterprise Virtualization Manager 3.3 packages.Subscription Manager
Red Hat Enterprise Virtualization 3.3 packages are provided by the
rhel-6-server-rhevm-3.3-rpms
repository associated with theRed Hat Enterprise Virtualization
entitlement. Use theyum-config-manager
command to enable the repository in youryum
configuration.# yum-config-manager --enable rhel-6-server-rhevm-3.3-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.3 packages are provided by the
Red Hat Enterprise Virtualization Manager (v.3.3 x86_64)
channel, also referred to asrhel-x86_64-server-6-rhevm-3.3
in Red Hat Network Classic. Use therhn-channel
command or the Red Hat Network web interface to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.3 x86_64)
channel:# rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.3
- Update the rhevm-setup package to ensure you have the most recent version of
engine-setup
.# yum update rhevm-setup
- Run the
engine-setup
command and follow the prompts to upgrade Red Hat Enterprise Virtualization Manager.# engine-setup [ INFO ] Stage: Initializing Welcome to the RHEV 3.3.0 upgrade. Please read the following knowledge article for known issues and updated instructions before proceeding with the upgrade. RHEV 3.3.0 Upgrade Guide: Tips, Considerations and Roll-back Issues https://access.redhat.com/site/articles/408623 Would you like to continue with the upgrade? (Yes, No) [Yes]:
- Remove Red Hat Enterprise Virtualization Manager 3.2 channels and entitlements to ensure the system does not use any Red Hat Enterprise Virtualization Manager 3.2 packages.Subscription Manager
Use the
yum-config-manager
command to disable the Red Hat Enterprise Virtualization 3.2 repository in youryum
configuration.# yum-config-manager --disable rhel-6-server-rhevm-3.2-rpms
Red Hat Network ClassicUse the
rhn-channel
command or the Red Hat Network web interface to remove theRed Hat Enterprise Virtualization Manager (v.3.2 x86_64)
channels.# rhn-channel --remove --channel=rhel-x86_64-server-6-rhevm-3.2
- Run the following command to ensure all packages related to Red Hat Enterprise Virtualization are up to date:
# yum update
In particular, if you are using the JBoss Application Server from JBoss Enterprise Application Platform 6.0.1, you must run the above command to upgrade to Enterprise Application Platform 6.1.
Red Hat Enterprise Virtualization Manager has been upgraded. To take full advantage of all Red Hat Enterprise Virtualization 3.3 features you must also:
- Ensure all of your virtualization hosts are up to date and running the most recent Red Hat Enterprise Linux packages or Hypervisor images.
- Change all of your clusters to use compatibility version 3.3.
- Change all of your data centers to use compatibility version 3.3.
14.4. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
14.4.1. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
Upgrading Red Hat Enterprise Virtualization Manager to version 3.2 is performed using the rhevm-upgrade
command. Virtualization hosts, and the virtual machines running upon them, will continue to operate independently while the Manager is being upgraded. Once the Manager upgrade is complete you will be able to upgrade your hosts, if you haven't already, to the latest versions of Red Hat Enterprise Linux and Red Hat Enterprise Virtualization Hypervisor.
Important
Note
rhevm-upgrade
command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. Where this also fails detailed instructions for manually restoring the installation are displayed.
Procedure 14.8. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
Add Red Hat Enterprise Virtualization 3.2 Subscription
Ensure that the system is subscribed to the required channels and entitlements to receive Red Hat Enterprise Virtualization Manager 3.2 packages. This procedure assumes that the system is already subscribed to required channels and entitlements to receive Red Hat Enterprise Virtualization 3.1 packages. These must also be available to complete the upgrade process.Certificate-based Red Hat NetworkThe Red Hat Enterprise Virtualization 3.2 packages are provided by the
rhel-6-server-rhevm-3.2-rpms
repository associated with theRed Hat Enterprise Virtualization
entitlement. Use theyum-config-manager
command to enable the repository in youryum
configuration. Theyum-config-manager
command must be run while logged in as theroot
user.# yum-config-manager --enable rhel-6-server-rhevm-3.2-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.2 packages are provided by the
Red Hat Enterprise Virtualization Manager (v.3.2 x86_64)
channel, also referred to asrhel-x86_64-server-6-rhevm-3.2
in Red Hat Network Classic.rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.2
Use therhn-channel
command, or the Red Hat Network Web Interface, to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.2 x86_64)
channel.Remove Enterprise Virtualization 3.1 Subscription
Ensure that the system does not use any Red Hat Enterprise Virtualization Manager 3.1 packages by removing the Red Hat Enterprise Vitulization Manager 3.1 channels and entitlements.Certificate-based Red Hat NetworkUse the
yum-config-manager
command to disable the Red Hat Enterprise Virtualization 3.1 repository in youryum
configuration. Theyum-config-manager
command must be run while logged in as theroot
user.# yum-config-manager --disablerepo=rhel-6-server-rhevm-3.1-rpms
Red Hat Network ClassicUse the
rhn-channel
command, or the Red Hat Network Web Interface, to remove theRed Hat Enterprise Virtualization Manager (v.3.1 x86_64)
channels.# rhn-channel --remove --channel=rhel-6-server-rhevm-3.1
Update the rhevm-setup Package
To ensure that you have the most recent version of therhevm-upgrade
command installed you must update the rhevm-setup package. Log in as theroot
user and useyum
to update the rhevm-setup package.# yum update rhevm-setup
Run the
rhevm-upgrade
CommandTo upgrade Red Hat Enterprise Virtualization Manager run therhevm-upgrade
command. You must be logged in as theroot
user to run this command.# rhevm-upgrade Loaded plugins: product-id, rhnplugin Info: RHEV Manager 3.1 to 3.2 upgrade detected Checking pre-upgrade conditions...(This may take several minutes)
- If the ipa-server package is installed then an error message is displayed. Red Hat Enterprise Virtualization Manager 3.2 does not support installation on the same machine as Identity Management (IdM).
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.2 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
To resolve this issue you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information see https://access.redhat.com/knowledge/articles/233143.
Your Red Hat Enterprise Virtualization Manager installation has now been upgraded. To take full advantage of all Red Hat Enterprise Virtualization 3.2 features you must also:
- Ensure that all of your virtualization hosts are up to date and running the most recent Red Hat Enterprise Linux packages or Hypervisor images.
- Change all of your clusters to use compatibility version 3.2.
- Change all of your data centers to use compatibility version 3.2.
14.5. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
14.5.1. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
Upgrading Red Hat Enterprise Virtualization Manager to version 3.1 is performed using the rhevm-upgrade
command. Virtualization hosts, and the virtual machines running upon them, will continue to operate independently while the Manager is being upgraded. Once the Manager upgrade is complete you will be able to upgrade your hosts, if you haven't already, to the latest versions of Red Hat Enterprise Linux and Red Hat Enterprise Virtualization Hypervisor.
Important
Important
Note
rhevm-upgrade
command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. Where this also fails detailed instructions for manually restoring the installation are displayed.
Procedure 14.9. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
Red Hat JBoss Enterprise Application Platform 6 Subscription
Ensure that the system is subscribed to the required channels and entitlements to receive Red Hat JBoss Enterprise Application Platform 6 packages. Red Hat JBoss Enterprise Application Platform 6 is a required dependency of Red Hat Enterprise Virtualization Manager 3.1.Certificate-based Red Hat NetworkThe Red Hat JBoss Enterprise Application Platform 6 packages are provided by the
Red Hat JBoss Enterprise Application Platform
entitlement in certificate-based Red Hat Network.Use thesubscription-manager
command to ensure that the system is subscribed to theRed Hat JBoss Enterprise Application Platform
entitlement.# subscription-manager list
Red Hat Network ClassicThe Red Hat JBoss Enterprise Application Platform 6 packages are provided by the
Red Hat JBoss Application Platform (v 6) for 6Server x86_64
channel, also referred to asjbappplatform-6-x86_64-server-6-rpm
, in Red Hat Network Classic. The Channel Entitlement Name for this channel isRed Hat JBoss Enterprise Application Platform (v 4, zip format)
.Use therhn-channel
command, or the Red Hat Network Web Interface, to subscribe to theRed Hat JBoss Application Platform (v 6) for 6Server x86_64
channel.Add Red Hat Enterprise Virtualization 3.1 Subscription
Ensure that the system is subscribed to the required channels and entitlements to receive Red Hat Enterprise Virtualization Manager 3.1 packages.Certificate-based Red Hat NetworkThe Red Hat Enterprise Virtualization 3.1 packages are provided by the
rhel-6-server-rhevm-3.1-rpms
repository associated with theRed Hat Enterprise Virtualization
entitlement. Use theyum-config-manager
command to enable the repository in youryum
configuration. Theyum-config-manager
command must be run while logged in as theroot
user.# yum-config-manager --enable rhel-6-server-rhevm-3.1-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.1 packages are provided by the
Red Hat Enterprise Virtualization Manager (v.3.1 x86_64)
channel, also referred to asrhel-x86_64-server-6-rhevm-3.1
in Red Hat Network Classic.Use therhn-channel
command, or the Red Hat Network Web Interface, to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.1 x86_64)
channel.Remove Red Hat Enterprise Virtualization 3.0 Subscription
Ensure that the system does not use any Red Hat Enterprise Virtualization Manager 3.0 packages by removing the Red Hat Enterprise Virtualization Manager 3.0 channels and entitlements.Certificate-based Red Hat NetworkUse the
yum-config-manager
command to disable the Red Hat Enterprise Virtualization 3.0 repositories in youryum
configuration. Theyum-config-manager
command must be run while logged in as theroot
user.# yum-config-manager --disablerepo=rhel-6-server-rhevm-3-rpms
# yum-config-manager --disablerepo=jb-eap-5-for-rhel-6-server-rpms
Red Hat Network ClassicUse the
rhn-channel
command, or the Red Hat Network Web Interface, to remove theRed Hat Enterprise Virtualization Manager (v.3.0 x86_64)
channels.# rhn-channel --remove --channel=rhel-6-server-rhevm-3
# rhn-channel --remove --channel=jbappplatform-5-x86_64-server-6-rpm
Update the rhevm-setup Package
To ensure that you have the most recent version of therhevm-upgrade
command installed you must update the rhevm-setup package. Log in as theroot
user and useyum
to update the rhevm-setup package.# yum update rhevm-setup
Run the
rhevm-upgrade
CommandTo upgrade Red Hat Enterprise Virtualization Manager run therhevm-upgrade
command. You must be logged in as theroot
user to run this command.# rhevm-upgrade Loaded plugins: product-id, rhnplugin Info: RHEV Manager 3.0 to 3.1 upgrade detected Checking pre-upgrade conditions...(This may take several minutes)
- If the ipa-server package is installed then an error message is displayed. Red Hat Enterprise Virtualization Manager 3.1 does not support installation on the same machine as Identity Management (IdM).
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.1 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
To resolve this issue you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information see https://access.redhat.com/knowledge/articles/233143. - A list of packages that depend on Red Hat JBoss Enterprise Application Platform 5 is displayed. These packages must be removed to install Red Hat JBoss Enterprise Application Platform 6, required by Red Hat Enterprise Virtualization Manager 3.1.
Warning: the following packages will be removed if you proceed with the upgrade: * objectweb-asm Would you like to proceed? (yes|no):
You must enteryes
to proceed with the upgrade, removing the listed packages.
Your Red Hat Enterprise Virtualization Manager installation has now been upgraded. To take full advantage of all Red Hat Enterprise Virtualization 3.1 features you must also:
- Ensure that all of your virtualization hosts are up to date and running the most recent Red Hat Enterprise Linux packages or Hypervisor images.
- Change all of your clusters to use compatibility version 3.1.
- Change all of your data centers to use compatibility version 3.1.
14.6. Post-upgrade Tasks
14.6.1. Changing the Cluster Compatibility Version
Red Hat Enterprise Virtualization clusters have a compatibility version. The cluster compatibility version indicates the features of Red Hat Enterprise Virtualization supported by all of the hosts in the cluster. The cluster compatibility is set according to the version of the least capable host operating system in the cluster.
Note
Procedure 14.10. Changing the Cluster Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
admin
user. - Click the Clusters tab.
- Select the cluster to change from the list displayed. If the list of clusters is too long to filter visually then perform a search to locate the desired cluster.
- Click the Edit button.
- Change the Compatibility Version to the desired value.
- Click OK to open the Change Cluster Compatibility Version confirmation window.
- Click OK to confirm.
You have updated the compatibility version of the cluster. Once you have updated the compatibility version of all clusters in a data center, then you are also able to change the compatibility version of the data center itself.
Warning
14.6.2. Changing the Data Center Compatibility Version
Red Hat Enterprise Virtualization data centers have a compatibility version. The compatibility version indicates the version of Red Hat Enterprise Virtualization that the data center is intended to be compatible with. All clusters in the data center must support the desired compatibility level.
Note
Procedure 14.11. Changing the Data Center Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
admin
user. - Click the Data Centers tab.
- Select the data center to change from the list displayed. If the list of data centers is too long to filter visually then perform a search to locate the desired data center.
- Click the Edit button.
- Change the Compatibility Version to the desired value.
- Click OK.
You have updated the compatibility version of the data center.
Warning
Chapter 15. Backups
15.1. Backing Up and Restoring the Red Hat Enterprise Virtualization Manager
15.1.1. Backing up Red Hat Enterprise Virtualization Manager - Overview
engine-backup
command - can be used to rapidly back up the engine database and configuration files into a single file that can be easily stored.
15.1.2. Syntax for the engine-backup Command
engine-backup
command works in one of two basic modes:
# engine-backup --mode=backup
# engine-backup --mode=restore
Basic Options
--mode
- Specifies whether the command will perform a backup operation or a restore operation. Two options are available -
backup
, andrestore
. This is a required parameter. --file
- Specifies the path and name of a file into which backups are to be taken in backup mode, and the path and name of a file from which to read backup data in restore mode. This is a required parameter in both backup mode and restore mode.
--log
- Specifies the path and name of a file into which logs of the backup or restore operation are to be written. This parameter is required in both backup mode and restore mode.
--scope
- Specifies the scope of the backup or restore operation. There are five options:
all
, which backs up or restores all databases and configuration data;files
, which backs up or restores only files on the system;db
, which backs up or restores only the Manager database;dwhdb
, which backs up or restores only the Data Warehouse database; andreportsdb
, which backs up or restores only the Reports database. The default scope isall
.
Manager Database Options
engine-backup
command in restore
mode. The option syntax below applies to restoring the Manager database. The same options exist for restoring the Data Warehouse database and the Reports database. See engine-backup --help
for the option syntax.
--change-db-credentials
- Allows you to specify alternate credentials for restoring the Manager database using credentials other than those stored in the backup itself. Specifying this parameter allows you to add the following parameters.
--db-host
- Specifies the IP address or fully qualified domain name of the host on which the database resides. This is a required parameter.
--db-port
- Specifies the port by which a connection to the database will be made.
--db-user
- Specifies the name of the user by which a connection to the database will be made. This is a required parameter.
--db-passfile
- Specifies a file containing the password by which a connection to the database will be made. Either this parameter or the
--db-password
parameter must be specified. --db-password
- Specifies the plain text password by which a connection to the database will be made. Either this parameter or the
--db-passfile
parameter must be specified. --db-name
- Specifies the name of the database to which the database will be restored. This is a required parameter.
--db-secured
- Specifies that the connection with the database is to be secured.
--db-secured-validation
- Specifies that the connection with the host is to be validated.
Help
--help
- Provides an overview of the available modes, parameters, sample usage, how to create a new database and configure the firewall in conjunction with backing up and restoring the Red Hat Enterprise Virtualization Manager.
15.1.3. Creating a Backup with the engine-backup Command
The process for creating a backup for the Red Hat Enterprise Virtualization Manager using the engine-backup
command can be performed while the Manager is active. Append one of the following options to --scope
to specify which backup to perform:
all
: A full backup of all databases and configuration files on the Managerfiles
: A backup of only the files on the systemdb
: A backup of only the Manager databasedwhdb
: A backup of only the Data Warehouse databasereportsdb
: A backup of only the Reports database
Important
all
, must be accompanied by another backup using the files
scope, or a filesystem backup.
Procedure 15.1. Example Usage of the engine-backup Command
- Log on to the machine running the Red Hat Enterprise Virtualization Manager.
- Create a backup:
Example 15.1. Creating a Full Backup
# engine-backup --scope=all --mode=backup --log=file name --file=file name
Example 15.2. Creating a Manager Database Backup
# engine-backup --scope=files --mode=backup --log=file name --file=file name # engine-backup --scope=db --mode=backup --log=file name --file=file name
Replace thedb
option withdwhdb
orreportsdb
to back up the Data Warehouse database or the Reports database.
tar
file containing a backup is created using the path and file name provided.
15.1.4. Restoring a Backup with the engine-backup Command
engine-backup
command is straightforward, it involves several additional steps in comparison to that for creating a backup depending on the destination to which the backup is to be restored. For example, the engine-backup
command can be used to restore backups to fresh installations of Red Hat Enterprise Virtualization, on top of existing installations of Red Hat Enterprise Virtualization, and using local or remote databases.
Important
version
file located in the root directory of the unpacked files.
15.1.5. Restoring a Backup to a Fresh Installation
The engine-backup
command can be used to restore a backup to a fresh installation of the Red Hat Enterprise Virtualization Manager. The following procedure must be performed on a machine on which the base operating system has been installed and the required packages for the Red Hat Enterprise Virtualization Manager have been installed, but the engine-setup
command has not yet been run. This procedure assumes that the backup file can be accessed from the machine on which the backup is to be restored.
Note
engine-backup
command does not handle the actual creation of the engine database or the initial configuration of the postgresql
service. Therefore, these tasks must be performed manually as outlined below when restoring a backup to a fresh installation.
Procedure 15.2. Restoring a Backup to a Fresh Installation
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Manually create an empty database to which the database in the backup can be restored and configure the
postgresql
service:- Initialize the
postgresql
database, start thepostgresql
service, and ensure this service starts on boot:# service postgresql initdb # service postgresql start # chkconfig postgresql on
- Enter the postgresql command line:
# su postgres $ psql
- Create a new user:
postgres=# create role user_name with login encrypted password 'password';
- Create the new database:
postgres=# create database database_name owner user_name template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
- Edit the
/var/lib/pgsql/data/pg_hba.conf
file as follows:- For local databases, replace the existing directives in the section starting with
local
at the bottom of the file with the following directives:host database_name user_name 0.0.0.0/0 md5 host database_name user_name ::0/0 md5
- For remote databases, add the following line immediately underneath the line starting with
Local
at the bottom of the file, replacing X.X.X.X with the IP address of the Manager:host database_name user_name X.X.X.X/32 md5
- Restart the
postgresql
service:# service postgresql restart
- Restore a full backup or a database-only backup with the
--change-db-credentials
parameter to pass the credentials of the new database:- Restore a full backup:
# engine-backup --mode=restore --file=file_name --log=file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=user_name --db-password=password
- Restore a database-only backup by first restoring the configuration files backup and then restoring the database backup:
# engine-backup --mode=restore --scope=files --file=file_name --log=file_name
# engine-backup --mode=restore --scope=db --file=file_name --log=file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=user_name --db-password=password
The example above restores a backup of the Manager database.
If successful, the following output displays:You should now run engine-setup. Done.
- Run the following command and follow the prompts to configure the Manager:
# engine-setup
The engine database and configuration files for the Red Hat Enterprise Virtualization Manager have been restored to the version in the backup.
15.1.6. Restoring a Backup to Overwrite an Existing Installation
The engine-backup
command can restore a backup to a machine on which the Red Hat Enterprise Virtualization Manager has already been installed and set up. This is useful when you have taken a backup up of an installation, performed changes on that installation and then want to restore the installation from the backup.
Important
engine-cleanup
command to clean up the existing installation before using the engine-backup
command. Because the engine-cleanup
command only cleans the engine database, and does not drop the database or delete the user that owns that database, you do not need to create a new database or specify the database credentials because the user and database already exist.
Procedure 15.3. Restoring a Backup to Overwrite an Existing Installation
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Run the following command and follow the prompts to remove the configuration files for and clean the database associated with the Manager:
# engine-cleanup
- Restore a full backup or a database-only backup:
- Restore a full backup:
# engine-backup --mode=restore --file=file_name --log=file_name
- Restore a database-only backup by first restoring the configuration files backup and then restoring the database backup:
# engine-backup --mode=restore --scope=files --file=file_name --log=file_name
# engine-backup --mode=restore --scope=db --file=file_name --log=file_name
The example above restores a backup of the Manager database.
If successful, the following output displays:You should now run engine-setup. Done.
- Run the following command and follow the prompts to reconfigure the firewall and ensure the
ovirt-engine
service is correctly configured:# engine-setup
The engine database and configuration files for the Red Hat Enterprise Virtualization Manager have been restored to the version in the backup.
15.1.7. Restoring a Backup with Different Credentials
The engine-backup
command can restore a backup to a machine on which the Red Hat Enterprise Virtualization Manager has already been installed and set up, but the credentials of the database in the backup are different to those of the database on the machine on which the backup is to be restored. This is useful when you have taken a backup of an installation and want to restore the installation from the backup to a different system.
Important
engine-cleanup
command to clean up the existing installation before using the engine-backup
command. Because the engine-cleanup
command only cleans the engine database, and does not drop the database or delete the user that owns that database, you do not need to create a new database or specify the database credentials because the user and database already exist. However, if the credentials for the owner of the engine database are not known, you must change them before you can restore the backup.
Procedure 15.4. Restoring a Backup with Different Credentials
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Run the following command and follow the prompts to remove the configuration files for and clean the database associated with the Manager:
# engine-cleanup
- Change the password for the owner of the engine database if the credentials of that user are not known:
- Enter the postgresql command line:
# su postgres $ psql
- Change the password of the user that owns the engine database:
postgres=# alter role user_name encrypted password 'new_password';
- Restore a full backup or a database-only backup with the
--change-db-credentials
parameter:- Restore a full backup:
# engine-backup --mode=restore --file=file_name --log=file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=user_name --db-password=password
- Restore a database-only backup by first restoring the configuration files backup and then restoring the database backup:
# engine-backup --mode=restore --scope=files --file=file_name --log=file_name
# engine-backup --mode=restore --scope=db --file=file_name --log=file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=user_name --db-password=password
The example above restores a backup of the Manager database.
If successful, the following output displays:You should now run engine-setup. Done.
- Run the following command and follow the prompts to reconfigure the firewall and ensure the
ovirt-engine
service is correctly configured:# engine-setup
The engine database and configuration files for the Red Hat Enterprise Virtualization Manager have been restored to the version in the backup using the supplied credentials, and the Manager has been configured to use the new database.
15.2. Manually Backing Up and Restoring the Red Hat Enterprise Virtualization Manager
15.2.1. Backing Up the Engine Database Using the backup.sh Script
The Red Hat Enterprise Virtualization Manager includes a script to automate database backups. Using this script on your Manager server, you can protect yourself against potential data loss.
Important
Procedure 15.5. Backing up the engine database using the backup.sh script
- Change into the
/usr/share/ovirt-engine/dbscripts/
directory. - Invoke
backup.sh
with the-h
parameter to see the available options.Usage: backup.sh [-h] [-s SERVERNAME] [-p PORT] [-d DATABASE] [-l DIR] -u USERNAME [-v] -s SERVERNAME - The database servername for the database (def. localhost) -p PORT - The database port for the database (def. 5432) -d DATABASE - The database name (def. engine) -u USERNAME - The username for the database. -v - Turn on verbosity (WARNING: lots of output) -l DIR - Backup file directory. -h - This help text. for more options please run pg_dump --help
- Invoke the
backup.sh
command again with parameters appropriate for your environment. If you are backing up the localengine
database, the-s, -p,
and-d
parameters are not necessary. Use the-l
to specify the backup directory. This will cause a.sql
file to be created in the directory you give. - Copy the
.sql
you just created from the directory you specified to a safe remote location.
You have used the backup.sh script to backup your engine
database.
15.2.2. Backing Up Manager Configuration Files
Important
Table 15.1. Files and directories that must be backed up
Location | Overview |
---|---|
/etc/ovirt-engine/ | A directory containing Red Hat Enterprise Virtualization Manager configuration files such as engine-config.conf . |
/etc/yum/pluginconf.d/versionlock.list | A file containing version information about currently installed Red Hat Enterprise Virtualization components. |
/etc/pki/ovirt-engine/ | Security certificates provided by the Red Hat Enterprise Virtualization Manager to clients. |
/usr/share/jasperreports-server-pro/buildomatic/ | A directory containing files required to build the Red Hat Enterprise Virtualization reports server. |
/var/lib/ovirt-engine/backups/ | A directory containing backup files. |
/var/tmp/ovirt-engine/deployments/ | A directory containing information on deployments. |
/usr/share/ovirt-engine-reports/ | A directory containing configuration files related to reports. In particular, this directory contains sub-directories in which the credentials of the reports user are stored in a plain text, human-readable format. |
/root/.rnd | A random seed file used to generate secure certificates. |
/var/log/ovirt-engine/setup/ | A directory containing logs that contain the answers you gave to the setup configuration questions. You must use these files when restoring the Red Hat Enterprise Virtualization Manager because they supply the same information that was used to initially configure the Red Hat Enterprise Virtualization Manager. |
15.2.3. Restoring the Engine Database Using the restore.sh Script
The Red Hat Enterprise Virtualization Manager includes a script to automate database restoration. Using this script on your Manager server, you can recover from database corruption.
Important
Procedure 15.6. Restoring the Engine Database Using the restore.sh Script
- Change into the
/usr/share/ovirt-engine/dbscripts/
directory. - Invoke
restore.sh
with the-h
parameter to see the available options.Usage: restore.sh [-h] [-s SERVERNAME] [-p PORT] -u USERNAME -d DATABASE -f FILE [-r] -s SERVERNAME - The database servername for the database (def. localhost) -p PORT - The database port for the database (def. 5432) -u USERNAME - The username for the database. -d DATABASE - The database name -f File - Backup file name to restore from. -r - Remove existing database with same name -h - This help text. for more options please run pg_restore --help
- Invoke the
restore.sh
command again with parameters appropriate for your environment. If you are restoring the localengine
database, the-s
and-p
parameters are not necessary. Use the-d
to specify name of the database you are creating. Red Hat Enterprise Virtualization expects a primary database namedengine
. Use the-f
to specify the.sql
file you are restoring from.
You have used the restore.sh script to restore your engine
database.
15.2.4. Restoring Red Hat Enterprise Virtualization Manager Configuration Files
Restore a backed up copy of configuration files to the Red Hat Enterprise Virtualization Manager.
Important
Procedure 15.7. Restoring Red Hat Enterprise Virtualization Manager Configuration Files
- Stop the engine service:
# service ovirt-engine stop
- Completely remove all previous installations of the Red Hat Enterprise Virtualization Manager:
# yum remove rhevm
- Remove
/etc/pki/ovirt-engine
:# rm -rf /etc/pki/ovirt-engine
- Remove the main
rhevm
directory:# rm -rf /etc/ovirt-engine
- Install the Red Hat Enterprise Virtualization Manager:
# yum install -y rhevm
- Run
engine-setup
, giving the same answers as when you originally installedrhevm
:# engine-setup
Your answers can be found in/var/log/engine-setup-SETUP-DATE.log
, which you backed up. - Stop the engine service, which was restarted as a part of the previous command:
# service ovirt-engine stop
- Restore the backed up configuration files to their original locations.
- Make sure the ownership and the permission of the
.truststore
file is correct:# chown ovirt:ovirt /etc/pki/ovirt-engine/.truststore
# chmod 755 /etc/pki/ovirt-engine/.truststore
- Make sure the permissions of the
ovirt-engine-notifier.conf
file is correct:# chmod 640 /usr/share/ovirt-engine/services/ovirt-engine-notifier/ovirt-engine-notifier.conf
- Start the engine service:
# service ovirt-engine start
You have restored a backed up copy of configuration files to the Red Hat Enterprise Virtualization Manager.
15.3. Backing Up and Restoring Virtual Machines Using the Backup and Restore API
15.3.1. The Backup and Restore API
15.3.2. Backing Up a Virtual Machine
Procedure 15.8. Backing Up a Virtual Machine
- Using the REST API, create a snapshot of the virtual machine to back up:
POST /api/vms/11111111-1111-1111-1111-111111111111/snapshots/ HTTP/1.1 Accept: application/xml Content-type: application/xml <snapshot> <description>BACKUP</description> </snapshot>
Note
When you take a snapshot of a virtual machine, a copy of the configuration data of the virtual machine as at the time the snapshot was taken is stored in thedata
attribute of theconfiguration
attribute ininitialization
under the snapshot.Important
You cannot take snapshots of disks that are marked as shareable or that are based on direct LUN disks. - Retrieve the configuration data of the virtual machine from the
data
attribute under the snapshot:GET /api/vms/11111111-1111-1111-1111-111111111111/snapshots/11111111-1111-1111-1111-111111111111 HTTP/1.1 Accept: application/xml Content-type: application/xml
- Identify the disk ID and snapshot ID of the snapshot:
GET /api/vms/11111111-1111-1111-1111-111111111111/snapshots/11111111-1111-1111-1111-111111111111/disks HTTP/1.1 Accept: application/xml Content-type: application/xml
- Attach the snapshot to the backup virtual machine and activate the disk:
POST /api/vms/22222222-2222-2222-2222-222222222222/disks/ HTTP/1.1 Accept: application/xml Content-type: application/xml <disk id="11111111-1111-1111-1111-111111111111"> <snapshot id="11111111-1111-1111-1111-111111111111"/> <active>true</active> </disk>
- Use the backup software on the backup virtual machine to back up the data on the snapshot disk.
- Detach the snapshot disk from the backup virtual machine:
DELETE /api/vms/22222222-2222-2222-2222-222222222222/disks/11111111-1111-1111-1111-111111111111 HTTP/1.1 Accept: application/xml Content-type: application/xml <action> <detach>true</detach> </action>
- Optionally, delete the snapshot:
DELETE /api/vms/11111111-1111-1111-1111-111111111111/snapshots/11111111-1111-1111-1111-111111111111 HTTP/1.1 Accept: application/xml Content-type: application/xml
15.3.3. Restoring a Virtual Machine
Procedure 15.9. Restoring a Virtual Machine
- Attach the disk to the backup virtual machine:
POST /api/vms/22222222-2222-2222-2222-222222222222/disks/ HTTP/1.1 Accept: application/xml Content-type: application/xml <disk id="11111111-1111-1111-1111-111111111111"> </disk>
- Use the backup software to restore the backup to the disk.
- Detach the disk from the backup virtual machine:
DELETE /api/vms/22222222-2222-2222-2222-222222222222/disks/11111111-1111-1111-1111-111111111111 HTTP/1.1 Accept: application/xml Content-type: application/xml <action> <detach>true</detach> </action>
- Create a new virtual machine using the configuration data of the virtual machine being restored:
POST /api/vms/ HTTP/1.1 Accept: application/xml Content-type: application/xml <vm> <cluster> <name>cluster_name</name> </cluster> <name>NAME</name> ... </vm>
- Attach the disk to the new virtual machine:
POST /api/vms/33333333-3333-3333-3333-333333333333/disks/ HTTP/1.1 Accept: application/xml Content-type: application/xml <disk id="11111111-1111-1111-1111-111111111111"> </disk>
Chapter 16. Users and Roles
16.1. Introduction to Users
admin
user which resides in the internal
domain created during installation.
User
roles and admin
roles can be assigned to Red Hat Enterprise Virtualization Manager users for individual resources like virtual machines and hosts, or on a hierarchy of objects like clusters and data centers.
16.2. Directory Users
16.2.1. Directory Services Support in Red Hat Enterprise Virtualization
admin
. This account is intended for use when initially configuring the environment, and for troubleshooting. To add other users to Red Hat Enterprise Virtualization you must attach a directory server to the Manager using the Domain Management Tool, engine-manage-domains
.
user@domain
. Attachment of more than one directory server to the Manager is also supported.
- Active Directory
- Identity Management (IdM)
- Red Hat Directory Server 9 (RHDS 9)
- OpenLDAP
- A valid pointer record (PTR) for the directory server's reverse look-up address.
- A valid service record (SRV) for LDAP over TCP port
389
. - A valid service record (SRV) for Kerberos over TCP port
88
. - A valid service record (SRV) for Kerberos over UDP port
88
.
engine-manage-domains
.
- Active Directory - http://technet.microsoft.com/en-us/windowsserver/dd448614.
- Identity Management (IdM) - http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Identity_Management_Guide/index.html
- Red Hat Directory Server (RHDS) - http://docs.redhat.com/docs/en-US/Red_Hat_Directory_Server/index.html
- OpenLDAP - http://www.openldap.org/doc/
Important
Important
Important
sysprep
in the creation of Templates and Virtual Machines, then the Red Hat Enterprise Virtualization administrative user must be delegated control over the Domain to:
- Join a computer to the domain
- Modify the membership of a group
Note
- Configure the
memberOf
plug-in for RHDS to allow group membership. In particular ensure that the value of thememberofgroupattr
attribute of thememberOf
plug-in is set touniqueMember
. In OpenLDAP, thememberOf
functionality is not called a "plugin". It is called an "overlay" and requires no configuration after installation.Consult the Red Hat Directory Server 9.0 Plug-in Guide for more information on configuring thememberOf
plug-in. - Define the directory server as a service of the form
ldap/hostname@REALMNAME
in the Kerberos realm. Replace hostname with the fully qualified domain name associated with the directory server and REALMNAME with the fully qualified Kerberos realm name. The Kerberos realm name must be specified in capital letters. - Generate a
keytab
file for the directory server in the Kerberos realm. Thekeytab
file contains pairs of Kerberos principals and their associated encrypted keys. These keys allow the directory server to authenticate itself with the Kerberos realm.Consult the documentation for your Kerberos principle for more information on generating akeytab
file. - Install the
keytab
file on the directory server. Then configure RHDS to recognize thekeytab
file and accept Kerberos authentication using GSSAPI.Consult the Red Hat Directory Server 9.0 Administration Guide for more information on configuring RHDS to use an externalkeytab
file. - Test the configuration on the directory server by using the
kinit
command to authenticate as a user defined in the Kerberos realm. Once authenticated run theldapsearch
command against the directory server. Use the-Y GSSAPI
parameters to ensure the use of Kerberos for authentication.
16.3. User Authorization
16.3.1. User Authorization Model
- The user performing the action
- The type of action being performed
- The object on which the action is being performed
16.3.2. User Actions
user
must have the appropriate permission
for the object
being acted upon. Each type of action corresponds to a permission
. There are many different permissions in the system, so for simplicity:
Figure 16.1. Actions
Important
16.3.3. User Permissions
Figure 16.2. Permissions & Roles
Figure 16.3. Red Hat Enterprise Virtualization Object Hierarchy
16.4. Red Hat Enterprise Virtualization Manager User Properties and Roles
16.4.1. User Properties
16.4.2. User and Administrator Roles
- Administrator Role: Allows access to the Administration Portal for managing physical and virtual resources. An administrator role does not confer any permissions for the User Portal.
- User Role: Allows access to the User Portal for managing and accessing virtual machines and templates. A user role does not confer any permissions for the Administration Portal.
administrator
role on a cluster, you can manage all virtual machines in the cluster using the Administration Portal. However, you cannot access any of these virtual machines in the User Portal; this requires a user
role.
16.4.3. User Roles Explained
Table 16.1. Red Hat Enterprise Virtualization User Roles - Basic
Role | Privileges | Notes |
---|---|---|
UserRole | Can access and use virtual machines and pools. | Can log in to the User Portal, use assigned virtual machines and pools, view virtual machine state and details. |
PowerUserRole | Can create and manage virtual machines and templates. | Apply this role to a user for the whole environment with the Configure window, or for specific data centers or clusters. For example, if a PowerUserRole is applied on a data center level, the PowerUser can create virtual machines and templates in the data center. |
UserVmManager | System administrator of a virtual machine. | Can manage virtual machines, create and use snapshots, and migrate virtual machines. A user who creates a virtual machine in the User Portal is automatically assigned the UserVmManager role on the machine. |
Note
Table 16.2. Red Hat Enterprise Virtualization User Roles - Advanced
Role | Privileges | Notes |
---|---|---|
UserTemplateBasedVm | Limited privileges to only use Templates. | Can use templates to create virtual machines. |
DiskOperator | Virtual disk user. | Can use, view and edit virtual disks. Inherits permissions to use the virtual machine to which the virtual disk is attached. |
VmCreator | Can create virtual machines in the User Portal. | This role is not applied to a specific virtual machine; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers or clusters. When applying this role to a cluster, you must also apply the DiskCreator role on an entire data center, or on specific storage domains. |
TemplateCreator | Can create, edit, manage and remove virtual machine templates within assigned resources. | This role is not applied to a specific template; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers, clusters, or storage domains. |
DiskCreator | Can create, edit, manage and remove virtual machine disks within assigned clusters or data centers. | This role is not applied to a specific virtual disk; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers or storage domains. |
TemplateOwner | Can edit and delete the template, assign and manage user permissions for the template. | This role is automatically assigned to the user who creates a template. Other users who do not have TemplateOwner permissions on a template cannot view or use the template. |
NetworkUser | Logical network and network interface user for virtual machine and template. | Can attach or detach network interfaces from specific logical networks. |
16.4.4. Administrator Roles Explained
Table 16.3. Red Hat Enterprise Virtualization System Administrator Roles - Basic
Role | Privileges | Notes |
---|---|---|
SuperUser | System Administrator of the Red Hat Enterprise Virtualization environment. | Has full permissions across all objects and levels, can manage all objects across all data centers. |
ClusterAdmin | Cluster Administrator. | Possesses administrative permissions for all objects underneath a specific cluster. |
DataCenterAdmin | Data Center Administrator. | Possesses administrative permissions for all objects underneath a specific data center except for storage. |
Important
Table 16.4. Red Hat Enterprise Virtualization System Administrator Roles - Advanced
Role | Privileges | Notes |
---|---|---|
TemplateAdmin | Administrator of a virtual machine template. | Can create, delete, and configure the storage domains and network details of templates, and move templates between domains. |
StorageAdmin | Storage Administrator. | Can create, delete, configure, and manage an assigned storage domain. |
HostAdmin | Host Administrator. | Can attach, remove, configure, and manage a specific host. |
NetworkAdmin | Network Administrator. | Can configure and manage the network of a particular data center or cluster. A network administrator of a data center or cluster inherits network permissions for virtual pools within the cluster. |
VmPoolAdmin | System Administrator of a virtual pool. | Can create, delete, and configure a virtual pool; assign and remove virtual pool users; and perform basic operations on a virtual machine in the pool. |
GlusterAdmin | Gluster Storage Administrator. | Can create, delete, configure, and manage Gluster storage volumes. |
16.5. Red Hat Enterprise Virtualization Manager User Tasks
16.5.1. Adding Users
Users in Red Hat Enterprise Virtualization must be added from an external directory service before they can be assigned roles and permissions.
Procedure 16.1. Adding Users to Red Hat Enterprise Virtualization
- Click the Users tab to display the list of authorized users.
- Click Add. The Add Users and Groups window opens.
Figure 16.4. Add Users and Groups Window
- In the Search drop down menu, select the appropriate domain. Enter a name or part of a name in the search text field, and click GO. Alternatively, click GO to view a list of all users and groups.
- Select the check boxes for the appropriate users or groups.
- Click OK.
The added user displays on the Users tab.
16.5.2. Viewing User Information
You can view detailed information on each user in the Users tab.
Procedure 16.2. Viewing User Information
- Click the Users tab to display the list of authorized users.
- Select the user, or perform a search if the user is not visible on the results list.
- The details pane displays for the selected user, usually with the General tab displaying general information, such as the domain name, email and status of the user.
- The other tabs allow you to view groups, permissions, quotas, and events for the user.For example, to view the groups to which the user belongs, click the Directory Groups tab.
You have viewed domain, permissions, quota, group and event information for a user.
16.5.3. Viewing User Permissions on Resources
Users can be assigned permissions on specific resources or a hierarchy of resources. You can view the assigned users and their permissions on each resource.
Procedure 16.3. Viewing User Permissions on Resources
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
You have viewed the assigned users and their roles for a selected resource.
16.5.4. Removing Users
When a user account is no longer required, remove it from Red Hat Enterprise Virtualization.
Procedure 16.4. Removing Users
- Click the Users tab to display the list of authorized users.
- Select the user to be removed. Ensure the user is not running any virtual machines.
- Click the Remove button. A message displays prompting you to confirm the removal. Click OK.
The user is removed from Red Hat Enterprise Virtualization, but not from the external directory.
16.5.5. Configuring Roles
16.5.6. Creating a New Role
If the role you require is not on Red Hat Enterprise Virtualization's default list of roles, you can create a new role and customize it to suit your purposes.
Procedure 16.5. Creating a New Role
- On the header bar, click the Configure button to open the Configure window. The window shows a list of default User and Administrator roles, and any custom roles.
- Click New. The New Role dialog box displays.
Figure 16.5. The New Role Dialog
- Enter the Name and Description of the new role.
- Select either Admin or User as the Account Type.
- Use the Expand All or Collapse All buttons to view more or fewer of the permissions for the listed objects in the Check Boxes to Allow Action list. You can also expand or collapse the options for each object.
- For each of the objects, select or clear the actions you wish to permit or deny for the role you are setting up.
- Click OK to apply the changes you have made. The new role displays on the list of roles.
You have created a new role with permissions to specific resources. You can assign the new role to users.
16.5.7. Editing or Copying a Role
You can change the settings for roles you have created, but you cannot change default roles. To change default roles, clone and modify them to suit your requirements.
Procedure 16.6. Editing or Copying a Role
- On the header bar, click the Configure button to open the Configure window. The window shows a list of default User and Administrator roles, and any custom roles.
- Select the role you wish to change. Click Edit to open the Edit Role window, or click Copy to open the Copy Role window.
- If necessary, edit the Name and Description of the role.
- Use the Expand All or Collapse All buttons to view more or fewer of the permissions for the listed objects. You can also expand or collapse the options for each object.
- For each of the objects, select or clear the actions you wish to permit or deny for the role you are editing.
- Click OK to apply the changes you have made.
You have edited the properties of a role, or cloned a role.
16.6. User Role and Authorization Examples
Example 16.1. Cluster Permissions
cluster
called Accounts
. She is assigned the ClusterAdmin
role on the accounts cluster. This enables her to manage all virtual machines in the cluster, since the virtual machines are child objects of the cluster. Managing the virtual machines includes editing, adding, or removing virtual resources such as disks, and taking snapshots. It does not allow her to manage any resources outside this cluster. Because ClusterAdmin
is an administrator role, it allows her to use the Administration Portal to manage these resources, but does not give her any access via the User Portal.
Example 16.2. VM PowerUser Permissions
johndesktop
for him. John is assigned the UserVmManager
role on the johndesktop
virtual machine. This allows him to access this single virtual machine using the User Portal. Because he has UserVmManager
permissions, he can modify the virtual machine and add resources to it, such as new virtual disks. Because UserVmManager
is a user role, it does not allow him to use the Administration Portal.
Example 16.3. Data Center Power User Role Permissions
PowerUserRole
permissions for the data center in which her new virtual machine will reside. This is because to create a new virtual machine, she needs to make changes to several components within the data center, including creating the virtual machine disk image in the storage domain.
DataCenterAdmin
privileges to Penelope. As a PowerUser for a data center, Penelope can log in to the User Portal and perform virtual machine-specific actions on virtual machines within the data center. She cannot perform data center-level operations such as attaching hosts or storage to a data center.
Example 16.4. Network Administrator Permissions
NetworkAdmin
privileges on the IT department's data center, she can add and remove networks in the data center, and attach and detach networks for all virtual machines belonging to the data center.
NetworkUser
permissions and UserVmManager
permissions for the virtual machines used by the internal training department. With these permissions, Pat can perform simple administrative tasks such as adding network interfaces onto virtual machines in the Power User Portal. However, he does not have permissions to alter the networks for the hosts on which the virtual machines run, or the networks on the data center to which the virtual machines belong.
Example 16.5. Custom Role Permissions
Figure 16.6. UserManager Custom Role
System
- the top level object of the hierarchy shown in Figure 16.6, “UserManager Custom Role”. This means they apply to all other objects in the system. The role is set to have an Account Type of Admin. This means that when she is assigned this role, Rachel can only use the Administration Portal, not the User Portal.
Chapter 17. Quotas and Service Level Agreement Policy
17.1. Introduction to Quota
Table 17.1. The Two Different Kinds of Quota
Quota type | Definition |
---|---|
Run-time Quota | This quota limits the consumption of runtime resources, like CPU and memory. |
Storage Quota | This quota limits the amount of storage available. |
Table 17.2. Quota Modes
Quota Mode | Function |
---|---|
Enforced | This mode puts into effect the Quota that you have set in audit mode, limiting resources to the group or user affected by the quota. |
Audit | This mode allows you to change Quota settings. Choose this mode to increase or decrease the amount of runtime quota and the amount of storage quota available to users affected by it. |
Disabled | This mode turns off the runtime and storage limitations defined by the quota. |
Important
17.2. Shared Quota and Individually Defined Quota
17.3. Quota Accounting
Example 17.1. Accounting example
17.4. Enabling and Changing a Quota Mode in a Data Center
This procedure enables or changes the quota mode in a data center. You must select a quota mode before you can define quotas. You must be logged in to the Web Administration Portal to follow the steps of this procedure.
Procedure 17.1. Enabling and Changing Quota in a Data Center
- Click the Data Centers tab in the Navigation Pane.
- From the list of data centers displayed in the Navigation Pane, choose the data center whose quota policy you plan to edit.
- Click Edit in the top left of the Navigation Pane.An Edit Data Center window opens.
- In the Quota Mode drop-down, change the quota mode to Enforced.
- Click OK.
You have now enabled a quota mode at the Data Center level. If you set the quota mode to Audit during testing, then you must change it to Enforced in order for the quota settings to take effect.
17.5. Creating a New Quota Policy
You have enabled quota mode, either in Audit or Enforcing mode. You want to define a quota policy to manage resource usage in your data center.
Procedure 17.2. Creating a New Quota Policy
- In tree mode, select the data center. The Quota tab appears in the Navigation Pane.
- Click the Quota tab in the Navigation Pane.
- Click Add in the Navigation Pane. The New Quota window opens.
- Fill in the Name field with a meaningful name.Fill in the Description field with a meaningful name.
- In the Memory & CPU section of the New Quota window, use the green slider to set Cluster Threshold.
- In the Memory & CPU section of the New Quota window, use the blue slider to set Cluster Grace.
- Click Edit on the bottom-right of the Memory & CPU field. An Edit Quota window opens.
- Under the Memory field, select either the Unlimited radio button (to allow limitless use of Memory resources in the cluster), or select the limit to radio button to set the amount of memory set by this quota. If you select the limit to radio button, input a memory quota in megabytes (MB) in the MB field.
- Under the CPU field, select either the Unlimited radio button or the limit to radio button to set the amount of CPU set by this quota. If you select the limit to radio button, input a number of vCPUs in the vCpus field.
- Click OK in the Edit Quota window.
- In the Storage section of the New Quota window, use the green slider to set Storage Threshold.
- In the Storage section of the New Quota window, use the blue slider to set Storage Grace.
- Click Edit in the Storage field. The Edit Quota window opens.
- Under the Storage Quota field, select either the Unlimited radio button (to allow limitless use of Storage) or the limit to radio button to set the amount of storage to which quota will limit users. If you select the limit to radio button, input a storage quota size in gigabytes (GB) in the GB field.
- Click OK in the Edit Quota window. You are returned to the New Quota window.
- Click OK in the New Quota window.
You have created a new quota policy.
17.6. Explanation of Quota Threshold Settings
Table 17.3. Quota thresholds and grace
Setting | Definition |
---|---|
Cluster Threshold | The amount of cluster resources available per data center. |
Cluster Grace | The amount of the cluster available for the data center after exhausting the data center's Cluster Threshold. |
Storage Threshold | The amount of storage resources available per data center. |
Storage Grace | The amount of storage available for the data center after exhausting the data center's Storage Threshold. |
17.7. Assigning a Quota to an Object
This procedure explains how to associate a virtual machine with a quota.
Procedure 17.3. Assigning a Quota to a Virtual Machine
- In the navigation pane, select the Virtual Machine to which you plan to add a quota.
- Click Edit. The Edit Virtual Machine window appears.
- Select the quota you want the virtual machine to consume. Use the Quota drop-down to do this.
- Click OK.
You have designated a quota for the virtual machine you selected.
This procedure explains how to associate a virtual machine disk with a quota.
Procedure 17.4. Assigning a Quota to a Virtual Disk
- In the navigation pane, select the Virtual Machine whose disk(s) you plan to add a quota.
- In the details pane, select the disk you plan to associate with a quota.
- Click Edit. The Edit Virtual Disk window appears.
- Select the quota you want the virtual disk to consume.
- Click OK.
You have designated a quota for the virtual disk you selected.
Important
17.8. Using Quota to Limit Resources by User
This procedure describes how to use quotas to limit the resources a user has access to.
Procedure 17.5. Assigning a User to a Quota
- In the tree, click the Data Center with the quota you want to associate with a User.
- Click the Quota tab in the navigation pane.
- Select the target quota in the list in the navigation pane.
- Click the Consumers tab in the details pane.
- Click Add at the top of the details pane.
- In the Search field, type the name of the user you want to associate with the quota.
- Click GO.
- Select the check box at the left side of the row containing the name of the target user.
- Click OK in the bottom right of the Assign Users and Groups to Quota window.
After a short time, the user will appear in the Consumers tab of the details pane.
17.9. Editing Quotas
This procedure describes how to change existing quotas.
Procedure 17.6. Editing Quotas
- On the tree pane, click on the data center whose quota you want to edit.
- Click on the Quota tab in the Navigation Pane.
- Click the name of the quota you want to edit.
- Click Edit in the Navigation pane.
- An Edit Quota window opens. If required, enter a meaningful name in the Name field.
- If required, you can enter a meaningful description in the Description field.
- Select either the All Clusters radio button or the Specific Clusters radio button. Move the Cluster Threshold and Cluster Grace sliders to the desired positions on the Memory & CPU slider.
- Select either the All Storage Domains radio button or the Specific Storage Domains radio button. Move the Cluster Threshold and Cluster Grace sliders to the desired positions on the Memory & CPU slider.
- Click OK in the Edit Quota window to confirm the new quota settings.
You have changed an existing quota.
17.10. Removing Quotas
This procedure describes how to remove quotas.
Procedure 17.7. Removing Quotas
- On the tree pane, click on the data center whose quota you want to edit.
- Click on the Quota tab in the Navigation Pane.
- Click the name of the quota you want to remove.
- Click Remove at the top of the Navigation pane, under the row of tabs.
- Click OK in the Remove Quota(s) window to confirm the removal of this quota.
You have removed a quota.
17.11. Service-level Agreement Policy Enforcement
This procedure describes how to set service-level agreement CPU features.
- Select New VM in the Navigation Pane.
- Select Show Advanced Options.
- Select the Resource Allocation tab.
- Specify CPU Shares. Possible options are Low, Medium, High, Custom, and Disabled. Virtual machines set to High receive twice as many shares as Medium, and virtual machines set to Medium receive twice as many shares as virtual machines set to Low. Disabled instructs VDSM to use an older algorithm for determining share dispensation; usually the number of shares dispensed under these conditions is 1020.
You have set a service-level agreement CPU policy. Users' CPU consumption is now governed by the policy you have set.
Figure 17.1. Service-level Agreement Policy Enforcement - CPU Allocation Menu
Chapter 18. Event Notifications
18.1. Configuring Event Notifications
The Red Hat Enterprise Virtualization Manager can notify designated users when specific events occur in the environment that the Red Hat Enterprise Virtualization Manager manages. To use this functionality, you must set up a mail transfer agent to deliver messages.
Procedure 18.1. Configuring Event Notifications
- Ensure you have set up the mail transfer agent with the appropriate variables.
- Use the Users resource tab, tree mode, or the search function to find and select the user to which event notifications will be sent.
- Click the Event Notifier tab in the details pane to list the events for which the user will be notified. This list will be blank if you have not configured any event notifications for that user.
- Click Manage Events to open the Add Event Notification window.
Figure 18.1. The Add Events Notification Window
- Use the Expand All button or the subject-specific expansion buttons to view the events.
- Select the appropriate check boxes.
- Enter an email address in the Mail Recipient field.
- Click OK to save changes and close the window.
- Add and start the ovirt-engine-notifier service on the Red Hat Enterprise Virtualization Manager. This activates the changes you have made:
# chkconfig --add ovirt-engine-notifier
# chkconfig ovirt-engine-notifier on
# service ovirt-engine-notifier restart
The specified user now receives emails based on events in the Red Hat Enterprise Virtualization environment. The selected events display on the Event Notifier tab for that user.
18.2. Parameters for Event Notifications in ovirt-engine-notifier.conf
/usr/share/ovirt-engine/services/ovirt-engine-notifier/ovirt-engine-notifier.conf
.
Table 18.1. ovirt-engine-notifier.conf variables
Variable Name | Default | Remarks |
---|---|---|
SENSITIVE_KEYS | none | A comma-separated list of keys that will not be logged. |
JBOSS_HOME | /usr/share/jbossas | The location of the JBoss application server used by the Manager. |
ENGINE_ETC | /etc/ovirt-engine | The location of the etc directory used by the Manager. |
ENGINE_LOG | /var/log/ovirt-engine | The location of the logs directory used by the Manager. |
ENGINE_USR | /usr/share/ovirt-engine | The location of the usr directory used by the Manager. |
ENGINE_JAVA_MODULEPATH | ${ENGINE_USR}/modules | The location of Java modules. The location of JBoss is always appended and cannot be appended here because it may resolve to a different path. |
NOTIFIER_DEBUG_ADDRESS | none | The address of a machine that can be used to perform remote debugging of the Java virtual machine that the notifier uses. |
NOTIFIER_STOP_TIME | 30 | The time, in seconds, after which the service will time out. |
NOTIFIER_STOP_INTERVAL | 1 | The time, in seconds, by which the timeout counter will be incremented. |
INTERVAL_IN_SECONDS | 120 | The interval in seconds between instances of dispatching messages to subscribers. |
IDLE_INTERVAL | 30 | The interval, in seconds, between which low-priority tasks will be performed. |
DAYS_TO_KEEP_HISTORY | 0 | This variable sets the number of days dispatched events will be preserved in the history table. If this variable is not set, events remain on the history table indefinitely. |
FAILED_QUERIES_NOTIFICATION_THRESHOLD | 30 | The number of failed queries after which a notification email is sent. A notification email is sent after the first failure to fetch notifications, and then once every time the number of failures specified by this variable is reached. If you specify a value of 0 or 1 , an email will be sent with each failure. |
FAILED_QUERIES_NOTIFICATION_RECIPIENTS | none | The email addresses of the recipients to which notification emails will be sent. Email addresses must be separated by a comma. This entry has been deprecated by the FILTER variable. |
DAYS_TO_SEND_ON_STARTUP | 0 | The number of days of old events that will be processed and sent when the notifier starts. |
FILTER | exclude:* | The algorithm used to determine the triggers for and recipients of email notifications. The value for this variable comprises a combination of include or exclude , the event, and the recipient. For example, include:VDC_START(smtp:mail@example.com) ${FILTER} |
MAIL_SERVER | none | The SMTP mail server address. Required. |
MAIL_PORT | 25 | The port used for communication. Possible values include 25 for plain SMTP, 465 for SMTP with SSL, and 587 for SMTP with TLS. |
MAIL_USER | none | If SSL is enabled to authenticate the user, then this variable must be set. This variable is also used to specify the "from" user address when the MAIL_FROM variable is not set. Some mail servers do not support this functionality. The address is in RFC822 format. |
SENSITIVE_KEYS | ${SENSITIVE_KEYS},MAIL_PASSWORD | Required to authenticate the user if the mail server requires authentication or if SSL or TLS is enabled. |
MAIL_PASSWORD | none | Required to authenticate the user if the mail server requires authentication or if SSL or TLS is enabled. |
MAIL_SMTP_ENCRYPTION | none | The type of encryption to be used in communication. Possible values are none , ssl , tls . |
HTML_MESSAGE_FORMAT | false | The mail server sends messages in HTML format if this variable is set to true . |
MAIL_FROM | none | This variable specifies a sender address in RFC822 format, if supported by the mail server. |
MAIL_REPLY_TO | none | This variable specifies reply-to addresses in RFC822 format on sent mail, if supported by the mail server. |
MAIL_SEND_INTERVAL | 1 | The number of SMTP messages to be sent for each IDLE_INTERVAL |
MAIL_RETRIES | 4 | The number of times to attempt to send an email before failing. |
SNMP_MANAGER | none | The IP addresses or fully qualified domain names of machines that will act as the SNMP managers. Entries must be separated by a space and can contain a port number. For example, manager1.example.com manager2.example.com:164 |
SNMP_COMMUNITY | public | The default SNMP community. |
SNMP_OID | 1.3.6.1.4.1.2312.13.1.1 | The default TRAP object identifiers for alerts. |
ENGINE_INTERVAL_IN_SECONDS | 300 | The interval, in seconds, between monitoring the machine on which the Manager is installed. The interval is measured from the time the monitoring is complete. |
ENGINE_MONITOR_RETRIES | 3 | The number of times the notifier attempts to monitor the status of the machine on which the Manager is installed in a given interval after a failure. |
ENGINE_TIMEOUT_IN_SECONDS | 30 | The time, in seconds, to wait before the notifier attempts to monitor the status of the machine on which the Manager is installed in a given interval after a failure. |
IS_HTTPS_PROTOCOL | false | This entry must be set to true if JBoss is being run in secured mode. |
SSL_PROTOCOL | TLS | The protocol used by JBoss configuration connector when SSL is enabled. |
SSL_IGNORE_CERTIFICATE_ERRORS | false | This value must be set to true if JBoss is running in secure mode and SSL errors is to be ignored. |
SSL_IGNORE_HOST_VERIFICATION | false | This value must be set to true if JBoss is running in secure mode and host name verification is to be ignored. |
REPEAT_NON_RESPONSIVE_NOTIFICATION | false | This variable specifies whether repeated failure messages will be sent to subscribers if the machine on which the Manager is installed is non-responsive. |
ENGINE_PID | /var/lib/ovirt-engine/ovirt-engine.pid | The path and file name of the PID of the Manager. |
18.3. Canceling Event Notifications
A user has configured some unnecessary event notifications and wants them canceled.
Procedure 18.2. Canceling Event Notifications
- In the Users tab, select the user or the user group.
- Select the Event Notifier tab in the details pane to list events for which the user receives notifications.
- Click Manage Events to open the Add Event Notification window.
- Use the Expand All button, or the subject-specific expansion buttons, to view the events.
- Clear the appropriate check boxes to remove notification for that event.
- Click OK to save changes and close the window.
You have canceled unnecessary event notifications for the user.
Chapter 19. Utilities
19.1. The Ovirt Engine Rename Tool
19.1.1. The Ovirt Engine Rename Tool
engine-setup
command is run in a clean environment, the command generates a number of certificates and keys that use the fully qualified domain name of the Manager supplied during the setup process. If the fully qualified domain name of the Manager must be changed later on (for example, due to migration of the machine hosting the Manager to a different domain), the records of the fully qualified domain name must be updated to reflect the new name. The ovirt-engine-rename
command automates this task.
ovirt-engine-rename
command updates records of the fully qualified domain name of the Manager in the following locations:
- /etc/ovirt-engine/engine.conf.d/10-setup-protocols.conf
- /etc/ovirt-engine/imageuploader.conf.d/10-engine-setup.conf
- /etc/ovirt-engine/isouploader.conf.d/10-engine-setup.conf
- /etc/ovirt-engine/logcollector.conf.d/10-engine-setup.conf
- /etc/pki/ovirt-engine/cert.conf
- /etc/pki/ovirt-engine/cert.template
- /etc/pki/ovirt-engine/certs/apache.cer
- /etc/pki/ovirt-engine/keys/apache.key.nopass
- /etc/pki/ovirt-engine/keys/apache.p12
Warning
ovirt-engine-rename
command creates a new certificate for the web server on which the Manager runs, it does not affect the certificate for the engine or the certificate authority. Due to this, there is some risk involved in using the ovirt-engine-rename
command, particularly in environments that have been upgraded from Red Hat Enterprise Virtualization version 3.2 and earlier. Therefore, changing the fully qualified domain name of the Manager by running engine-cleanup
and engine-setup
is recommended where possible.
19.1.2. Syntax for the Ovirt Engine Rename Command
ovirt-engine-rename
command is:
# /usr/share/ovirt-engine/setup/bin/ovirt-engine-rename
--newname=[new name]
- Allows you to specify the new fully qualified domain name for the Manager without user interaction.
--log=[file]
- Allows you to specify the path and name of a file into which logs of the rename operation are to be written.
--config=[file]
- Allows you to specify the path and file name of a configuration file to load into the rename operation.
--config-append=[file]
- Allows you to specify the path and file name of a configuration file to append to the rename operation. This option can be used to specify the path and file name of an answer file.
--generate-answer=[file]
- Allows you to specify the path and file name of a file into which your answers to and the values changed by the
ovirt-engine-rename
command are recorded.
19.1.3. Using the Ovirt Engine Rename Tool
You can use the ovirt-engine-rename
command to update records of the fully qualified domain name of the Manager.
Procedure 19.1. Renaming the Red Hat Enterprise Virtualization Manager
- Prepare all DNS and other relevant records for the new fully qualified domain name.
- Update the DHCP server configuration if DHCP is used.
- Update the host name on the Manager.
- Run the following command:
# /usr/share/ovirt-engine/setup/bin/ovirt-engine-rename
- When prompted, press Enter to stop the engine service:
During execution engine service will be stopped (OK, Cancel) [OK]:
- When prompted, enter the new fully qualified domain name for the Manager:
New fully qualified server name:[new name]
The ovirt-engine-rename
command updates records of the fully qualified domain name of the Manager.
19.2. The Domain Management Tool
19.2.1. The Domain Management Tool
admin
user to add the directory service that the users must be authenticated against. You add and remove directory services domains using the included domain management tool, engine-manage-domains
.
engine-manage-domains
command is only accessible on the machine on which Red Hat Enterprise Virtualization Manager is installed. The engine-manage-domains
command must be run as the root
user.
19.2.2. Syntax for the Domain Management Tool
engine-manage-domains ACTION [options]
add
- Add a domain to Red Hat Enterprise Virtualization Manager's directory services configuration.
edit
- Edit a domain in Red Hat Enterprise Virtualization Manager's directory services configuration.
delete
- Delete a domain from Red Hat Enterprise Virtualization Manager's directory services configuration.
validate
- Validate Red Hat Enterprise Virtualization Manager's directory services configuration. This command attempts to authenticate each domain in the configuration using the configured user name and password.
list
- List Red Hat Enterprise Virtualization Manager's current directory services configuration.
--add-permissions
- Specifies that the domain user will be given the SuperUser role in Red Hat Enterprise Virtualization Manager. By default, if the
--add-permissions
parameter is not specified, the SuperUser role is not assigned to the domain user. The--add-permissions
option is optional. It is only valid when used in combination with theadd
andedit
actions. --change-password-msg=[MSG]
- Specifies the message that is returned to the user at login when their password has expired. This allows you to direct users to a specific URL (must begin with http or https) where their password can be changed. The
--change-password-msg
option is optional, and is only valid when used in combination with theadd
andedit
actions. --config-file=[FILE]
- Specifies an alternate configuration file that the command must use. The
--config-file
parameter is always optional. --domain=[DOMAIN]
- The domain on which the action will be performed. The
--domain
parameter is mandatory for theadd
,edit
, anddelete
actions. --force
- Forces the command to skip confirmation of delete operations.
--ldap-servers=[SERVERS]
- A comma delimited list of LDAP servers to be set to the domain.
--log-file=[LOG_FILE]
- The name of a file into which to write logs for an operation.
--log-level=[LOG_LEVEL]
- The log level. You can choose either
DEBUG
(the default option),INFO
,WARN
, orERROR
. These options are case insensitive. --log4j-config=[LOG4J_FILE]
- A
log4j.xml
file from which to read logging configuration information. --provider=
[PROVIDER]- The LDAP provider type of the directory server for the domain. Valid values are:
ad
- Microsoft Active Directory.ipa
- Identity Management (IdM).rhds
- Red Hat Directory Server. Red Hat Directory Server does not come with Kerberos. Red Hat Enterprise Virtualization requires Kerberos authentication. Red Hat Directory Server must be running as a service inside a Kerberos domain to provide directory services to the Manager.Note
To use Red Hat Directory Server as your directory server, you must have thememberof
plug-in installed in Red Hat Directory Server. To use thememberof
plug-in, your users must beinetuser
.itds
- IBM Tivoli Directory Server.oldap
- OpenLDAP.
--report
- When used in conjunction with the
validate
action, this command outputs a report of all validation errors encountered. --resolve-kdc
- Resolve key distribution center servers using DNS.
--user=[USER]
- Specifies the domain user to use. The
--user
parameter is mandatory foradd
, and optional foredit
. --password-file=[FILE]
- Specifies that the domain user's password is on the first line of the provided file. This option, or the
--interactive
option, must be used to provide the password for use with theadd
action.
engine-manage-domains
command's help output:
# engine-manage-domains --help
19.2.3. Using the Domain Management Tool
engine-manage-domains
command to perform basic manipulation of the Red Hat Enterprise Virtualization Manager domain configuration.
19.2.4. Listing Domains in Configuration
engine-manage-domains
command lists the directory services domains defined in the Red Hat Enterprise Virtualization Manager configuration. This command prints the domain, the user name in User Principal Name (UPN) format, and whether the domain is local or remote for each configuration entry.
Example 19.1. engine-manage-domains
List Action
# engine-manage-domains list Domain: directory.demo.redhat.com User name: admin@DIRECTORY.DEMO.REDHAT.COM This domain is a remote domain.
19.2.5. Adding Domains to Configuration
engine-manage-domains
command is used to add the IdM
domain directory.demo.redhat.com
to the Red Hat Enterprise Virtualization Manager configuration. The configuration is set to use the admin
user when querying the domain; the password is provided interactively.
Example 19.2. engine-manage-domains
Add Action
# engine-manage-domains add --domain=directory.demo.redhat.com --provider=IPA --user=admin loaded template kr5.conf file setting default_tkt_enctypes setting realms setting domain realm success User guid is: 80b71bae-98a1-11e0-8f20-525400866c73 Successfully added domain directory.demo.redhat.com. oVirt Engine restart is required in order for the changes to take place (service ovirt-engine restart).
19.2.6. Editing a Domain in the Configuration
engine-manage-domains
command is used to edit the directory.demo.redhat.com
domain in the Red Hat Enterprise Virtualization Manager configuration. The configuration is updated to use the admin
user when querying this domain; the password is provided interactively.
Example 19.3. engine-manage-domains
Edit Action
# engine-manage-domains -action=edit -domain=directory.demo.redhat.com -user=admin -interactive loaded template kr5.conf file setting default_tkt_enctypes setting realms setting domain realmo success User guide is: 80b71bae-98a1-11e0-8f20-525400866c73 Successfully edited domain directory.demo.redhat.com. oVirt Engine restart is required in order for the changes to take place (service ovirt-engine restart).
19.2.7. Validating Domain Configuration
engine-manage-domains
command is used to validate the Red Hat Enterprise Virtualization Manager configuration. The command attempts to log into each listed domain with the credentials provided in the configuration. The domain is reported as valid if the attempt is successful.
Example 19.4. engine-manage-domains
Validate Action
# engine-manage-domains validate User guide is: 80b71bae-98a1-11e0-8f20-525400866c73 Domain directory.demo.redhat.com is valid.
19.2.8. Deleting a Domain from the Configuration
engine-manage-domains
command is used to remove the directory.demo.redhat.com
domain from the Red Hat Enterprise Virtualization Manager configuration. Users defined in the removed domain will no longer be able to authenticate with the Red Hat Enterprise Virtualization Manager. The entries for the affected users will remain defined in the Red Hat Enterprise Virtualization Manager until they are explicitly removed.
admin
user from the internal
domain will be able to log in until another domain is added.
Example 19.5. engine-manage-domains
Delete Action
# engine-manage-domains delete --domain=directory.demo.redhat.com WARNING: Domain directory.demo.redhat.com is the last domain in the configuration. After deleting it you will have to either add another domain, or to use the internal admin user in order to login. Successfully deleted domain directory.demo.redhat.com. Please remove all users and groups of this domain using the Administration portal or the API.
19.3. The Configuration Tool
19.3.1. The Configuration Tool
engine-config
.
- List all available configuration keys.
- List all available configuration values.
- Retrieve the value of a specific configuration key.
- Set the value of a specific configuration key.
--cver
parameter to specify the configuration version to be used when retrieving or setting a value for a configuration key. The default configuration version is general
.
19.3.2. Syntax for engine-config Command
engine-config
command:
# engine-config --help
Common tasks
- List available configuration keys
- Use the
--list
parameter to list available configuration keys.#
engine-config
--list
Each available configuration key is listed by name and description. - List available configuration values
- Use the
--all
parameter to list available configuration values.#
engine-config
--all
Each available configuration key is listed by name, current value of the key, and the configuration version. - Retrieve value of configuration key
- Use the
--get
parameter to retrieve the value of a specific key.#
engine-config
--get KEY_NAME
Replace KEY_NAME with the name of the specific key to retrieve the key name, value, and the configuration version. Use the--cver
parameter to specify the configuration version of the value to be retrieved. - Set value of configuration key
- Use the
--set
parameter to set the value of a specific key. You must also set the configuration version to which the change is to apply using the--cver
parameter.#
engine-config
--set KEY_NAME=KEY_VALUE
--cver=VERSION
Replace KEY_NAME with the name of the specific key to set; replace KEY_VALUE with the value to be set. Environments with more than one configuration version require the VERSION to be specified.
19.3.3. Getting a Configuration Value
Example 19.6. Retrieving the Value of the SearchResultsLimit
Key
# engine-config --get=SearchResultsLimit --cver=general 100
19.3.4. Setting a Configuration Value
Example 19.7. Setting the Value of the SearchResultsLimit
Key
# engine-config --set SearchResultsLimit=50 --cver=general
19.3.5. The admin@internal User
admin@internal
user account is automatically created upon installation of the Red Hat Enterprise Virtualization Manager. This account is stored locally in the Red Hat Enterprise Virtualization Manager's PostgreSQL database, separate from external directory services such as IdM or Active Directory. Unlike external directory domains, users cannot be added or deleted from the internal
domain. The admin@internal
user is the SuperUser of the Red Hat Enterprise Virtualization Manager and has administrative privileges over the environment via the Administration Portal.
admin@internal
user is set during the installation of the Red Hat Enterprise Virtualization Manager. Use the engine-config utility if you need to reset the password.
19.3.6. Changing the Password for admin@internal
- Log in to the Red Hat Enterprise Virtualization Manager server as the
root
user. - Use the
engine-config
utility to set a new password for theadmin@internal
user.# engine-config -s AdminPassword=interactive
Use escape characters if your password includes any special characters. - Restart the ovirt-engine service for the changes to take effect.
# service ovirt-engine restart
19.3.7. Configuration Tool Examples
Example 19.8. Getting a Configuration Value
# engine-config --get=SearchResultsLimit --cver=general 100
Example 19.9. Setting a Configuration Value
# engine-config --set SearchResultsLimit=50 --cver=general
19.3.8. Red Hat Enterprise Virtualization Manager Configuration Options
Table 19.1. Red Hat Enterprise Virtualization Manager Configuration Options
Name | Description | Type | Default Value | Comments |
---|---|---|---|---|
AbortMigrationOnError | Abort ongoing migration on error | Boolean |
v3.0: false
v3.1: false
v3.2: false
v3.3: false
| Specify whether it is possible to optionally abort ongoing migration when an error occurs. |
AsyncTaskPollingRate | Async Task Polling Rate (in seconds) | Integer | 10 | How often (in seconds) the Red Hat Enterprise Virtualization Manager queries the status of an asynchronous task in progress. |
AsyncTaskZombieTaskLifeInMinutes | Zombie tasks lifetime in minutes | Integer | 3000 | How long (in minutes) a task is allowed to run before assuming it has become a zombie and should be killed. The value affects large storage manipulations especially. When using slow storage and large virtual images, or when a task is known to take longer than 3000 minutes (50 hours), the value should be increased. |
AttestationPort | Definition of service port for attestation service | Integer | 8443 | Which port is your attestation server listening for connections on? |
AttestationServer | Definition of FQDN of attestation server | String | - | Fully qualified domain name or IP address of your attestation server. |
AttestationTruststore | Trust store used for securing communication with attestation service | String | TrustStore.jks | Copy the TrustStore.jks keystore file from /var/lib/oat-appraiser/Certificate/ on your attestation server to /usr/share on your engine server. |
AttestationTruststorePass | The password used to access trust store | String | password | The default password is password. |
AttestationFirstStageSize | Attestation size for first stage | Integer | 10 | Used for quick initialization. Do not change unless you know why. |
AuditLogAgingThreshold | Audit Log Aging Threshold (in days) | Integer | 30 | How long an audit log is kept before being rotated. |
AuditLogCleanupTime | Time to check for Audit Log cleanup | Time | 03:35:35 | At what time the Audit Log is checked for Aging and cleaned up. |
AuthenticationMethod | The authentication method used by Red Hat Enterprise Virtualization Manager | String | LDAP | The API used for querying users. Currently LDAP is the only supported value. |
BlockMigrationOnSwapUsagePercentage | Host swap percentage threshold (for scheduling) | Integer | 0 | The maximum percentage of swap space on the host that a VM run or migration is allowed to consume on the host. If the host is swapping beyond this percentage, a VM will not migrate over and will not be started. |
BootstrapMinimalVdsmVersion | Minimum VDSM version | String | 4.9 | The minimum version of VDSM that is acceptable when adding hosts to the Engine. Newer versions have more features. |
CABaseDirectory | CA Base Directory | String | /etc/pki/ovirt-engine | Where the Red Hat Enterprise Virtualization Manager Certificate Authority is located on the Red Hat Enterprise Virtualization Manager host. |
CertificateFileName | Certificate File Name | String | /etc/pki/ovirt-engine/certs/engine.cer | Points to the certificate file used by Red Hat Enterprise Virtualization Manager for SSL/TLS communication with VDSM. |
ClientModeSpiceDefault
|
The default SPICE console protocol mode
|
String
|
Auto
|
The default mode to use when connecting to a virtual machine using the SPICE console protocol.
|
ClientModeVncDefault
|
The default VNC console protocol mode
|
String
|
Native
|
The default mode to use when connecting to a virtual machine using the VNC console protocol.
|
ClientModeRdpDefault
|
The default RDP console protocol mode
|
String
|
Auto
|
The default mode to use when connecting to a virtual machine using the RDP console protocol.
|
ClusterEmulatedMachines | Supported machine types | String |
v3.0: rhel6.2.0
v3.1: rhel6.3.0
v3.2: rhel6.4.0
v3.3: rhel6.5.0
v3.4: rhel6.5.0
| The machine types supported by clusters. |
CpuOverCommitDurationMinutes | The duration in minutes of CPU consumption to activate selection algorithm | Integer | 2 | When the cluster policy is set to Even Distribution, wait for this amount of minutes after detecting CPU overcommit before triggering virtual machine migrations to rebalance the host load. This configuration value applies only for the default. |
CustomDeviceProperties | Custom device properties | DeviceCustomProperties | v3.4 only: {type=interface;prop={SecurityGroups=^(?:(?:[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}, *)*[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}|)$}} | Definition of custom properties for each device type. |
DefaultWindowsTimeZone | The default time zone for Windows virtual machines | WindowsTimeZone | GMT Standard Time | The default time zone used when creating new Windows virtual machines. |
DefaultGeneralTimeZone | The default time zone for virtual machines other than Windows virtual machines | GeneralTimeZone | Etc/GMT | The default time zone used when creating virtual machines other than Windows virtual machines. |
DelayResetForSpmInSeconds | Delay before Storage Pool Manager reset | Double | 20 | The additional delay, in seconds, before reset due to a communication issue when the host is the Storage Pool Manager. |
DelayResetPerVmInSeconds | Delay before virtual machine reset | Double | 0.5 | The additional delay, in seconds, before reset due to a communication issue for each virtual machine running on a host. |
DisableFenceAtStartupInSec | Disable Fence Operations at Red Hat Enterprise Virtualization Manager Startup in seconds | Integer | 300 | Allow this amount of seconds after Red Hat Enterprise Virtualization Manager starts to detect hosts, before assuming the hosts are unresponsive and proceed to fence hosts. This value should be increased when Red Hat Enterprise Virtualization Manager is on a machine that has slow network startup (a VMware guest, for example). |
DwhHeartBeatInterval | The interval, in seconds at which the data warehouse is informed that the engine is running | Integer | 30 | - |
WANDisableEffects | Disabled WAN Effects value to send to the SPICE console | StringMultiple | animation | The list of effects which will be disabled for SPICE. Possible values: animation , wallpaper , font-smooth , and all . |
WANColorDepth | WAN Color Depth value to send to the SPICE console | Integer | 16 | The color depth used by the SPICE. Possible values are 16 and 32 . |
EnableMACAntiSpoofingFilterRules | Enable anti-spoofing filter rules for MAC addresses | String | true | Specifies whether network filtering is enabled. |
EnableSpiceRootCertificateValidation | Enable Spice Root Certification Validation | String | true | If true , the certificate of the host on which the virtual machine is running and the Red Hat Enterprise Virtualization Manager setup CA certificate are sent to the SPICE client when attempting to connect to the virtual machine with SPICE, as an extra security mechanism. |
EnableUSBAsDefault | Enable USB devices attachment to the virtual machine by default | String | true | - |
EnableVdsLoadBalancing | Enables Host Load Balancing system | String | true | This config value allows the user to turn on or off (true and false, respectively) the virtual machine load balancing according to the policy configured for the cluster. |
EncryptHostCommunication | Encryption of host communication | Boolean | true | Specify whether communication between hosts and the Manager will be encrypted. |
ExternalSchedulerServiceURL | The location of an external scheduler | String | http://localhost:18781 | The location of an external scheduler. |
ExternalSchedulerConnectionTimeout | The time for which a connection to an external scheduler will be attempted before timing out | Integer | 100 | This value can be set to 0 to disable this feature. |
ExternalSchedulerEnabled | Specifies whether the virtual machine scheduler will consider the external filters and load balancers | Boolean | false | - |
ExternalSchedulerResponseTimeout | The time for which a response from an external scheduler will be waited on before timing out | Integer | 120000 | - |
FreeSpaceCriticalLowInGB | Critical low disk space alert threshold (in GB) | Integer | 5 | Produces an alert when a Storage Domain has this amount of space left. This setting is also used in various preliminary tests for action sanity when users try to use storage domains, to prevent reaching this critical amount. Adding and importing disks will fail if the amount of space is less than the value specified here. |
FreeSpaceLow | Limit of percentage of free disk space below which it is considered low | Integer | 10 | When a storage domain has this percentage of space left, it is considered low on disk space. |
GlusterRefreshRateHooks | The refresh rate for Gluster hooks | Integer | 7200 | The refresh rate, in seconds, for Gluster hooks from Gluster servers. |
HighUtilizationForEvenlyDistribute | High Utilization Limit For Evenly Distribute selection algorithm | Integer | 75 | Maximum number of virtual machines per host in the Evenly Distribute algorithm. |
HighUtilizationForPowerSave | High Utilization Limit For Power Save selection algorithm | Integer | 75 | A default for newly created clusters, in use with PowerSave load balancing algorithm, marks the higher limit of host utilization for populating hosts. |
HostPreparingForMaintenanceIdleTime | The time to wait, in seconds, to determine if a host is idling in status PreparingForMaintenance | Integer | 300 | When the interval is met, another attempt is made to move the host into maintenance. |
KeystoneAuthUrl | The location of a Keystone server | String | - | The location of an OpenStack Keystone server for authenticating OpenStack providers. |
LDAPQueryTimeout | Read Timeout in seconds for LDAP queries | Integer | 30 | The amount of time an LDAP query will read before the query is stopped. |
LDAPOperationTimeout | Search timeout at LDAP server side | Integer | 30 | The amount of time an LDAP search will operate before it is stopped. |
LDAPConnectTimeout | Connect timeout in seconds for LDAP queries | Integer | 30 | The amount of time an LDAP query will connect before it is stopped. |
LocalAdminPassword | Local Administrator Password | Password | Populated during initial setup | The password for admin@local default user. |
LogMaxPhysicalMemoryUsedThresholdInPercentage | Memory usage threshold for triggering a log event | Integer | 95 | The maximum threshold of physical memory usage on a host, in percentage, that will trigger an audit log event. |
LogMaxCpuUsedThresholdInPercentage | CPU usage threshold for triggering a log event | Integer | 95 | The maximum threshold of CPU usage on a host, in percentage, that will trigger an audit log event. |
LogMaxNetworkUsedThresholdInPercentage | Network usage threshold for triggering a log event | Integer | 95 | The maximum threshold of network usage on a host, in percentage, that will trigger an audit log event. |
LogMinFreeSwapThresholdInMB | Free swap threshold for triggering a log event | Integer | 256 | The minimum threshold of free swap memory on a host, in MB, that will trigger an audit log event. |
LogMaxSwapUsedThresholdInPercentage | Swap usage threshold for triggering a log event | Integer | 95 | The maximum threshold for swap memory usage on a host, in percentage, that will trigger an audit log event. |
LogPhysicalMemoryThresholdInMB | Threshold for logging low host memory in MB | Integer | 1024 | The minimum amount of RAM left before a host is considered low on memory. If a host's RAM is lower than this setting, it is recorded on the audit log and no action is taken. |
LowUtilizationForEvenlyDistribute | Low Utilization Limit for Evenly Distribute selection algorithm | Integer | 0 | Minimum number of virtual machines per host in the Evenly Distribute algorithm. |
LowUtilizationForPowerSave | Low Utilization Limit for Power Save selection algorithm | Integer | 20 | A default for newly created clusters, in use with PowerSave load balancing algorithm, marks the lower limit of host utilization for populating hosts. |
MacPoolRanges | MAC Addresses Pool Ranges | String | 00:1a:4a:58:8e:00 - 00:1a:4a:58:8e:ff | The MAC address pool range to be automatically assigned to virtual machines. |
MaxAverageNetworkQoSValue | Maximum value for Average Networks Quality of Service (Mbps) | Integer | 1024 | - |
MaxPeakNetworkQoSValue | Maximum value for Peak Networks Quality of Service (Mbps) | Integer | 2048 | - |
MaxBurstNetworkQoSValue | Maximum value for Burst Networks Quality of Service (Mb) | Integer | 10240 | - |
MaxMacsCountInPool | Maximum MAC Addresses count in Pool | Integer | 100000 | Maximum number of MAC addresses allowed in the MAC pool. |
MaxNumberOfHostsInStoragePool | Maximum number of hosts in Storage Pool | Integer | 250 | Limits the maximum number of hosts assigned to the clusters of a single Data Center. This can be increased after testing more hosts, if necessary. |
MaxNumOfCpuPerSocket | Maximum Number of CPU per socket | Integer | 16 (all versions) | The maximum number of virtual CPU cores that can be assigned to a single virtual CPU socket. |
MaxNumOfVmCpus | Total Numbers of Virtual Machine CPUs | Integer |
3.0: 64
3.1: 160
3.2: 160
3.3: 160
3.4: 160
| The maximum total amount of CPU cores assigned to a virtual machine (determined by number of cores multiplied by number of sockets). |
MaxNumofVmSockets | Maximum number of sockets per virtual machine | Integer | 16 (all versions) | The maximum number of virtual CPU sockets assigned to a virtual machine. |
MaxRerunVmOnVdsCount | Maximum virtual machine rerun attempts on a host | Integer | 3 | Maximum number of attempts to start a virtual machine on a host before an error ("unable to start VM") is reported. |
MaxSchedulerWeight | Maximum schedule weighting | Integer | 1000 | The maximum weight score for a single scheduler weight module. |
MaxStorageVdsDelayCheckSec | Max delay for check of domain in seconds | Integer | 5 | Maximum amount of seconds to wait for storage domain status to be returned before reporting an error. |
MaxStorageVdsTimeoutCheckSec | Maximum timeout for last check of domain in seconds | Integer | 30 | When monitoring storage, vdsmd on the hosts reports a "lastCheck" value for each domain. This setting is used to decide whether the last check happened too long ago and domain is considered in error. |
MaxVdsMemOverCommit | Max Host Memory Over-Commit (%) for virtual desktops load | Integer | 200 | The percentage of memory overcommit permitted to occur when using virtual desktop loads. |
MaxVdsMemOverCommitForServers | Maximum Host Memory Over-Commit (%) for Virtual Servers load | Integer | 150 | The percentage of memory overcommit permitted to occur when using virtual server loads. |
MaxVdsNameLength | Max VDS name length | Integer | 255 | Maximum name length for a Hypervisor host. |
MaxVmNameLengthNonWindows | Maximum virtual machine name length for non-Windows operating system | Integer | 64 | Maximum name length for a non-Windows virtual machine. |
MaxVmNameLengthWindows | Maximum name length in Windows | Integer | 15 | Maximum name length for Windows virtual machine (limitation imposed by Windows hostnames). |
MaxVmsInPool | Max virtual machines in pool | Integer | 1000 | Maximum number of virtual machines in a single data center. |
VmPoolMaxSubsequentFailures | Maximum number of subsequent VM creation failures before giving up | Integer | 3 | The maximum number of subsequent failed virtual machine creations that can occur in a virtual machine pool before the operation is stopped. |
NumberofFailedRunsOnVds | Number of Failed Runs on Host | Integer | 3 | Number of attempts to run virtual machines on hosts before setting host status to "Error". |
NumberOfVmsForTopSizeVms | Number of virtual machines with highest disk size to display | Integer | 10 | Number of virtual machines to display in the storage domain's virtual machine tab. Will display this amount of virtual machines, sorted by the most storage space per used virtual machine. |
NumberVmRefreshesBeforeSave | Number of Virtual Machine Data Refreshes Before Saving to Database | Integer | 5 | The number of host monitor iterations between refreshing virtual machines from VDSM (determines if virtual machines should be refreshed one upon each iteration) |
OnlyRequiredNetworksMandatoryForVdsSelection | Specifies whether only required networks will be considered for determining if a virtual machine can be run on a host | String | true | If set to true , only networks marked as Required will be considered when determining if a virtual machine can be run on a given host. Otherwise, all networks that the virtual machine uses must be set up on a host for that host to be able to run the virtual machine. |
OverUtilizationForHaReservation | A percentage representing the threshold for over-utilization compared to the optimal use case | Integer | 200 | Example - if the optimal number of highly available virtual machines for a given host is two, and this key is set to 200 , a highly available virtual machine will not be migrated using the balance method until there are at least five highly available virtual machines on that the given host. |
ScaleDownForHaReservation | A number by which the high-availability reservation weight score is divided to produce the final weight score | Integer | 1 | Example - if the weight score for a host is 90 and this key is set to 2 , the final score for that host is 45. This allows you to reduce the effect of the high-availability reservation weight function has on the total scoring for a host. |
oVirtISOsRepositoryPath | The Red Hat Enterprise Virtualization Hypervisor installation files path | String | /usr/share/rhev-hypervisor | The location of Red Hat Enterprise Virtualization Hypervisor ISO images used for upgrading Hypervisor hosts. |
EnableVdsHaReservation | Specifies whether high-availability virtual machine reservation is enabled for a cluster | Boolean | true | - |
VdsHaReservationIntervalInMinutes | The period of time, in minutes, after which a cluster will be checked for high-availability reservation | Integer | 5 | - |
DefaultMaximumMigrationDowntime | The maximum time a virtual machine can be down during live migration | Integer | 0 | If this key is set to 0 , the default value for VDSM will be used. |
PollUri | The URI used for accessing the attestation service | String | AttestationService/resources/PollHosts | |
ProductKey2003 | Product Key (for Windows 2003) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
ProductKey2003x64 | Product Key (for Windows 2003 x64) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
ProductKey2008 | Product Key (for Windows 2008) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
ProductKey2008R2 | Product Key (for Windows 2008 R2) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
ProductKey2008x64 | Product Key (for Windows 2008 x64) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
ProductKey | Product Key (for Windows XP) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
ProductKeyWindow7 | Product Key (for Windows 7) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
ProductKeyWindow7x64 | Product Key (for Windows 7 x64) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
ProductRPMVersion | Red Hat Enterprise Virtualization Manger RPM Version | String | Automatically populated | The RPM version of the currently used rhevm package. |
SANWipeAfterDelete | Initializing disk image is more secure but it can be time consuming and I/O intensive depending on the size of the image | String | false | Determines the default value (checked/unchecked) of the Wipe After Delete check box in the New Virtual Disk window. This is relevant for disks being created on SAN-based storage domains (FC/iSCSI). |
SASL_QOP | SASL quality of protection | String | auth-conf | Determines the quality of protection in authentication and LDAP queries (auth, auth-int, auth-conf). |
SearchResultsLimit | Max Quantity of Search Results | Integer | 100 | The number of results to return for search queries if no specific figure is given in the web administration portal or REST. |
SecureConnectionWithOATServers | Determine whether use secure communication or not to access attestation service | Boolean | true | |
ServerRebootTimeout | Host Reboot Timeout (in seconds) | Integer | 300 | Wait this amount of seconds when a host is rebooted or fenced, before determining that the host is Non Responsive . Can be increased for hosts that take longer to reboot. |
SpiceProxyDefault | The address of the SPICE Proxy. | String | none | When this key is set to a value, the SPICE proxy is activated (turned on). When this key is not set to a value, the SPICE proxy is not activated (turned off). |
SpiceReleaseCursorKeys | Keyboard keys combination that causes the mouse cursor to be released from its grab on SPICE | String | Shift+F12 | - |
SpiceSecureChannels | SPICE Secure Channels | String | smain, sinputs, scursor, splayback, srecord, sdisplay, susbredir, ssmartcard | Which SPICE channels should be secured with SSL. |
SpiceToggleFullScreenKeys | Keyboard keys combination that toggles the full-screen state of SPICE client window | String | Shift+F11 | - |
SpiceUsbAutoShare | Enable USB devices sharing by default in SPICE | String | true | Represents the default value (checked/unchecked) of the Enable USB Auto-Share check box in the Console Options dialog in the User Portal. |
SpmCommandFailOverRetries | Number of retries to failover the Storage Pool Manager on failed commands | Integer | 3 | Number of SPM selection failover retries. In case an SPM command fails, back end performs a failover - it selects a new SPM and re-runs the command. |
SPMFailOverAttempts | Number of attempts to connect to the Storage Pool Manager before Failover | Integer | 3 | When monitoring a Storage Pool, if the current SPM fails, failover does not happen immediately (see description of SpmCommandFailOverRetries). This setting defines the number of retries before deciding that the current SPM is down and a failover is required. |
SpmVCpuConsumption | The CPU consumption of SPM embodied as number of VCPUs on the Host | Integer | 1 | When a host is the SPM, it is considered to be using this amount of extra virtual CPUs, to make up for the overhead that SPM operations generate. |
SSHInactivityTimoutSeconds | SSH Inactivity Timeout (in seconds) | Integer | 300 | The maximum amount of time back end allows for an SSH session to remote hosts. After this timeout the session is killed. |
SSHInactivityHardTimoutSeconds | SSH Inactivity Hard Timeout (in seconds) | Integer | 1800 | |
NumberOfUSBSlots | Number of USB slots in virtual machines with native USB support | Integer | 4 | - |
SchedulerAllowOverBooking | Specify whether scheduler resource synchronization will be skipped | Boolean | false | If scheduler resource synchronization is skipped, it may lead to more requests being scheduled than can be fulfilled. |
SchedulerOverBookingThreshold | Determines the threshold for pending Scheduling requests before Scheduling resource synchronization is skipped | Integer | 10 | This option is used when SchedulerAllowOverBooking is set to true . |
SSLEnabled | SPICE SSL Enabled | String | true | Whether SPICE Secure channels should be encrypted using SSL. |
StorageDomainFailureTimeoutInMinutes | Storage Domain failure timeout | Integer | 5 | Defines the amount of time taken before deciding domain is problematic, starting at the first failure reported by VDSM (in minutes). |
StoragePoolRefreshTimeInSeconds | Storage Pool Manager Polling Rate (in seconds) | Integer | 10 | Storage Pool monitoring frequency. |
SysPrep2K3Path | Path to a Windows 2003 machine sysprep file | String | - | Path to the operating system specific sysprep file template. |
SysPrep2K8Path | Path to a Windows 2008 machine sysprep file | String | - | Path to the operating system specific sysprep file template. |
SysPrep2K8R2Path | Path to a Windows 2008 R2 machine sysprep file | String | - | Path to the operating system specific sysprep file template. |
SysPrep2K8x64Path | Path to a Windows 2008 machine sysprep file | String | - | Path to the operating system specific sysprep file template. |
SysPrepWindows7Path | Path to a Windows 7 machine sysprep file | String | - | Path to the operating system specific sysprep file template. |
SysPrepWindows7x64Path | Path to a Windows 7 x64 machine sysprep file | String | - | Path to the operating system specific sysprep file template. |
SysPrepWindows8Path | Path to a Windows 8 machine Sys-Prep file | String | - | Path to the operating system specific sysprep file template. |
SysPrepWindows8x64Path | Path to a Windows 8 x64 machine Sys-Prep file | String | - | Path to the operating system specific sysprep file template. |
SysPrepWindows2012x64Path | Path to a Windows 2012 x64 machine Sys-Prep file | String | - | Path to the operating system specific sysprep file template. |
SysPrepXPPath | Path to a Windows XP machine sysprep file | String | - | Path to the operating system specific sysprep file template. |
TimeoutToResetVdsInSeconds | Communication timeout in seconds before attempting reset | Integer | 60 | The amount of time a host is unresponsive before a fence command is issued. This is used in conjunction with VDSAttemptsToResetCount . |
TimeToReduceFailedRunOnVdsInMinutes | Time to Reduce Failed Run on Host (in minutes) | Integer | 30 | The amount of time that the host will be in Error status after failing to run virtual machines. |
UserDefinedVMProperties | User-defined virtual machine properties | String | - | Mostly used with VDSM hooks. |
UseFqdnForRdpIfAvailable | Specify whether the fully qualified domain name will be used in connections using the RDP console protocol | Boolean | true | If this option is enabled, the RDP console will use the fully qualified domain name of the virtual machine, if available, as reported by the guest agent. This fully qualified domain name is then used to establish the connection. |
UserRefreshRate | Refresh Rate of Users' Data from Active Directory (in seconds) | Integer | 3600 | How often the directory server is polled for user account updates. |
UtilizationThresholdInPercent | The Utilization Threshold (in percent) | Integer | 80 | In load balancing, this is a default value used to calculate the maximum CPU limit to determine if the host is over-utilized. This is the percent of the value that the user set in high-utilization in the cluster. |
ValidNumOfMonitors | Valid Numbers of Monitors | Integer | 1,2,4 | Number of monitors available for SPICE-enabled virtual machines. |
VdcVersion | Red Hat Enterprise Virtualization Manager Version | String | Automatically set to the current version of Red Hat Enterprise Virtualization Manager | - |
VDSAttemptsToResetCount | Number of attempts to communicate with Host before trying to reset | Integer | 2 | The amount of times to retry communications with a host before a fence command is issued. Used in conjunction with TimeoutToResetVdsInSeconds . |
VdsLoadBalancingeIntervalInMinutes | Host Load Balancing Interval (in minutes) | Integer | 1 | The interval between running the virtual machines' load balancer in minutes (also defines the first invocation of the load balancer). |
VdsRecoveryTimeoutInMintues | Host Timeout when Recovering (in minutes) | Integer | 3 | When VDSM fails/restarts, it can sometimes be in recovering mode (VDSM reports "initializing" or "recovering from reports"). |
VdsRefreshRate | Time interval in seconds to poll a Host's status | Integer | 2 | How often a Hypervisor host's status is checked. |
vdsTimeout | Host Control Communication Timeout (in seconds) | Integer | 180 | Timeout for a VDSM call - the time engine will wait for sync call to VDSM. |
vdsConnectionTimeout | VDS connection timeout value | Integer | 2 | The time to wait, in seconds, for establishment of a connection with a host. |
vdsRetries | Number of times to retry VDS-related host operations | Integer | 0 | The number of times to retry host operations in the event of communication errors. |
VM32BitMaxMemorySizeInMB | Maximum memory for 32-bit virtual machines | Integer | 20480 | The maximum memory size, in MB, for 32-bit virtual machines. |
VM64BitMaxMemorySizeInMB | Maximum memory for 64-bit virtual machines | Integer |
v3.0: 524288
v3.1: 2097152
v3.2: 2097152
v3.3: 2097152
v3.4: 2097152
| |
VmGracefulShutdownMessage | Message displayed in Virtual Machine when Virtual Machine is being shut down from Red Hat Enterprise Virtualization Manager | String | System Administrator has initiated shutdown of this Virtual Machine. Virtual Machine is shutting down. | - |
VMMinMemorySizeInMB | Minimal memory size of virtual machine in MB | Integer | 256 | - |
VncKeyboardLayout | Keyboard Layout configuration for VNC | String | en-us | Possible values: ar, da, de-ch, en-us, et, fo, fr-be, fr-ch, hu, it, li, mk, nl, no, pt, ru, sv, tr, de en-gb, es, fi, fr, fr-ca, hr, is, ja, lv, nl-be, pl, pt-br, sl, th. |
WaitForVdsInitInSec | Wait for a host to complete init in SPM selection | Integer | 60 | This is a timeout for initializing host as in VdsRecoveryTimeoutInMinutes , but this timeout is shorter and is used during the SPM selection algorithm. If the selected host is initialized, wait for it to recover. |
FenceQuietTimeBetweenOperationsInSec | Quiet time between Power Management operations in seconds | Integer | 180 | The minimum time in seconds between two power management operations activated manually by a user. |
FenceProxyDefaultPreferences | The default preferences for fencing proxies | String | cluster,dc | The default fencing proxy preferences used to define how to search for a proxy host in fencing operations. |
MaxAuditLogMessageLength | Maximum length of an Audit Log message | Integer | 10000 | - |
SysPrepDefaultUser | Default sysprep user name | String | - | This user is used if the domain for sysprep is unknown or no domain is specified. |
SysPrepDefaultPassword | Default SysPrep user password | Password | Empty | This password is used if the domain for sysprep is unknown or no domain is specified. |
QoSInboundAverageDefaultValue | The average quality of service for inbound network traffic | Integer | 10 | The average quality of service for inbound network traffic, in Mbps. |
QoSInboundPeakDefaultValue | The quality of service for inbound network traffic during peak times | Integer | 10 | The quality of service for inbound network traffic during peak times, in Mbps. |
QoSInboundBurstDefaultValue | The quality of service for inbound network traffic during bursts | Integer | 100 | The quality of service for inbound network traffic during bursts, in Mbps. |
QoSOutboundAverageDefaultValue | The average quality of service for outbound network traffic | Integer | 10 | The average quality of service for outbound network traffic, in Mbps. |
QoSOutboundPeakDefaultValue | The quality of service for outbound network traffic during peak times | Integer | 10 | The quality of service for outbound network traffic during peak times, in Mbps. |
QoSOutboundBurstDefaultValue | The quality of service for outbound network traffic during bursts | Integer | 100 | The quality of service for outbound network traffic during bursts, in Mbps. |
UserSessionTimeOutInterval | Session timeout interval in minutes | Integer | 30 | User session timeout. Global for all types of access - User Portal/Admin Portal/Web Admin/API. |
AdminPassword | admin user password | Password | - | Password of admin user (used if no directory service is used for authentication). |
IPTablesConfig | Iptables configuration used to auto-configure the Manager | String | The complete set of iptables rules that are used when automatic firewall configuration is selected when running the engine-setup command | |
OvirtIsoPrefix | oVirt ISOs files prefix | String | ovirt-node-iso, rhevh | |
OvirtInitialSupportedIsoVersion | oVirt node initial Supported ISO Version | String | 2.5.5, 5.8 | |
VdsLocalDisksLowFreeSpace | Amount of free disk space on a host local storage domain that should be considered low, in MB | Integer | 1000 | Setting this value lower than the default of 1000 MB reduces the time available to add additional space to your data domains before virtual machine performance is affected. If you have many virtual machines, generating or receiving data, it may make sense to set this value higher. |
VdsLocalDisksCriticallyLowFreeSpace | Amount of free disk space on a host local storage domain that should be considered critically low, in MB | Integer | 500 | Setting this value lower than the default of 500 MB reduces the time between when critical disk shortage messages begin being displayed and when virtual machine performance is affected. If you have many virtual machines, generating or receiving data quickly, you might find that the default value is too low, and does not provide enough time to add more storage. |
AllowDuplicateMacAddresses | Enable duplicate MAC address for VM network interface | String | false | If enabled, allows that the same MAC address be set explicitly on several virtual NICs. Otherwise, setting a MAC address that is already in use on another virtual NIC is prohibited. |
JobCleanupRateInMinutes | Frequency of jobs cleanup process | Integer | 10 | |
SucceededJobCleanupTimeInMinutes | Time to keep successfully ended jobs | Integer | 10 | |
FailedJobCleanupTimeInMinutes | Time to keep failed jobs | Integer | 60 | |
VmPoolMonitorIntervalInMinutes | Interval in minutes for monitoring number of prestarted virtual machines in virtual machine pools | Integer | 5 | |
UserMessageOfTheDay | A message to be displayed in the User Portal login page | String | - | - |
VmPoolMonitorBatchSize | Maximum number of virtual machines that the virtual machine pool monitor will attempt to prestart in a single cycle | Integer | 5 | |
NetworkConnectivityCheckTimeoutInSeconds | The time to wait before rolling back network changes in case the engine losses connectivity with the host in seconds | Integer | 120 | |
AllowClusterWithVirtGlusterEnabled | Allows to create a Cluster with both Virt and Gluster services enabled | String | false | If enabled, the user can create a cluster with both Virt and Gluster support or one of them, otherwise the user cannot create a cluster that supports both. |
EnableMACAntiSpoofingFilterRules | Indicates if Network Filtering should be enabled or not | String | v3.0: false v3.1: false v3.2: true | If enabled, MAC anti-spoofing rules are set on each virtual network interface card, ensuring that the Ethernet frames this network interface card sends have the source MAC that is assigned to it in the engine. |
EnableHostTimeDrift | Indicates if host time-drift validation is enabled | String | false | If time drift validation is enabled, the Manager will require that host system time be within a given variation of the Manager system time. The allowed difference is set by HostTimeDriftInSec |
EngineMode | Engine working mode | String | Active | |
HostTimeDriftInSec | Allowed time drift between any Host and Engine | Integer | 300 | |
WebSocketProxy | The location of a websocket proxy | String | 6100 | The location of a websocket proxy. Possible values include Off , Host:[port] , Engine:[port] , [host name], or [ip address]:[port] |
WebSocketProxyTicketValiditySeconds | The time for which websocket proxy tickets are valid | Integer | 120 | The time, in seconds, for validity of tickets issued for a websocket proxy. |
19.4. The Image Uploader Tool
19.4.1. The Image Uploader Tool
engine-image-uploader
command allows you to list export storage domains and upload virtual machine images in OVF format to an export storage domain and have them automatically recognized in the Red Hat Enterprise Virtualization Manager.
Note
|-- images | |-- [Image Group UUID] | |--- [Image UUID (this is the disk image)] | |--- [Image UUID (this is the disk image)].meta |-- master | |---vms | |--- [UUID] | |--- [UUID].ovf
19.4.2. Syntax for the engine-image-uploader Command
engine-image-uploader
[options]
list
engine-image-uploader
[options]
upload
[file].[file]...[file]
list
, and upload
.
- The
list
action lists the export storage domains to which images can be uploaded. - The
upload
action uploads images to the specified export storage domain.
upload
action.
engine-image-uploader
command. You can set defaults for any of these parameters in the /etc/ovirt-engine/imageuploader.conf
file.
General Options
-h
,--help
- Displays information on how to use the image uploader command.
--conf-file=[PATH]
- Sets [PATH] as the configuration file the command will to use. The default is
etc/ovirt-engine/imageuploader.conf
. --log-file=[PATH]
- Sets [PATH] as the specific file name the command will use to write log output. The default is
/var/log/ovirt-engine/ovirt-image-uploader/ovirt-image-uploader-[date].log
. --cert-file=[PATH]
- Sets [PATH] as the certificate for validating the engine. The default is
/etc/pki/ovirt-engine/ca.pem
. --insecure
- Specifies that no attempt will be made to verify the engine.
--quiet
- Sets quiet mode, reducing console output to a minimum.
-v
,--verbose
- Sets verbose mode, providing more console output.
-f
,--force
- Force mode is necessary when the source file being uploaded has the same file name as an existing file in the destination export domain. This option forces the existing file to be overwritten.
Red Hat Enterprise Virtualization Manager Options
-u [USER]
,--user=[USER]
- Specifies the user whose credentials will be used to execute the command. The [USER] is specified in the format [username]@[domain]. The user must exist in the specified domain and be known to the Red Hat Enterprise Virtualization Manager.
-r [FQDN]
,--engine=[FQDN]
- Specifies the IP address or fully qualified domain name of the Red Hat Enterprise Virtualization Manager from which the images will be uploaded. It is assumed that the image uploader is being run from the same machine on which the Red Hat Enterprise Virtualization Manager is installed. The default value is
localhost:443
.
Export Storage Domain Options
-e
option or the -n
option.
-e
[EXPORT_DOMAIN],--export-domain=[EXPORT_DOMAIN]
- Sets the storage domain EXPORT_DOMAIN as the destination for uploads.
-n
[NFSSERVER],--nfs-server=[NFSSERVER]
- Sets the NFS path [NFSSERVER] as the destination for uploads.
Import Options
-i
,--ovf-id
- Specifies that the UUID of the image will not be updated. By default, the command generates a new UUID for images that are uploaded. This ensures there is no conflict between the id of the image being uploaded and the images already in the environment.
-d
,--disk-instance-id
- Specifies that the instance ID for each disk in the image will not be renamed. By default, the command generates new UUIDs for disks in images that are uploaded. This ensures there are no conflicts between the disks on the image being uploaded and the disks already in the environment.
-m
,--mac-address
- Specifies that network components in the image will not be removed from the image. By default, the command removes network interface cards from image being uploaded to prevent conflicts with network cards on other virtual machines already in the environment. If you do not use this option, you can use the Administration Portal to add network interface cards to newly imported images and the Manager will ensure there are no MAC address conflicts.
-N [NEW_IMAGE_NAME]
,--name=[NEW_IMAGE_NAME]
- Specifies a new name for the image being uploaded.
19.4.3. Creating an OVF Archive That is Compatible With the Image Uploader
You can create files that can be uploaded using the engine-image-uploader
tool.
Procedure 19.2. Creating an OVF Archive That is Compatible With the Image Uploader
- Use the Manager to create an empty export domain. An empty export domain makes it easy to see which directory contains your virtual machine.
- Export your virtual machine to the empty export domain you just created.
- Log in to the storage server that serves as the export domain, find the root of the NFS share and change to the subdirectory under that mount point. You started with a new export domain, there is only one directory under the exported directory. It contains the
images/
andmaster/
directories. - Run the
tar -zcvf my.ovf images/ master/
command to create the tar/gzip ovf archive. - Anyone you give the resulting ovf file to (in this example, called
my.ovf
) can import it to Red Hat Enterprise Virtualization Manager using theengine-image-uploader
command.
You have created a compressed OVF image file that can be distributed. Anyone you give it to can use the engine-image-uploader
command to upload your image into their Red Hat Enterprise Virtualization environment.
19.4.4. Basic engine-image-uploader Usage Examples
Example 19.10. Listing export storage domains using the image uploader
# engine-image-uploader list Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort): Export Storage Domain Name | Datacenter | Export Domain Status myexportdom | Myowndc | active
Example 19.11. Uploading a file using the image uploader
# engine-image-uploader -e myexportdom upload myrhel6.ovf Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
19.5. The USB Filter Editor
19.5.1. Installing the USB Filter Editor
The USB Filter Editor is a Windows tool used to configure the usbfilter.txt
policy file. The policy rules defined in this file allow or deny the pass-through of specific USB devices from client machines to virtual machines managed using the Red Hat Enterprise Virtualization Manager. The policy file resides on the Red Hat Enterprise Virtualization Manager in the following location:
/etc/ovirt-engine/usbfilter.txt
ovirt-engine
service on the Red Hat Enterprise Virtualization Manager server is restarted.
USBFilterEditor.msi
file from the Content Delivery Network: https://rhn.redhat.com/rhn/software/channel/downloads/Download.do?cid=20703. The file works with Red Hat Enterprise Virtualization 3.0, 3.1, 3.2, 3.3, and 3.4.
Note
Procedure 19.3. Installing the USB Filter Editor
- On a Windows machine, launch the
USBFilterEditor.msi
installer obtained from Red Hat Network. - Follow the steps of the installation wizard. Unless otherwise specified, the USB Filter Editor will be installed by default in either
C:\Program Files\RedHat\USB Filter Editor
orC:\Program Files(x86)\RedHat\USB Filter Editor
depending on your version of Windows. - A USB Filter Editor shortcut icon is created on your desktop.
Important
The default USB device policy provides virtual machines with basic access to USB devices; update the policy to allow the use of additional USB devices.
19.5.2. The USB Filter Editor Interface
- Double-click the USB Filter Editor shortcut icon on your desktop.
Figure 19.1. Red Hat USB Filter Editor
Table 19.2. USB Editor Fields
Name | Description |
---|---|
Class | Type of USB device; for example, printers, mass storage controllers. |
Vendor | The manufacturer of the selected type of device. |
Product | The specific USB device model. |
Revision | The revision of the product. |
Action | Allow or block the specified device. |
19.5.3. Adding a USB Policy
Add a USB policy to the USB Filter Editor.
Procedure 19.4. Adding a USB Policy
- Click the Add button. The Edit USB Criteria window opens:
Figure 19.2. Edit USB Criteria
- Use the USB Class, Vendor ID, Product ID, and Revision check boxes and lists to specify the device.Click the Allow button to permit virtual machines use of the USB device; click the Block button to prohibit the USB device from virtual machines.Click OK to add the selected filter rule to the list and close the window.
Example 19.12. Adding a Device
The following is an example of how to add USB ClassSmartcard
, deviceEP-1427X-2 Ethernet Adapter
, from manufacturerAcer Communications & Multimedia
to the list of allowed devices. - Click File → Save to save the changes.
You have added a USB policy to the USB Filter Editor. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
19.5.4. Removing a USB Policy
Remove a USB policy from the USB Filter Editor.
Procedure 19.5. Removing a USB Policy
- Select the policy to be removed.
Figure 19.3. Select USB Policy
- Click Remove. A message displays prompting you to confirm that you want to remove the policy.
Figure 19.4. Edit USB Criteria
- Click Yes to confirm that you want to remove the policy.
- Click File → Save to save the changes.
You have removed a USB policy from the USB Filter Editor. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
19.5.5. Searching for USB Device Policies
Search for attached USB devices to either allow or block them in the USB Filter Editor.
Procedure 19.6. Searching for USB Device Policies
- Click Search. The Attached USB Devices window displays a list of all the attached devices.
Figure 19.5. Attached USB Devices
- Select the device and click Allow or Block as appropriate. Double-click the selected device to close the window. A policy rule for the device is added to the list.
- Use the Up and Down buttons to change the position of the new policy rule in the list.
- Click File → Save to save the changes.
You have searched the attached USB devices. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
19.5.6. Exporting a USB Policy
USB device policy changes need to be exported and uploaded to the Red Hat Enterprise Virtualization Manager for the updated policy to take effect. Upload the policy and restart the ovirt-engine
service.
Procedure 19.7. Exporting a USB Policy
- Click Export; the Save As window opens.
- Save the file with a file name of
usbfilter.txt
. - Using a Secure Copy client, such as WinSCP, upload the
usbfilter.txt
file to the server running Red Hat Enterprise Virtualization Manager. The file must be placed in the following directory on the server:/etc/ovirt-engine/
- As the
root
user on the server running Red Hat Enterprise Virtualization Manager, restart theovirt-engine
service.# service ovirt-engine restart
The USB device policy will now be implemented on virtual machines running in the Red Hat Enterprise Virtualization environment.
19.5.7. Importing a USB Policy
An existing USB device policy must be downloaded and imported into the USB Filter Editor before you can edit it.
Procedure 19.8. Importing a USB Policy
- Using a Secure Copy client, such as WinSCP, upload the
usbfilter.txt
file to the server running Red Hat Enterprise Virtualization Manager. The file must be placed in the following directory on the server:/etc/ovirt-engine/
- Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
- Click Import to open the Open window.
- Open the
usbfilter.txt
file that was downloaded from the server.
You are able to edit the USB device policy in the USB Filter Editor.
19.6. The Log Collector Tool
19.6.1. Log Collector
engine-log-collector
. You are required to log in as the root
user and provide the administration credentials for the Red Hat Enterprise Virtualization environment. The engine-log-collector -h
command displays usage information, including a list of all valid options for the engine-log-collector
command.
19.6.2. Syntax for engine-log-collector Command
engine-log-collector
[options]
list
[all, clusters, datacenters]
engine-log-collector
[options]
collect
list
and collect
.
- The
list
parameter lists either the hosts, clusters, or data centers attached to the Red Hat Enterprise Virtualization Manager. You are able to filter the log collection based on the listed objects. - The
collect
parameter performs log collection from the Red Hat Enterprise Virtualization Manager. The collected logs are placed in an archive file under the/tmp/logcollector
directory. Theengine-log-collector
command assigns each log a specific file name.
engine-log-collector
command.
General options
--version
- Displays the version number of the command in use and returns to prompt.
-h
,--help
- Displays command usage information and returns to prompt.
--conf-file=PATH
- Sets PATH as the configuration file the tool is to use.
--local-tmp=PATH
- Sets PATH as the directory in which logs are saved. The default directory is
/tmp/logcollector
. --ticket-number=TICKET
- Sets TICKET as the ticket, or case number, to associate with the SOS report.
--upload=FTP_SERVER
- Sets FTP_SERVER as the destination for retrieved logs to be sent using FTP. Do not use this option unless advised to by a Red Hat support representative.
--log-file=PATH
- Sets PATH as the specific file name the command should use for the log output.
--quiet
- Sets quiet mode, reducing console output to a minimum. Quiet mode is off by default.
-v
,--verbose
- Sets verbose mode, providing more console output. Verbose mode is off by default.
Red Hat Enterprise Virtualization Manager Options
engine-log-collector --user=admin@internal --cluster ClusterA,ClusterB --hosts "SalesHost"*
specifies the user as admin@internal
and limits the log collection to only SalesHost
hosts in clusters A
and B
.
--no-hypervisors
- Omits virtualization hosts from the log collection.
-u USER
,--user=USER
- Sets the user name for login. The USER is specified in the format user@domain, where user is the user name and domain is the directory services domain in use. The user must exist in directory services and be known to the Red Hat Enterprise Virtualization Manager.
-r FQDN
,--rhevm=FQDN
- Sets the fully qualified domain name of the Red Hat Enterprise Virtualization Manager server from which to collect logs, where FQDN is replaced by the fully qualified domain name of the Manager. It is assumed that the log collector is being run on the same local host as the Red Hat Enterprise Virtualization Manager; the default value is
localhost
. -c CLUSTER
,--cluster=CLUSTER
- Collects logs from the virtualization hosts in the nominated CLUSTER in addition to logs from the Red Hat Enterprise Virtualization Manager. The cluster(s) for inclusion must be specified in a comma-separated list of cluster names or match patterns.
-d DATACENTER
,--data-center=DATACENTER
- Collects logs from the virtualization hosts in the nominated DATACENTER in addition to logs from the Red Hat Enterprise Virtualization Manager. The data center(s) for inclusion must be specified in a comma-separated list of data center names or match patterns.
-H HOSTS_LIST
,--hosts=HOSTS_LIST
- Collects logs from the virtualization hosts in the nominated HOSTS_LIST in addition to logs from the Red Hat Enterprise Virtualization Manager. The hosts for inclusion must be specified in a comma-separated list of host names, fully qualified domain names, or IP addresses. Match patterns are also valid.
SOS Report Options
--jboss-home=JBOSS_HOME
- JBoss installation directory path. The default is
/var/lib/jbossas
. --java-home=JAVA_HOME
- Java installation directory path. The default is
/usr/lib/jvm/java
. --jboss-profile=JBOSS_PROFILE
- Displays a quoted and space-separated list of server profiles; limits log collection to specified profiles. The default is
'rhevm-slimmed'
. --enable-jmx
- Enables the collection of run-time metrics from Red Hat Enterprise Virtualization's JBoss JMX interface.
--jboss-user=JBOSS_USER
- User with permissions to invoke JBoss JMX. The default is
admin
. --jboss-logsize=LOG_SIZE
- Maximum size in MB for the retrieved log files.
--jboss-stdjar=STATE
- Sets collection of JAR statistics for JBoss standard JARs. Replace STATE with
on
oroff
. The default ison
. --jboss-servjar=STATE
- Sets collection of JAR statistics from any server configuration directories. Replace STATE with
on
oroff
. The default ison
. --jboss-twiddle=STATE
- Sets collection of twiddle data on or off. Twiddle is the JBoss tool used to collect data from the JMX invoker. Replace STATE with
on
oroff
. The default ison
. --jboss-appxml=XML_LIST
- Displays a quoted and space-separated list of applications with XML descriptions to be retrieved. Default is
all
.
SSH Configuration
--ssh-port=PORT
- Sets PORT as the port to use for SSH connections with virtualization hosts.
-k KEYFILE
,--key-file=KEYFILE
- Sets KEYFILE as the public SSH key to be used for accessing the virtualization hosts.
--max-connections=MAX_CONNECTIONS
- Sets MAX_CONNECTIONS as the maximum concurrent SSH connections for logs from virtualization hosts. The default is
10
.
PostgreSQL Database Options
pg-user
and dbname
parameters, if they have been changed from the default values.
pg-dbhost
parameter if the database is not on the local host. Use the optional pg-host-key
parameter to collect remote logs. The PostgreSQL SOS plugin must be installed on the database server for remote log collection to be successful.
--no-postgresql
- Disables collection of database. The log collector will connect to the Red Hat Enterprise Virtualization Manager PostgreSQL database and include the data in the log report unless the
--no-postgresql
parameter is specified. --pg-user=USER
- Sets USER as the user name to use for connections with the database server. The default is
postgres
. --pg-dbname=DBNAME
- Sets DBNAME as the database name to use for connections with the database server. The default is
rhevm
. --pg-dbhost=DBHOST
- Sets DBHOST as the host name for the database server. The default is
localhost
. --pg-host-key=KEYFILE
- Sets KEYFILE as the public identity file (private key) for the database server. This value is not set by default; it is required only where the database does not exist on the local host.
19.6.3. Basic Log Collector Usage
engine-log-collector
command is run without specifying any additional parameters, its default behavior is to collect all logs from the Red Hat Enterprise Virtualization Manager and its attached hosts. It will also collect database logs unless the --no-postgresql
parameter is added. In the following example, log collector is run to collect all logs from the Red Hat Enterprise Virtualization Manager and three attached hosts.
Example 19.13. Log Collector Usage
# engine-log-collector
INFO: Gathering oVirt Engine information...
INFO: Gathering PostgreSQL the oVirt Engine database and log files from localhost...
Please provide REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
About to collect information from 3 hypervisors. Continue? (Y/n):
INFO: Gathering information from selected hypervisors...
INFO: collecting information from 192.168.122.250
INFO: collecting information from 192.168.122.251
INFO: collecting information from 192.168.122.252
INFO: finished collecting information from 192.168.122.250
INFO: finished collecting information from 192.168.122.251
INFO: finished collecting information from 192.168.122.252
Creating compressed archive...
INFO Log files have been collected and placed in /tmp/logcollector/sosreport-rhn-account-20110804121320-ce2a.tar.xz.
The MD5 for this file is 6d741b78925998caff29020df2b2ce2a and its size is 26.7M
19.7. The ISO Uploader Tool
19.7.1. The ISO Uploader Tool
engine-iso-uploader
. You must log in as the root
user and provide the administration credentials for the Red Hat Enterprise Virtualization environment to use this command. The engine-iso-uploader -h
command displays usage information, including a list of all valid options for the engine-iso-uploader
command.
19.7.2. Syntax for the engine-iso-uploader Command
engine-iso-uploader
[options]
list
engine-iso-uploader
[options]
upload
[file].[file]...[file]
list
, and upload
.
- The
list
action lists the ISO storage domains to which ISO files can be uploaded. The Red Hat Enterprise Virtualization Manager creates this list on the machine on which it is installed during the installation process. - The
upload
action uploads a single ISO file or multiple ISO files separated by spaces to the specified ISO storage domain. NFS is used by default, but SSH is also available.
upload
action.
engine-iso-uploader
command.
General Options
--version
- Displays the version of the ISO uploader command.
-h
,--help
- Displays information on how to use the ISO uploader command.
--conf-file=[PATH]
- Sets [PATH] as the configuration file the command will to use. The default is
/etc/ovirt-engine/isouploader.conf
. --log-file=[PATH]
- Sets [PATH] as the specific file name the command will use to write log output. The default is
/var/log/ovirt-engine/ovirt-iso-uploader/ovirt-iso-uploader[date].log
. --cert-file=[PATH]
- Sets [PATH] as the certificate for validating the engine. The default is
/etc/pki/ovirt-engine/ca.pem
. --insecure
- Specifies that no attempt will be made to verify the engine.
--nossl
- Specifies that SSL will not be used to connect to the engine.
--quiet
- Sets quiet mode, reducing console output to a minimum.
-v
,--verbose
- Sets verbose mode, providing more console output.
-f
,--force
- Force mode is necessary when the source file being uploaded has the same file name as an existing file in the destination ISO domain. This option forces the existing file to be overwritten.
Red Hat Enterprise Virtualization Manager Options
-u [USER]
,--user=[USER]
- Specifies the user whose credentials will be used to execute the command. The [USER] is specified in the format [username]@[domain]. The user must exist in the specified domain and be known to the Red Hat Enterprise Virtualization Manager.
-r [FQDN]
,--engine=[FQDN]
- Specifies the IP address or fully qualified domain name of the Red Hat Enterprise Virtualization Manager from which the images will be uploaded. It is assumed that the image uploader is being run from the same machine on which the Red Hat Enterprise Virtualization Manager is installed. The default value is
localhost:443
.
ISO Storage Domain Options
-i
option or the -n
option.
-i
,--iso-domain=[ISODOMAIN]
- Sets the storage domain [ISODOMAIN] as the destination for uploads.
-n
,--nfs-server=[NFSSERVER]
- Sets the NFS path [NFSSERVER] as the destination for uploads.
Connection Options
--ssh-user=[USER]
- Sets [USER] as the SSH user name to use for the upload. The default is
root
. --ssh-port=[PORT]
- Sets [PORT] as the port to use when connecting to SSH.
-k [KEYFILE]
,--key-file=[KEYFILE]
- Sets [KEYFILE] as the public key to use for SSH authentication. You will be prompted to enter the password of the user specified with
--ssh-user=[USER]
if no key is set.
19.7.3. Specifying an NFS Server
Example 19.14. Uploading to an NFS Server
# engine-iso-uploader --nfs-server=storage.demo.redhat.com:/iso/path upload RHEL6.0.iso
19.7.4. Basic ISO Uploader Usage
admin@internal
user is used because no user was specified in the command. The second command uploads an ISO file over NFS to the specified ISO domain.
Example 19.15. List Domains and Upload Image
# engine-iso-uploader list
Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
ISO Storage Domain Name | Datacenter | ISO Domain Status
ISODomain | Default | active
# engine-iso-uploader --iso-domain=[ISODomain] upload [RHEL6.iso]
Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
19.7.5. Uploading the VirtIO and Guest Tool Image Files to an ISO Storage Domain
virtio-win.iso
, virtio-win_x86.vfd
, virtio-win_amd64.vfd
, and rhev-tools-setup.iso
image files to the ISODomain
.
Example 19.16. Uploading the VirtIO and Guest Tool Image Files
# engine-iso-uploader --iso-domain=[ISODomain]
upload
/usr/share/virtio-win/virtio-win.iso
/usr/share/virtio-win/virtio-win_x86.vfd
/usr/share/virtio-win/virtio-win_amd64.vfd
/usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
19.7.6. VirtIO and Guest Tool Image Files
/usr/share/virtio-win/virtio-win.iso
/usr/share/virtio-win/virtio-win_x86.vfd
/usr/share/virtio-win/virtio-win_amd64.vfd
/usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
engine-iso-uploader
command to upload these images to your ISO storage domain. Once uploaded, the image files can be attached to and used by virtual machines.
Chapter 20. Log Files
20.1. Red Hat Enterprise Virtualization Manager Installation Log Files
Table 20.1. Installation
Log File | Description |
---|---|
/var/log/ovirt-engine/engine-cleanup_yyyy_mm_dd_hh_mm_ss.log | Log from the engine-cleanup command. This is the command used to reset a Red Hat Enterprise Virtualization Manager installation. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist. |
/var/log/ovirt-engine/engine-db-install-yyyy_mm_dd_hh_mm_ss.log | Log from the engine-setup command detailing the creation and configuration of the rhevm database. |
/var/log/ovirt-engine/rhevm-dwh-setup-yyyy_mm_dd_hh_mm_ss.log | Log from the rhevm-dwh-setup command. This is the command used to create the ovirt_engine_history database for reporting. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
/var/log/ovirt-engine/ovirt-engine-reports-setup-yyyy_mm_dd_hh_mm_ss.log | Log from the rhevm-reports-setup command. This is the command used to install the Red Hat Enterprise Virtualization Manager Reports modules. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
/var/log/ovirt-engine/setup/ovirt-engine-setup-yyyymmddhhmmss.log | Log from the engine-setup command. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
20.2. Red Hat Enterprise Virtualization Manager Log Files
Table 20.2. Service Activity
Log File | Description |
---|---|
/var/log/ovirt-engine/engine.log | Reflects all Red Hat Enterprise Virtualization Manager GUI crashes, Active Directory look-ups, Database issues, and other events. |
/var/log/ovirt-engine/host-deploy | Log files from hosts deployed from the Red Hat Enterprise Virtualization Manager. |
/var/lib/ovirt-engine/setup-history.txt | Tracks the installation and upgrade of packages associated with the Red Hat Enterprise Virtualization Manager. |
20.3. SPICE Log Files
Table 20.3.
Log Type | Log Location | To Change Log Level: |
---|---|---|
SPICE Client (Windows 7)
|
%temp%\spicex.log
|
|
SPICE Client (Windows XP)
|
C:\Documents and Settings\(User Name)\Local Settings\Temp\spicex.log
|
|
SPICE Client (Red Hat Enterprise Linux)
|
/var/log/messages
|
Launch Firefox from the command line with
SPICE_DEBUG=1 firefox .
|
USB Redirector on Windows Client
|
C:\Windows\Temp\usbclerk.log
|
Not applicable.
|
Host/Hypervisor SPICE Server
|
/var/log/libvirt/qemu/(guest_name).log
|
Run
export SPICE_DEBUG_LEVEL=5 on the host/hypervisor prior to launching the guest.
|
Windows Guest
|
C:\Windows\Temp\vdagent*
C:\Windows\Temp\vdservice*
|
Not applicable
|
Red Hat Enterprise Linux Guest
|
/var/log/spice-vdagentd.log
|
|
20.4. Red Hat Enterprise Virtualization Host Log Files
Table 20.4.
Log File | Description |
---|---|
/var/log/vdsm/libvirt.log | Log file for libvirt . |
/var/log/vdsm/spm-lock.log | Log file detailing the host's ability to obtain a lease on the Storage Pool Manager role. The log details when the host has acquired, released, renewed, or failed to renew the lease. |
/var/log/vdsm/vdsm.log | Log file for VDSM, the Manager's agent on the virtualization host(s). |
/tmp/ovirt-host-deploy-@DATE@.log | Host deployment log, copied to engine as /var/log/ovirt-engine/host-deploy/ovirt-@DATE@-@HOST@-@CORRELATION_ID@.log after the host has been successfully deployed. |
20.5. Remotely Logging Host Activities
20.5.1. Setting Up a Virtualization Host Logging Server
Red Hat Enterprise Virtualization hosts generate and update log files, recording their actions and problems. Collecting these log files centrally simplifies debugging.
Procedure 20.1. Setting up a Virtualization Host Logging Server
- Configure SELinux to allow rsyslog traffic.
# semanage port -a -t syslogd_port_t -p udp 514
- Edit
/etc/rsyslog.conf
and add below lines:$template TmplAuth, "/var/log/%fromhost%/secure" $template TmplMsg, "/var/log/%fromhost%/messages" $RuleSet remote authpriv.* ?TmplAuth *.info,mail.none;authpriv.none,cron.none ?TmplMsg $RuleSet RSYSLOG_DefaultRuleset $InputUDPServerBindRuleset remote
Uncomment the following:#$ModLoad imudp #$UDPServerRun 514
- Restart the rsyslog service:
# service rsyslog restart
Your centralized log server is now configured to receive and store the messages
and secure
logs from your virtualization hosts.
20.5.2. Configuring Red Hat Enterprise Virtualization Hypervisor Hosts to Use a Logging Server
Red Hat Enterprise Virtualization hosts generate and update log files, recording their actions and problems. Collecting these log files centrally simplifies debugging.
Procedure 20.2. Configuring Red Hat Enterprise Virtualization Hypervisor Hosts to Use a Logging Server
- Log in to your Red Hat Enterprise Virtualization Hypervisor host as
admin
to access the Hypervisors text user interface (TUI) setup screen. - Select Logging from the list of options on the left of the screen.
- Press the Tab key to reach the text entry fields. Enter the IP address or FQDN of your centralized log server and the port it uses.
- Press the Tab key to reach the Apply, and press the Enter Key.
Your Red Hat Enterprise Virtualization Hypervisor host has been configured to send messages to a centralized log server.
Chapter 21. Proxies
21.1. SPICE Proxy
21.1.1. SPICE Proxy Overview
SpiceProxyDefault
to a value consisting of the name and port of the proxy.
SpiceProxyDefault
has been set to.
21.1.2. SPICE Proxy Machine Setup
This procedure explains how to set up a machine as a SPICE Proxy. A SPICE Proxy makes it possible to connect to the Red Hat Enterprise Virtualization network from outside the network. We use Squid in this procedure to provide proxy services.
Procedure 21.1. Installing Squid on Red Hat Enterprise Linux
- Install Squid on the Proxy machine:
#
yum install squid
- Open
/etc/squid/squid.conf
. Change:http_access deny CONNECT !SSL_ports
to:http_access deny CONNECT !Safe_ports
- Restart the proxy:
#
service squid restart
- Open the default squid port:
#
iptables -A INPUT -p tcp --dport 3128 -j ACCEPT
- Make this iptables rule persistent:
#
service iptables save
You have now set up a machine as a SPICE proxy. Before connecting to the Red Hat Enterprise Virtualization network from outside the network, activate the SPICE proxy.
21.1.3. Turning on SPICE Proxy
This procedure explains how to activate (or turn on) the SPICE proxy.
Procedure 21.2. Activating SPICE Proxy
- On the Manager, use the engine-config tool to set a proxy:
#
engine-config -s SpiceProxyDefault=someProxy
- Restart the ovirt-engine service:
#
service ovirt-engine restart
The proxy must have this form:protocol://[host]:[port]
Note
Only the http protocol is supported by SPICE clients. If https is specified, the client will ignore the proxy setting and attempt a direct connection to the hypervisor.
SPICE Proxy is now activated (turned on). It is now possible to connect to the Red Hat Enterprise Virtualization network through the SPICE proxy.
21.1.4. Turning Off a SPICE Proxy
This procedure explains how to turn off (deactivate) a SPICE proxy.
Procedure 21.3. Turning Off a SPICE Proxy
- Log in to the Manager:
$
ssh root@[IP of Manager]
- Run the following command to clear the SPICE proxy:
#
engine-config -s SpiceProxyDefault=""
- Restart the Manager:
#
service ovirt-engine restart
SPICE proxy is now deactivated (turned off). It is no longer possible to connect to the Red Hat Enterprise Virtualization network through the SPICE proxy.
21.2. Squid Proxy
21.2.1. Installing and Configuring a Squid Proxy
This section explains how to install and configure a Squid Proxy to the User Portal.
Procedure 21.4. Configuring a Squid Proxy
Obtaining a Keypair
Obtain a keypair and certificate for the HTTPS port of the Squid proxy server.You can obtain this keypair the same way that you would obtain a keypair for another SSL/TLS service. The keypair is in the form of two PEM files which contain the private key and the signed certificate. In this document we assume that they are namedproxy.key
andproxy.cer
.The keypair and certificate can also be generated using the certificate authority of the oVirt engine. If you already have the private key and certificate for the proxy and do not want to generate it with the oVirt engine certificate authority, skip to the next step.Generating a Keypair
Decide on a host name for the proxy. In this procedure, the proxy is calledproxy.example.com
.Decide on the rest of the distinguished name of the certificate for the proxy. The important part here is the "common name", which contains the host name of the proxy. Users' browsers use the common name to validate the connection. It is good practice to use the same country and same organization name used by the oVirt engine itself. Find this information by logging in to the oVirt engine machine and running the following command:[root@engine ~]# openssl x509 -in /etc/pki/ovirt-engine/ca.pem -noout -subject
This command will output something like this:subject= /C=US/O=Example Inc./CN=engine.example.com.81108
The relevant part here is/C=us/O=Example Inc.
. Use this to build the complete distinguished name for the certificate for the proxy:/C=US/O=Example Inc./CN=proxy.example.com
Log in to the proxy machine and generate a certificate signing request:[root@proxy ~]# openssl req -newkey rsa:2048 -subj '/C=US/O=Example Inc./CN=proxy.example.com' -nodes -keyout proxy.key -out proxy.req
Note
The quotes around the distinguished name for the certificate are very important. Do not leave them out.The command will generate the key pair. It is very important that the private key is not encrypted (that is the effect of the -nodes option) because otherwise you would need to type the password to start the proxy server.The output of the command looks like this:Generating a 2048 bit RSA private key ......................................................+++ .................................................................................+++ writing new private key to 'proxy.key' -----
The command will generate two files:proxy.key
andproxy.req
.proxy.key
is the private key. Keep this file safe.proxy.req
is the certificate signing request.proxy.req
does not require any special protection.To generate the signed certificate, copy theprivate.csr
file to the oVirt engine machine, using the scp command:[root@proxy ~]# scp proxy.req engine.example.com:/etc/pki/ovirt-engine/requests/.
Log in to the oVirt engine machine and run the following command to sign the certificate:[root@engine ~]# /usr/share/ovirt-engine/bin/pki-enroll-request.sh --name=proxy --days=3650 --subject='/C=US/O=Example Inc./CN=proxy.example.com'
This will sign the certificate and make it valid for 10 years (3650 days). Set the certificate to expire earlier, if you prefer.The output of the command looks like this:Using configuration from openssl.conf Check that the request matches the signature Signature ok The Subject's Distinguished Name is as follows countryName :PRINTABLE:'US' organizationName :PRINTABLE:'Example Inc.' commonName :PRINTABLE:'proxy.example.com' Certificate is to be certified until Jul 10 10:05:24 2023 GMT (3650 days) Write out database with 1 new entries Data Base Updated
The generated certificate file is available in the directory/etc/pki/ovirt-engine/certs
and should be namedproxy.cer
. Copy this file to the proxy machine:[root@proxy ~]# scp engine.example.com:/etc/pki/ovirt-engine/certs/proxy.cer .
Make sure that both theproxy.key
andproxy.cer
files are present on the proxy machine:[root@proxy ~]# ls -l proxy.key proxy.cer
The output of this command will look like this:-rw-r--r--. 1 root root 4902 Jul 12 12:11 proxy.cer -rw-r--r--. 1 root root 1834 Jul 12 11:58 proxy.key
You are now ready to install and configure the proxy server.Install the Squid proxy server package
Install this system as follows:[root@proxy ~]# yum -y install squid
Configure the Squid proxy server
Move the private key and signed certificate to a place where the proxy can access them, for example to the/etc/squid
directory:[root@proxy ~]# cp proxy.key proxy.cer /etc/squid/.
Set permissions so that the "squid" user can read these files:[root@proxy ~]# chgrp squid /etc/squid/proxy.* [root@proxy ~]# chmod 640 /etc/squid/proxy.*
The Squid proxy will connect to the oVirt engine web server using the SSL protocol, and must verify the certificate used by the engine. Copy the certificate of the CA that signed the certificate of the oVirt engine web server to a place where the proxy can access it, for example/etc/squid
. The default CA certificate is located in the/etc/pki/ovirt-engine/ca.pem
file in the oVirt engine machine. Copy it with the following command:[root@proxy ~]# scp engine.example.com:/etc/pki/ovirt-engine/ca.pem /etc/squid/.
Ensure thesquid
user can read that file:[root@proxy ~]# chgrp squid /etc/squid/ca.pem [root@proxy ~]# chmod 640 /etc/squid/ca.pem
If SELinux is in enforcing mode, change the context of port 443 using the semanage tool. This permits Squid to use port 443.[root@proxy ~]# yum install -y policycoreutils-python [root@proxy ~]# semanage port -m -p tcp -t http_cache_port_t 443
Replace the existing squid configuration file with the following:https_port 443 key=/etc/squid/proxy.key cert=/etc/squid/proxy.cer ssl-bump defaultsite=engine.example.com cache_peer engine.example.com parent 443 0 no-query originserver ssl sslcafile=/etc/squid/ca.pem name=engine cache_peer_access engine allow all ssl_bump allow all http_access allow all
Restart the Squid Proxy Server
Run the following command in the proxy machine:[root@proxy ~]# service squid restart
Configure the websockets proxy
Note
This step is optional. Do this step only to use the noVNC console or the SPICE HTML 5 console.To use the noVNC or SPICE HTML 5 consoles to connect to the console of virtual machines, the websocket proxy server must be configured on the machine on which the engine is installed. If you selected to configure the websocket proxy server when prompted during installing or upgrading the engine with theengine-setup
command, the websocket proxy server will already be configured. If you did not select to configure the websocket proxy server at this time, you can configure it later by running theengine-setup
command with the following option:engine-setup --otopi-environment="OVESETUP_CONFIG/websocketProxyConfig=bool:True"
You must also ensure the ovirt-websocket-proxy service is started and will start automatically on boot:[root@engine ~]# service ovirt-websocket-proxy status [root@engine ~]# chkconfig ovirt-websocket-proxy on
Both the noVNC and the SPICE HTML 5 consoles use the websocket protocol to connect to the virtual machines, but squid proxy server does not support the websockets protocol, so this communication cannot be proxied with Squid. Tell the system to connect directly to the websockets proxy running in the machine where the engine is running. To do this, update theWebSocketProxy
configuration parameter using the "engine-config" tool:[root@engine ~]# engine-config \ -s WebSocketProxy=engine.example.com:6100 [root@engine ~]# service ovirt-engine restart
Important
If you skip this step the clients will assume that the websockets proxy is running in the proxy machine, and thus will fail to connect.Connect to the user portal using the complete URL
Connect to the User Portal using the complete URL, for instance:https://proxy.example.com/UserPortal/org.ovirt.engine.ui.userportal.UserPortal/UserPortal.html
Note
Shorter URLs, for examplehttps://proxy.example.com/UserPortal
, will not work. These shorter URLs are redirected to the long URL by the application server, using the 302 response code and the Location header. The version of Squid in Red Hat Enterprise Linux and Fedora (Squid version 3.1) does not support rewriting these headers.
You have installed and configured a Squid proxy to the User Portal.
Part III. Gathering Information About the Environment
Chapter 22. Reports, History Database Reports, and Dashboards
22.1. Reports
22.1.1. Reports
Warning
SELECT
statement. The result of the SELECT
statement populates the virtual table that the view returns. A user references the view name in PL/PGSQL statements the same way a table is referenced.
22.1.2. Database Names in Red Hat Enterprise Virtualization 3.0 and 3.1
rhevm
and a history database called rhevm_history
.
ovirt-engine
and history database is called ovirt-engine-history
.
ovirt-engine
database is equivalent to the rhevm
database. The ovirt-engine-history
database is equivalent to the rhevm_history
database.
22.1.3. JasperReports and JasperServer in Red Hat Enterprise Virtualization
22.1.4. Online Help for JasperReports
Figure 22.1. Red Hat Enterprise Virtualization Reports online help
Note
/usr/share/jasperreports-server-pro/docs/
22.1.5. Jasper Reports System Requirements
- In Red Hat Enterprise Linux 5.7 - Firefox 17 or later
- In Red Hat Enterprise Linux 6 - Firefox 17 or later
- In Windows 7 - Internet Explorer 9
- In Windows Server 2008 - Internet Explorer 9
22.1.6. Users in the Red Hat Enterprise Virtualization Reports Portal
admin
and superuser
. The passwords for these users were set during the installation of Red Hat Enterprise Virtualization Reports. Generally, additional users must be added manually.
Note
admin
user name was rhevm-admin
. If you are performing a clean installation, the user name is now admin
. In you are performing an upgrade, the user name will remain rhevm-admin
.
22.1.7. Logging in to Access the Reports Portal
superuser
and admin
accounts when you installed Red Hat Enterprise Virtualization Reports. Red Hat Enterprise Virtualization Reports does not provide default passwords.
https://YOUR.MANAGER.URL/ovirt-engine-reports/login.html
. A login screen for Red Hat Enterprise Virtualization Reports is displayed.
Note
Figure 22.2. Red Hat Enterprise Virtualization Reports login screen
ovirt-user
. Click the Login button.
Figure 22.3. Red Hat Enterprise Virtualization Reports main screen
admin
and superuser
. Generally, additional users need to be created within the Reports Portal.
22.1.8. Accessing the Red Hat Enterprise Virtualization Reports User Management Menu
You can add additional reports users, giving them access to the reports portal. Complete this procedure as a user with sufficient permissions to manage other users, like admin
.
- In to Red Hat Enterprise Virtualization reports portal, hover over the Manage button on the top menu bar.
- Click on Users in the drop-down menu that appears to access the Manage Users interface. It contains three panes:
- Organizations
- Users
- Properties
- Select a user in the Users pane by clicking on the name of the user. Information about the user displays in the Properties pane.
- Click the Edit button at the bottom of the user's Properties pane.The Properties pane contains these fields:
- User name,
- User ID,
- Email,
- Password (required),
- Confirm Password (required),
- A User is enabled check box,
- A The user is defined externally check box,
- A list of Roles Available to the user, and
- A list of Roles Assigned to the user.
- Click the Save button.
You have given more users permissions to access the reports portal.
22.1.9. Reports Portal User Roles
- ROLE_ADMINISTRATOR - Can create/edit/delete reports, dashboards, ad hoc reports, and manage the server.
- ROLE_USER - Can create/edit/delete ad hoc reports and view reports and dashboards.
- ROLE_ANONYMOUS - Can log in and look at reports and dashboards.
Figure 22.4. JasperReports user roles
22.1.10. Navigating Reports and Dashboards
Figure 22.5. Red Hat Enterprise Virtualization Reports home screen
Figure 22.6. Red Hat Enterprise Virtualization Reports Filter pane
Table 22.1. Navigation Filters
Filter | Description |
---|---|
Available Resources | Select from All, Modified by me, or Viewed by me. |
Resource type | Choose from the types of available resources including Reports, Ad Hoc views, Dashboards, and more. |
Timeframe | Choose a time frame you'd like to see information from. |
Schedule | Filter by data collection schedule. |
22.1.11. Report Parameters
Figure 22.7. Red Hat Enterprise Virtualization Reports - Reports List
Note
Figure 22.8. Report Parameter Selection
Many report parameters are cascading input fields. This means the selection made for one parameter changes the options available for another parameter. The Data Center and Cluster parameters are cascading. Once a user selects a data center, only clusters within that data center are available for selection. Similarly, if a user selects a cluster, the Host Type field updates to show only host types that exist in the selected cluster. Cascading parameters filter out objects that do not contain child objects relevant to the report. For example, a report pertaining to virtual machines removes the selection of clusters that do not contain virtual machines. A report pertaining to both virtual machines and hosts only provides a selection from clusters containing both virtual machines and hosts.
Objects deleted (removed) from the system are still recorded in the reporting history database. Select deleted objects, such as clusters, data centers and hosts, as values for report parameters if required. The bottom of the parameter options list shows deleted objects, which are suffixed with the date of removal from the system.
22.1.12. Right-click Reporting Integration with the Red Hat Enterprise Virtualization Administration Portal
Figure 22.9. Right-click Reporting
Figure 22.10. Alternative to Right-click Reporting
22.1.13. Executive Reports
22.1.13.1. Executive reports: Active Virtual Machines by OS
Active Virtual Machines by OS
report shows a summary of the number of active virtual machines in a given time period, broken down by operating system. The following parameters are provided to run this report:
Table 22.2. Active Virtual Machines by OS Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The report includes only virtual machines in the selected data center. The options list shows only data centers that contain virtual machines. |
Cluster | The report only includes virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report only includes virtual machines of the selected type. Possible types are Server and Desktop . The options list shows only types that exist in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
22.1.13.2. Executive Reports: Cluster Capacity Vs Usage
Cluster Capacity Vs Usage
report shows the relationship between system capacity and usage (workload) over a given time period. Capacity is expressed in terms of CPU cores and physical memory, while usage is expressed as vCPUs and virtual machine memory. The following parameters must be provided to run this report:
Table 22.3. Cluster Capacity Vs Usage Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list contains only data centers that contain clusters. |
Cluster | The report only includes the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all clusters in the selected data center. |
22.1.13.3. Executive Reports: Host Operating System Break Down
Host OS Break Down
report indicates the number of hosts running each operating system version over a given time period. The following parameters must be provided to run this report:
Table 22.4. Host OS Break Down Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
22.1.13.4. Executive Reports: Summary of Host Usage Resources
Summary of Host Usage Resources
report shows a scatter plot of average host resource utilization for a given time period in terms of CPU and memory usage. The following parameters must be provided to run this report:
Table 22.5. Summary of Host Usage Resources Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
22.1.14. Inventory Reports
22.1.14.1. Inventory Reports: Hosts Inventory
Hosts Inventory
report shows a list of all hosts in the selected data center and cluster. The following parameters must be provided to run this report:
Table 22.6. Hosts Inventory Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
22.1.14.2. Inventory Reports: Storage Domain Over Time
Storage Domain Size Over Time
report shows a line graph contrasting the total available and total used space for a single storage domain over time for a given period. The following parameters must be provided to run this report:
Table 22.7. Storage Domain Size Over Time Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. The list of options for the Storage Domain name parameter includes only storage domains that were attached during the specified period. |
Data Center | The options list for the Storage Domain Name parameter shows only storage domains in this selected data center. |
Storage Domain Type | The options list for the Storage Domain Name parameter shows only storage domains of this selected type. |
Storage Domain Name | The report refers to the storage domain selected. A report is only for a single storage domain and the user must select a storage domain. The list of options shows only storage domains that were attached to the data center during the selected period. |
22.1.14.3. Inventory Reports: Virtual Machines Inventory
Virtual Machines Inventory
report shows a list of all virtual machines in the selected data center and cluster. The following parameters must be provided to run this report:
Table 22.8. Virtual Machines Inventory Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
22.1.14.4. Inventory Reports: Cloud Provider Virtual Machine Inventory
Table 22.9. Cloud Provider Virtual Machine Inventory Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
22.1.14.5. Inventory Reports: Storage Domains
Storage Domains Inventory
report shows a list of storage domains in the selected data center and of the selected type. The following parameters must be provided to run this report:
Table 22.10. Storage Domain Inventory Parameters
Parameter | Description |
---|---|
Show DeletedDetached Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Data Center | The options list for the Storage Domain Name parameter shows only storage domains in this selected data center. |
Storage Domain Type | The options list for the Storage Domain Name parameter shows only storage domains of this selected type. |
22.1.15. Service Level Reports
22.1.15.1. Service Level Reports: Cluster Host Uptime
Cluster Host Uptime
report shows the weighted average uptime of hosts within a cluster for a given period of time. This report also provides a table listing the total planned (maintenance) and unplanned down time for each host. The following parameters must be provided to run this report:
Table 22.11. Cluster Host Uptime Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
22.1.15.2. Service Level Reports: Cluster Quality of Service - Hosts
Cluster Quality of Services - Hosts
report shows the amount of time hosts sustain load above a specified threshold for a given time period. Load is defined in terms of CPU usage percent and memory usage percent. The following parameters must be provided to run this report:
Table 22.12. Cluster Quality of Service - Hosts Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
CPU Threshold | The report measures the quality of service as the amount of time hosts sustain load above a given threshold. The CPU Threshold defines a load threshold as a percentage of total CPU usage on the host. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A CPU Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
Memory Threshold | The report measures the quality of service as the amount of time hosts sustain load above a given threshold. The Memory Threshold defines a load threshold as a percentage of total memory usage on the host. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A Memory Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
22.1.15.3. Service Level Reports: Cluster Quality of Service - Virtual Machines
Cluster Quality of Service - Virtual Machines
report shows the amount of time virtual machines sustain load above a specified threshold for a given time period. Load is defined in terms of CPU usage percent and memory usage percent. The following parameters must be provided to run this report:
Table 22.13. Cluster Quality of Service - Virtual Machines Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
CPU Threshold | The report measures quality of service as the amount of time virtual machines sustain load above a given threshold. The CPU Threshold defines a load threshold as a percentage of total CPU usage on the virtual machine. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A CPU Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
Memory Threshold | The reports measures quality of service as the amount of time virtual machines sustain load above a given threshold. The Memory Threshold defines a load threshold as a percentage of total memory usage on the virtual machine. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A Memory Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
22.1.15.4. Service Level Reports: Single Host Uptime
Single Host Uptime
report shows the total proportion of uptime, planned downtime and unplanned downtime for a single host. The following parameters must be provided to run this report:
Table 22.14. Single Host Uptime Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Host Name parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and a user must select a host. |
22.1.15.5. Service Level Reports: Top 10 Downtime Hosts
Top 10 Downtime Hosts
report shows the total proportion of uptime, planned downtime and unplanned downtime for the 10 hosts with the greatest amount of downtime. The following parameters must be provided to run this report:
Table 22.15. Top 10 Downtime Hosts Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list contains only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
22.1.15.6. Service Level Reports: High Availability Virtual Servers Uptime
High Availability Virtual Servers Uptime
report shows the weighted average uptime of high availability virtual servers within a cluster for a given period of time. The report also provides a table listing the total uptime and unplanned down time for each virtual server. The following parameters must be provided to run this report:
Table 22.16. High Availability Virtual Servers Uptime Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual servers in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual servers in the selected data center. |
22.1.16. Trend Reports
22.1.16.1. Trend Reports: Five Least Utilized Hosts (Over Time)
Five Least Utilized Hosts (Over Time)
report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five hosts with the lowest load factor for a given period of time. The following parameters must be provided to run this report:
Table 22.17. Five Least Utilized Hosts (Over Time) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
22.1.16.2. Trend Reports: Five Least Utilized Virtual Machines (Over Time)
Five Least Utilized Virtual Machines (Over Time)
report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five virtual machines with the lowest load factor for a given period of time. The following parameters must be provided to run this report:
Table 22.18. Five Least Utilized Virtual Machines (Over Time) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
22.1.16.3. Trend Reports: Five Most Utilized Hosts (Over Time)
Five Most Utilized Hosts (Over Time)
report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five hosts with the highest load factor for a given period of time. The following parameters must be provided to run this report:
Table 22.19. Five Most Utilized Hosts (Over Time) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
22.1.16.4. Trend Reports: Five Most Utilized Virtual Machines (Over Time)
Five Most Utilized Virtual Machines (Over Time)
report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five virtual machines with the highest load factor for a given period of time. The following parameters must be provided to run this report:
Table 22.20. Five Most Utilized Virtual Machines (Over Time) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers which contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
22.1.16.5. Trend Reports: Multiple Hosts Resource Usage (Over Time)
Multiple Hosts Resource Usage (Over Time)
report shows the daily peak load, in terms of CPU and memory usage, for up to five selected hosts over a given period of time. The following parameters must be provided to run this report:
Table 22.21. Multiple Hosts Resource Usage (Over Time) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Hosts list parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Hosts list parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Hosts list parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Hosts list parameter includes all host types. |
Hosts list | The report includes all hosts selected in the host list. Select any number of hosts up to a maximum of five. |
22.1.16.6. Trend Reports: Multiple Virtual Machines Resource Usage (Over Time)
Multiple Virtual Machines Resource Usage (Over Time)
report shows the daily peak load, in terms of CPU and memory usage, for up to five selected virtual machines over a given period of time. The following parameters must be provided to run this report:
Table 22.22. Multiple Virtual Machines Resource Usage (Over Time) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM List parameter include only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM List parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM List parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM List parameter includes all virtual machine types. |
Virtual Machine List | The report includes all virtual machines selected in the virtual machine list. Select any number of virtual machines up to a maximum of five. |
22.1.16.7. Trend Reports: Single Host Resource Usage (Days of Week)
Single Host Resource Usage (Days of Week)
report shows various resource utilization metrics for a single host over a given period of time and broken down by day of the week. The metrics include CPU usage, memory usage, number of active virtual machines and network usage. The following parameters must be provided to run this report:
Table 22.23. Single Host Resource Usage (Days of Week) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Host Name parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and the user must select a host. |
22.1.16.8. Trend Reports: Single Host Resource Usage (Hour of Day)
Single Host Resource Usage (Hour of Day)
report shows a variety of resource utilization metrics for a single host over a given period of time, broken down by hour of the day (0-23). The metrics include CPU usage, memory usage, number of active virtual machines and network usage. The following parameters must be provided to run this report:
Table 22.24. Single Host Resource Usage (Hour of Day) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | Only hosts of the selected type will be included in the list of options for the Host Name parameter. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and the user must select a host. |
22.1.16.9. Trend Reports: Single Virtual Machine Resources (Days of Week)
Single Virtual Machine Resources (Days of Week)
report shows a variety of resource utilization metrics for a single virtual machine over a given period of time, broken down by day of the week. The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 22.25. Single Virtual Machine Resources (Days of Week) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
22.1.16.10. Trend Reports: Single Virtual Machine Resources (Hour of Day)
Single Virtual Machine Resources (Hour of Day)
report shows a variety of resource utilization metrics for a single virtual machine over a given period of time, broken down by hour of the day (0-23). The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 22.26. Single Virtual Machine Resources (Hour of Day) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers which contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
22.1.16.11. Trend Reports: Single Virtual Machine Resources (Over Time)
Single Virtual Machine Resources (Over Time)
report shows a variety of resource utilization metrics for a single virtual machine over a given period of time. The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 22.27. Single Virtual Machine Resources (Over Time) Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter lists only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
22.1.17. Ad Hoc Reports
Figure 22.11. Create Ad Hoc Report - Administrator's View
Working with the Ad Hoc Editor
section of the online help explains the ad hoc report interface in detail.
22.1.18. Reports Schema: Tag History and ENUM Views
Note
delete_date
and detach_date
do not appear in latest views because these views provide the latest configuration of living entities, which, by definition, have not been deleted.
Table 22.28. Tag Relations History in the System
Name | Type | Description |
---|---|---|
history_id | integer | The unique ID of this row in the table. |
entity_id | uuid | Unique ID of the entity or tag in the system. |
entity_type | smallint |
|
parent_id | uuid | Unique ID of the entity or tag in the system. |
attach_date | timestamp with time zone | The date the entity or tag was attached to the entity or tag. |
detach_date | timestamp with time zone | The date the entity or tag was detached from the entity or tag. |
Table 22.29. v3_2_tag_details_view\v3_2_latest_tag_details_view
Name | Type | Description |
---|---|---|
history_id | integer | The unique ID of this row in the table. |
tag_id | uuid | Unique ID of the tag in the system. |
tag_name | varchar(50) | Name of the tag, as displayed in the tag tree. |
tag_description | varchar(4000) | Description of the tag, as displayed in the edit dialog. |
tag_path | varchar(4000) | The path to the tag in the tree. |
tag_level | smallint | The tag level in the tree. |
create_date | timestamp with time zone | The date this tag was added to the system. |
update_date | timestamp with time zone | The date this tag was changed in the system. |
delete_date | timestamp with time zone | The date this tag was deleted from the system. |
Table 22.30. v3_2_enum_translator_view
Name | Type | Description |
---|---|---|
enum_type | varchar(40) | The type of ENUM. |
enum_key | smallint | The key of the ENUM. |
value | varchar(40) | The value of the ENUM. |
22.2. History Database Reports
22.2.1. Red Hat Enterprise Virtualization History Database
ovirt_engine_history
) which tracks the engine
database over time.
Important
22.2.2. Tracking Configuration History
ovirt-engine-dwhd
, tracks three types of changes:
- A new entity is added to the engine database - the ETL Service replicates the change to the ovirt_engine_history database as a new entry.
- An existing entity is updated - the ETL Service replicates the change to the ovirt_engine_history database as a new entry.
- An entity is removed from the engine database - A new entry in the ovirt_engine_history database flags the corresponding entity as removed. Removed entities are only flagged as removed. To maintain correctness of historical reports and representations, they are not physically removed.
- a
history_id
to indicate the configuration version of the entity; - a
create_date
field to indicate when the entity was added to the system; - an
update_date
field to indicate when the entity was changed; and - a
delete_date
field to indicate the date the entity was removed from the system.
22.2.3. Recording Statistical History
22.2.4. Tracking Tag History
- A tag is created in the Administration Portal - the ETL Service copies the tag details, position in the tag tree and relation to other objects in the tag tree.
- A entity is attached to the tag tree in the Administration Portal - the ETL Service replicates the addition to the ovirt_engine_history database as a new entry.
- A tag is updated - the ETL Service replicates the change of tag details to the ovirt_engine_history database as a new entry.
- An entity or tag branch is removed from the Administration Portal - the ovirt_engine_history database flags the corresponding tag and relations as removed in new entries. Removed tags and relations are only flagged as removed or detached. In order to maintain correctness of historical reports and representations, they are not physically removed.
- A tag branch is moved - the corresponding tag and relations are updated as new entries. Moved tags and relations are only flagged as updated. In order to maintain correctness of historical reports and representations, they are not physically updated.
22.2.5. Connecting to the History Database
ovirt_engine_history
database resides within the instance of PostgreSQL that the installer creates during Red Hat Enterprise Virtualization Manager installation.
The history data warehouse can also be accessed remotely. All of the PostgreSQL configuration files that you need to change are located in /var/lib/pgsql/data
Procedure 22.1. Enabling Remote Access to the History Database
- Edit the
postgresql.conf
file, and add two parameters.ssl=on
listen_addresses = "*"
To allow access by specific hosts, use a comma-separated list of IP addresses or hostnames instead of "*".
- Edit
pg_hba.conf
to add:hostssl all all <net address/mask> md5
Where <net address/mask> is the IP address and netmask of allowed hosts; for example, 192.168.0.0/24. - Create soft links for the following certificate and key, so that they can be located by PostgreSQL:
# ln -s /etc/pki/ovirt-engine/certs/engine.cer /var/lib/pgsql/data/server.crt
# ln -s /etc/pki/ovirt-engine/keys/engine_id_rsa /var/lib/pgsql/data/server.key
The certificate and key were created by the Red Hat Enterprise Virtualization Manager during installation. However, PostgreSQL requires a specific location (/var/lib/pgsql/data/
) and file names (server.crt
andserver.key
) for the certificate and key.Alternatively, you can create new certificate and key files using the commands documented in the PostgreSQL Manual. - Stop the engine service:
# service ovirt-engine stop
- Restart the PostgreSQL service:
# service postgresql restart
- Remove and then deploy the Jasper WAR files:
- Remove the
.deployed
file:# rm /var/lib/ovirt-engine/deployments/rhevm-reports.war.deployed
This creates an.undeployed
file:/var/lib/ovirt-engine/deployments/rhevm-reports.war.undeployed
If the.undeployed
file is present, then the application is down. - Remove the
.undeployed
file:# rm /var/lib/ovirt-engine/deployments/rhevm-reports.war.undeployed
- Deploy the WAR file:
# touch /var/lib/ovirt-engine/deployments/rhevm-reports.war.dodeploy
This creates a.deployed
file:/var/lib/ovirt-engine/deployments/rhevm-reports.war.deployed
- Add an iptables rule to allow external machines to connect to the Manager and access PostgreSQL. For example, in a default iptables configuration, the following command inserts a new rule after the SSH rule:
iptables -I INPUT 5 -p tcp -m state --state NEW --dport 5432 -j ACCEPT
- Start the engine service.
# service ovirt-engine start
You have enabled a remote user with acceptable credentials to access the Red Hat Enterprise Virtualization history database.
22.2.6. Allowing Read-Only Access to the History Database
To allow access to the history database without allowing edits, you must create a read-only PostgreSQL user that can log in to and read from the ovirt_engine_history
database. This procedure must be executed on the system on which the history database is installed.
Procedure 22.2. Allowing Read-Only Access to the History Database
- Create the user to be granted read-only access to the history database:
# psql -U postgres -c "CREATE ROLE [user name] WITH LOGIN ENCRYPTED PASSWORD '[password]';" -d ovirt_engine_history
- Grant the newly created user permission to connect to the history database:
# psql -U postgres -c "GRANT CONNECT ON DATABASE ovirt_engine_history TO [user name];"
- Grant the newly created user usage of the
public
schema:# psql -U postgres -c "GRANT USAGE ON SCHEMA public TO [user name];" ovirt_engine_history
- Generate the rest of the permissions that will be granted to the newly created user and save them to a file:
# psql -U postgres -c "SELECT 'GRANT SELECT ON ' || relname || ' TO [user name];' FROM pg_class JOIN pg_namespace ON pg_namespace.oid = pg_class.relnamespace WHERE nspname = 'public' AND relkind IN ('r', 'v');" --pset=tuples_only=on ovirt_engine_history > grant.sql
- Use the file you created in the previous step to grant permissions to the newly created user:
# psql -U postgres -f grant.sql ovirt_engine_history
- Remove the file you used to grant permissions to the newly created user:
# rm grant.sql
You can now access the ovirt_engine_history
database with the newly created user using the following command:
# psql -U [user name] ovirt_engine_history
SELECT
statements against tables and views in the ovirt_engine_history
database succeed, while modifications fail.
22.2.7. History Database Report Examples
This example produces a resource utilization report for a single host. The resource utilization report provides CPU- and memory-usage percentage information from readings taken at one-minute intervals. This kind of report is useful for gaining insight into the load factor of an individual host over a short period of time. The report is defined by the following SQL query. Ensure the values provided for the host_name and history_datetime components of the where
clause are substituted with the appropriate values for your environment and that the latest configuration is in use.
Example 22.1. Report query for resource utilization on a single host
select history_datetime as DateTime, cpu_usage_percent as CPU, memory_usage_percent as Memory from host_configuration, host_samples_history where host_configuration.host_id = host_samples_history.host_id and host_name = 'example.labname.abc.company.com' and host_configuration.history_id in (select max(a.history_id) from host_configuration as a where host_configuration.host_id = a.host_id) and history_datetime >= '2011-07-01 18:45' and history_datetime <= '2011-07-31 21:45'
Table 22.31. Resource Utilization for a Single Host Example Data
DateTime | CPU | Memory |
---|---|---|
2010-07-01 18:45 | 42 | 0 |
2010-07-01 18:46 | 42 | 0 |
2010-07-01 18:47 | 42 | 1 |
2010-07-01 18:48 | 33 | 0 |
2010-07-01 18:49 | 33 | 0 |
2010-07-01 18:50 | 25 | 1 |
Figure 22.12. Single host utilization line graph
This example produces an aggregated resource utilization report across all hosts in the Red Hat Enterprise Virtualization Manager environment. Aggregated usage percentages for CPU and memory are shown with an hourly temporal resolution. This kind of report reveals utilization trends for the entire environment over a long period of time and is useful for capacity planning purposes. The following SQL query defines the report. Ensure the values provided for the history_datetime components of the where
clause are substituted with appropriate values for your environment.
Example 22.2. Report query for resource utilization across all hosts
select extract(hour from history_datetime) as Hour, avg(cpu_usage_percent) as CPU, avg(memory_usage_percent) as Memory from host_hourly_history where history_datetime >= '2011-07-01' and history_datetime < '2011-07-31' group by extract(hour from history_datetime) order by extract(hour from history_datetime)
Table 22.32. Resource utilization across all hosts example data
Hour | CPU | Memory |
---|---|---|
0 | 39 | 40 |
1 | 38 | 38 |
2 | 37 | 32 |
3 | 35 | 45 |
4 | 35 | 37 |
5 | 36 | 37 |
Figure 22.13. Total system utilization line graph
This example filters the latest virtual machine configuration list using the history tag tables. This kind of report demonstrates usage of the tags tree built in the Red Hat Enterprise Virtualization Manager to filter lists. The following SQL query defines this report. This query uses a predefined function that receives tag history IDs and returns the tag path with latest names of the tags in the Administration Portal. Ensure the values provided for the function result components of the where
clause are substituted with appropriate values for your environment.
Example 22.3.
SELECT vm_name FROM vm_configuration inner join latest_tag_relations_history on (vm_configuration.vm_id = latest_tag_relations_history.entity_id) inner join latest_tag_details on (latest_tag_details.tag_id = latest_tag_relations_history.parent_id) WHERE getpathinnames(latest_tag_details.history_id) like '/root/tlv%'
Table 22.33. Tag Filtering of Latest Virtual Machine Configuration
vm_name |
---|
RHEL6-Pool-67 |
RHEL6-Pool-5 |
RHEL6-Pool-6 |
RHEL6-23 |
This example produces a list of all current virtual machines names, types and operating systems in the Red Hat Enterprise Virtualization Manager environment. This kind of report demonstrates the usage of the ENUM table. The following SQL query defines this report:
Example 22.4.
SELECT vm_name, vm_type, operating_system FROM vm_configuration inner join enum_translator as vm_type_value on (vm_type_value.enum_type = 'VM_TYPE' and vm_configuration.vm_type = vm_type_value.enum_key) inner join enum_translator as os_value on (os_value.enum_type = 'OS_TYPE' and vm_configuration.operating_system = os_value.enum_key)
Table 22.34. Current Virtual Machines' Names, Types, and Operating Systems
vm_name | vm_type | operating_system |
---|---|---|
RHEL6-Pool-2 | Desktop | RHEL 6 x64 |
RHEL6-Pool-1 | Desktop | RHEL 6 x64 |
RHEL6-Pool-3 | Desktop | RHEL 6 x64 |
RHEL6-Pool-4 | Desktop | RHEL 6 x64 |
RHEL6-Pool-5 | Desktop | RHEL 6 x64 |
22.3. Dashboards
22.3.1. Dashboards
Designer
, in the Reports Portal. For more information on dashboards, consult the JasperReports documentation by clicking the Help in the top menu bar of the Reports Portal.
22.3.2. Inventory Dashboard
Inventory Dashboard
provides an executive summary of the inventory of a data center over a given period of time. The dashboard includes average disk use, number of active virtual machines, and a breakdown of host operating systems. The following parameters can be modified for this dashboard:
Table 22.35. Inventory Dashboard Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
22.3.3. Trends Dashboard
Trends Dashboard
provides an executive summary of the trends in a data center over a given period of time. The dashboard includes graphs of CPU and memory usage over time for the most highly utilized hosts and virtual machines in the data center. The following parameters can be modified for this dashboard:
Table 22.36. Trends Dashboard Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
22.3.4. Uptime Dashboard
Uptime Dashboard
provides an executive summary of the service level and uptime for a data center over a given period of time. The dashboard includes details on total uptime for each cluster in the data center for the period. The following parameters can be modified for this dashboard:
Table 22.37. Uptime Dashboard Parameters
Parameter | Description |
---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
22.3.5. Integrated Reporting Dashboard in the Red Hat Enterprise Virtualization Administration Portal
Figure 22.14. Reports Dashboard
Datacenter Dashboard
, Cluster Dashboard
, and System Dashboard
.
Appendix A. Firewalls
A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
engine-setup
script is able to configure the firewall automatically, but this overwrites any pre-existing firewall configuration.
engine-setup
command saves a list of the iptables
rules required in the /usr/share/ovirt-engine/conf/iptables.example
file.
80
and 443
) listed here.
Table A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
Port(s) | Protocol | Source | Destination | Purpose |
---|---|---|---|---|
- | ICMP |
|
| When registering to the Red Hat Enterprise Virtualization Manager, virtualization hosts send an ICMP ping request to the Manager to confirm that it is online. |
22 | TCP |
|
| SSH (optional) |
80, 443 | TCP |
|
|
Provides HTTP and HTTPS access to the Manager.
|
Important
NFSv4
- TCP port
2049
for NFS.
NFSv3
- TCP and UDP port
2049
for NFS. - TCP and UDP port
111
(rpcbind
/sunrpc
). - TCP and UDP port specified with
MOUNTD_PORT="port"
- TCP and UDP port specified with
STATD_PORT="port"
- TCP port specified with
LOCKD_TCPPORT="port"
- UDP port specified with
LOCKD_UDPPORT="port"
MOUNTD_PORT
, STATD_PORT
, LOCKD_TCPPORT
, and LOCKD_UDPPORT
ports are configured in the /etc/sysconfig/nfs
file.
A.2. Virtualization Host Firewall Requirements
Table A.2. Virtualization Host Firewall Requirements
Port(s) | Protocol | Source | Destination | Purpose |
---|---|---|---|---|
22 | TCP |
|
| Secure Shell (SSH) access. |
161 | UDP |
|
| Simple network management protocol (SNMP). |
5900 - 6923 | TCP |
|
|
Remote guest console access via VNC and SPICE. These ports must be open to facilitate client access to virtual machines.
|
5989 | TCP, UDP |
|
|
Used by Common Information Model Object Managers (CIMOM) to monitor virtual machines running on the virtualization host. To use a CIMOM to monitor the virtual machines in your virtualization environment then you must ensure that this port is open.
|
16514 | TCP |
|
|
Virtual machine migration using
libvirt .
|
49152 - 49216 | TCP |
|
|
Virtual machine migration and fencing using VDSM. These ports must be open facilitate both automated and manually initiated migration of virtual machines.
|
54321 | TCP |
|
|
VDSM communications with the Manager and other virtualization hosts.
|
Example A.1. Option Name: IPTablesConfig
*filter :INPUT ACCEPT [0:0] :FORWARD ACCEPT [0:0] :OUTPUT ACCEPT [0:0] -A INPUT -m state --state ESTABLISHED,RELATED -j ACCEPT -A INPUT -p icmp -j ACCEPT -A INPUT -i lo -j ACCEPT # vdsm -A INPUT -p tcp --dport 54321 -j ACCEPT # libvirt tls -A INPUT -p tcp --dport 16514 -j ACCEPT # SSH -A INPUT -p tcp --dport 22 -j ACCEPT # guest consoles -A INPUT -p tcp -m multiport --dports 5900:6923 -j ACCEPT # migration -A INPUT -p tcp -m multiport --dports 49152:49216 -j ACCEPT # snmp -A INPUT -p udp --dport 161 -j ACCEPT # Reject any other input traffic -A INPUT -j REJECT --reject-with icmp-host-prohibited -A FORWARD -m physdev ! --physdev-is-bridged -j REJECT --reject-with icmp-host-prohibited COMMIT
A.3. Directory Server Firewall Requirements
Table A.3. Host Firewall Requirements
Port(s) | Protocol | Source | Destination | Purpose |
---|---|---|---|---|
88, 464 | TCP, UDP |
|
| Kerberos authentication. |
389, 636 | TCP |
|
| Lightweight Directory Access Protocol (LDAP) and LDAP over SSL. |
A.4. Database Server Firewall Requirements
Table A.4. Host Firewall Requirements
Port(s) | Protocol | Source | Destination | Purpose |
---|---|---|---|---|
5432 | TCP, UDP |
|
| Default port for PostgreSQL database connections. |
Appendix B. VDSM and Hooks
B.1. VDSM
B.2. VDSM Hooks
/usr/libexec/vdsm/hooks/nn_event-name/
on the host in alphanumeric order. By convention each hook script is assigned a two digit number, included at the front of the file name, to ensure that the order in which the scripts will be run in is clear. You are able to create hook scripts in any programming language, Python will however be used for the examples contained in this chapter.
Warning
B.3. Extending VDSM with Hooks
B.4. Supported VDSM Events
Table B.1. Supported VDSM Events
Name | Description |
---|---|
before_vm_start | Before virtual machine starts. |
after_vm_start | After virtual machine starts. |
before_vm_cont | Before virtual machine continues. |
after_vm_cont | After virtual machine continues. |
before_vm_pause | Before virtual machine pauses. |
after_vm_pause | After virtual machine pauses. |
before_vm_hibernate | Before virtual machine hibernates. |
after_vm_hibernate | After virtual machine hibernates. |
before_vm_dehibernate | Before virtual machine dehibernates. |
after_vm_dehibernate | After virtual machine dehibernates. |
before_vm_migrate_source | Before virtual machine migration, run on the source hypervisor host from which the migration is occurring. |
after_vm_migrate_source | After virtual machine migration, run on the source hypervisor host from which the migration is occurring. |
before_vm_migrate_destination | Before virtual machine migration, run on the destination hypervisor host to which the migration is occurring. |
after_vm_migrate_destination | After virtual machine migration, run on the destination hypervisor host to which the migration is occurring. |
after_vm_destroy | After virtual machine destruction. |
before_vdsm_start | Before VDSM is started on the hypervisor host. before_vdsm_start hooks are executed as the user root, and do not inherit the environment of the VDSM process. |
after_vdsm_stop | After VDSM is stopped on the hypervisor host. after_vdsm_stop hooks are executed as the user root, and do not inherit the environment of the VDSM process. |
before_nic_hotplug | Before the NIC is hot plugged into the virtual machine. |
after_nic_hotplug | After the NIC is hot plugged into the virtual machine. |
before_nic_hotunplug | Before the NIC is hot unplugged from the virtual machine |
after_nic_hotunplug | After the NIC is hot unplugged from the virtual machine. |
after_nic_hotplug_fail | After hot plugging the NIC to the virtual machine fails. |
after_nic_hotunplug_fail | After hot unplugging the NIC from the virtual machine fails. |
before_disk_hotplug | Before the disk is hot plugged into the virtual machine. |
after_disk_hotplug | After the disk is hot plugged into the virtual machine. |
before_disk_hotunplug | Before the disk is hot unplugged from the virtual machine |
after_disk_hotunplug | After the disk is hot unplugged from the virtual machine. |
after_disk_hotplug_fail | After hot plugging the disk to the virtual machine fails. |
after_disk_hotunplug_fail | After hot unplugging the disk from the virtual machine fails. |
before_device_create | Before creating a device that supports custom properties. |
after_device_create | After creating a device that supports custom properties. |
before_update_device | Before updating a device that supports custom properties. |
after_update_device | After updating a device that supports custom properties. |
before_device_destroy | Before destroying a device that supports custom properties. |
after_device_destroy | After destroying a device that supports custom properties. |
before_device_migrate_destination | Before device migration, run on the destination hypervisor host to which the migration is occurring. |
after_device_migrate_destination | After device migration, run on the destination hypervisor host to which the migration is occurring. |
before_device_migrate_source | Before device migration, run on the source hypervisor host from which the migration is occurring. |
after_device_migrate_source | After device migration, run on the source hypervisor host from which the migration is occurring. |
B.5. The VDSM Hook Environment
vdsm
user and inherit the environment of the VDSM process. The exceptions are hook scripts triggered by the before_vdsm_start
and after_vdsm_stop
events. Hook scripts triggered by these events run as the root
user and do not inherit the environment of the VDSM process.
B.6. The VDSM Hook Domain XML Object
_hook_domxml
variable is appended to the environment. This variable contains the path of the libvirt domain XML representation of the relevant virtual machine. Several hooks are an exception to this rule, as outlined below.
_hook_domxml
variable of the following hooks contains the XML representation of the NIC and not the virtual machine.
*_nic_hotplug_*
*_nic_hotunplug_*
*_update_device
*_device_create
*_device_migrate_*
Important
before_migration_destination
and before_dehibernation
hooks currently receive the XML of the domain from the source host. The XML of the domain at the destination will have various differences.
vmId
.
B.7. Defining Custom Properties
engine-config
command. Run this command as the root
user on the host where Red Hat Enterprise Virtualization Manager is installed.
UserDefinedVMProperties
and CustomDeviceProperties
configuration keys are used to store the names of the custom properties supported. Regular expressions defining the valid values for each named custom property are also contained in these configuration keys.
ovirt-engine
service must be restarted for the new values to take effect.
Example B.1. Virtual Machine Properties - Defining the smartcard
Custom Property
- Check the existing custom properties defined by the
UserDefinedVMProperties
configuration key using the following command:# engine-config -g UserDefinedVMProperties
As shown by the output below, the custom propertymemory
is already defined. The regular expression^[0-9]+$
ensures that the custom property will only ever contain numeric characters.# engine-config -g UserDefinedVMProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties: version: 3.3 UserDefinedVMProperties : memory=^[0-9]+$ version: 3.2
- Because the
memory
custom property is already defined in theUserDefinedVMProperties
configuration key, the new custom property must be appended to it. The additional custom property,smartcard
, is added to the configuration key's value. The new custom property is able to hold a value oftrue
orfalse
.# engine-config -s UserDefinedVMProperties='memory=^[0-9]+$;smartcard=^(true|false)$' --cver=3.2
- Verify that the custom properties defined by the
UserDefinedVMProperties
configuration key have been updated correctly.# engine-config -g UserDefinedVMProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties: version: 3.3 UserDefinedVMProperties : memory=^[0-9]+$;smartcard=^(true|false)$ version: 3.2
- Finally, the
ovirt-engine
service must be restarted for the configuration change to take effect.# service ovirt-engine restart
Example B.2. Device Properties - Defining the interface
Custom Property
- Check the existing custom properties defined by the
CustomDeviceProperties
configuration key using the following command:# engine-config -g CustomDeviceProperties
As shown by the output below, no custom properties have yet been defined.# engine-config -g CustomDeviceProperties CustomDeviceProperties: version: 3.0 CustomDeviceProperties: version: 3.1 CustomDeviceProperties: version: 3.2 CustomDeviceProperties: version: 3.3
- The
interface
custom property does not already exist, so it can be appended as is. In this example, the value of thespeed
sub-property is set to a range from one to five, and the value of theduplex
sub-property is set to a selection of eitherfull
orhalf
.# engine-config -s CustomDeviceProperties="{type=interface;prop={speed=^([0-9]{1,5})$;duplex=^(full|half)$}}" --cver=3.3
- Verify that the custom properties defined by the
CustomDeviceProperties
configuration key have been updated correctly.# engine-config -g CustomDeviceProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties : {type=interface;prop={speed=^([0-9]{1,5})$;duplex=^(full|half)$}} version: 3.3
- Finally, the
ovirt-engine
service must be restarted for the configuration change to take effect.# service ovirt-engine restart
B.8. Setting Virtual Machine Custom Properties
B.9. Evaluating Virtual Machine Custom Properties in a VDSM Hook
Example B.3. Evaluating Custom Properties
key1
. If the custom property is set then the value is printed to standard error. If the custom property is not set then no action is taken.
#!/usr/bin/python import os import sys if os.environ.has_key('key1'): sys.stderr.write('key1 value was : %s\n' % os.environ['key1']) else: sys.exit(0)
B.10. Using the VDSM Hooking Module
xml.dom
library (http://docs.python.org/release/2.6/library/xml.dom.html) to manipulate the object.
Table B.2. Hooking module functions
Name | Argument | Description |
---|---|---|
tobool | string | Converts a string "true" or "false" to a Boolean value |
read_domxml | - | Reads the virtual machine's libvirt XML into a DOM object |
write_domxml | DOM object | Writes the virtual machine's libvirt XML from a DOM object |
B.11. VDSM Hook Execution
before_vm_start
scripts can edit the domain XML in order to change VDSM's definition of a virtual machine before it reaches libvirt. Caution must be exercised in doing so. Hook scripts have the potential to disrupt the operation of VDSM, and buggy scripts can result in outages to the Red Hat Enterprise Virtualization environment. In particular, ensure you never change the uuid of the domain, and do not attempt to remove a device from the domain without sufficient background knowledge.
before_vdsm_start
and after_vdsm_stop
hook scripts are run as the root
user. Other hook scripts that require root
access to the system must be written to use the sudo
command for privilege escalation. To support this the /etc/sudoers
must be updated to allow the vdsm
user to use sudo
without reentering a password. This is required as hook scripts are executed non-interactively.
Example B.4. Configuring sudo
for VDSM Hooks
sudo
command will be configured to allow the vdsm
user to run the /bin/chown
command as root
.
- Log into the virtualization host as
root
. - Open the
/etc/sudoers
file in a text editor. - Add this line to the file:
vdsm ALL=(ALL) NOPASSWD: /bin/chown
This specifies that thevdsm
user has the ability to run the/bin/chown
command as theroot
user. TheNOPASSWD
parameter indicates that the user will not be prompted to enter their password when callingsudo
.
sudo
command to run /bin/chown
as root
. This Python code uses sudo
to execute /bin/chown
as root
on the file /my_file
.
retcode = subprocess.call( ["/usr/bin/sudo", "/bin/chown", "root", "/my_file"] )
B.12. VDSM Hook Return Codes
Table B.3. Hook Return Codes
Code | Description |
---|---|
0 | The hook script ended successfully |
1 | The hook script failed, other hooks should be processed |
2 | The hook script failed, no further hooks should be processed |
>2 | Reserved |
B.13. VDSM Hook Examples
Example B.5. NUMA Node Tuning
This hook script allows for tuning the allocation of memory on a NUMA host based on the numaset
custom property. Where the custom property is not set no action is taken.
numaset=^(interleave|strict|preferred):[\^]?\d+(-\d+)?(,[\^]?\d+(-\d+)?)*$
numaset
custom property for a given virtual machine to specify both the allocation mode (interleave
, strict
, preferred
) and the node to use. The two values are separated by a colon (:
). The regular expression allows specification of the nodeset
as:
- that a specific node (
numaset=strict:1
, specifies that only node 1 be used), or - that a range of nodes be used (
numaset=strict:1-4
, specifies that nodes 1 through 4 be used), or - that a specific node not be used (
numaset=strict:^3
, specifies that node 3 not be used), or - any comma-separated combination of the above (
numaset=strict:1-4,6
, specifies that nodes 1 to 4, and 6 be used).
/usr/libexec/vdsm/hooks/before_vm_start/50_numa
#!/usr/bin/python import os import sys import hooking import traceback ''' numa hook ========= add numa support for domain xml: <numatune> <memory mode="strict" nodeset="1-4,^3" /> </numatune> memory=interleave|strict|preferred numaset="1" (use one NUMA node) numaset="1-4" (use 1-4 NUMA nodes) numaset="^3" (don't use NUMA node 3) numaset="1-4,^3,6" (or combinations) syntax: numa=strict:1-4 ''' if os.environ.has_key('numa'): try: mode, nodeset = os.environ['numa'].split(':') domxml = hooking.read_domxml() domain = domxml.getElementsByTagName('domain')[0] numas = domxml.getElementsByTagName('numatune') if not len(numas) > 0: numatune = domxml.createElement('numatune') domain.appendChild(numatune) memory = domxml.createElement('memory') memory.setAttribute('mode', mode) memory.setAttribute('nodeset', nodeset) numatune.appendChild(memory) hooking.write_domxml(domxml) else: sys.stderr.write('numa: numa already exists in domain xml') sys.exit(2) except: sys.stderr.write('numa: [unexpected error]: %s\n' % traceback.format_exc()) sys.exit(2)
Appendix C. Red Hat Enterprise Virtualization User Interface Plugins
C.1. Red Hat Enterprise Virtualization User Interface Plug-ins
C.2. Red Hat Enterprise Virtualization User Interface Plugin Lifecycle
C.2.1. Red Hat Enterprise Virtualization User Interface Plug-in Life cycle
- Plug-in discovery.
- Plug-in loading.
- Plug-in bootstrapping.
C.2.2. Red Hat Enterprise Virtualization User Interface Plug-in Discovery
HTTP GET
), User Interface plug-in infrastructure attempts to discover and load plug-in descriptors from your local file system. For each plug-in descriptor, the infrastructure also attempts to load corresponding plug-in user configurations used to override default plug-in-specific configurations (if any exist) and tweak plug-in runtime behavior. Plug-in user configuration is optional. After loading descriptors and corresponding user configuration files, oVirt Engine aggregates User Interface plug-in data and embeds it into the administration portal HTML page for runtime evaluation.
$ENGINE_USR/ui-plug-ins
, with a default mapping of ENGINE_USR=/usr/share/ovirt-engine
as defined by oVirt Engine local configuration. Plug-in descriptors are expected to comply with JSON format specifications, but plug-in descriptors allow Java/C++ style comments (of both /*
and //
varieties) in addition to the JSON format specifications.
$ENGINE_ETC/ui-plug-ins
, with a default mapping of ENGINE_ETC=/etc/ovirt-engine
as defined by oVirt Engine local configuration. Plug-in user configuration files are expected to comply with same content format rules as plug-in descriptors.
Note
<descriptorFileName>-config.json
naming convention.
C.2.3. Red Hat Enterprise Virtualization User Interface Plug-in Loading
C.2.4. Red Hat Enterprise Virtualization User Interface Plug-in Bootstrapping
Procedure C.1. Plug-in Bootstrap Sequence
- Obtain pluginApi instance for the given plug-in
- Obtain runtime plug-in configuration object (optional)
- Register relevant event handler functions
- Notify UI plug-in infrastructure to proceed with plug-in initialization
// Access plug-in API using 'parent' due to this code being evaluated within the context of an iframe element. // As 'parent.pluginApi' is subject to Same-Origin Policy, this will only work when WebAdmin HTML page and plug-in // host page are served from same origin. WebAdmin HTML page and plug-in host page will always be on same origin // when using UI plug-in infrastructure support to serve plug-in resource files. var api = parent.pluginApi('MyPlugin'); // Runtime configuration object associated with the plug-in (or an empty object). var config = api.configObject(); // Register event handler function(s) for later invocation by UI plug-in infrastructure. api.register({ // UiInit event handler function. UiInit: function() { // Handle UiInit event. window.alert('Favorite music band is ' + config.band); } }); // Notify UI plug-in infrastructure to proceed with plug-in initialization. api.ready();
C.3. User Interface Plugin-related Files and Their Locations
Table C.1. UI Plugin-related Files and their Locations
File | Location | Remarks |
---|---|---|
Plug-in descriptor files (meta-data) | /usr/share/ovirt-engine/ui-plugins/my-plugin.json | |
Plug-in user configuration files | /etc/ovirt-engine/ui-plugins/my-plugin-config.json | |
Plug-in resource files | /usr/share/ovirt-enging/ui-plugins/<resourcePath>/PluginHostPage.html | <resourcePath> is defined by the corresponding attribute in the plug-in descriptor. |
C.4. Example User Interface Plug-in Deployment
Hello World!
program when you sign in to the Red Hat Enterprise Virtualization Manager administration portal.
Procedure C.2. Deploying a Hello World!
Plug-in
- Create a plug-in descriptor by creating the following file in the Manager at
/usr/share/ovirt-engine/ui-plugins/helloWorld.json
:{ "name": "HelloWorld", "url": "/webadmin/webadmin/plugin/HelloWorld/start.html", "resourcePath": "hello-files" }
- Create the plug-in host page by creating the following file in the Manager at
/usr/share/ovirt-engine/ui-plugins/hello-files/start.html
:<!DOCTYPE html><html><head> <script> var api = parent.pluginApi('HelloWorld'); api.register({ UiInit: function() { window.alert('Hello world'); } }); api.ready(); </script> </head><body></body></html>
Hello World!
plug-in, you will see this screen when you sign in to the administration portal:
Figure C.1. A Successful Implementation of the Hello World!
Plug-in
C.5. Installing the Red Hat Support Plug-in
Procedure C.3. Installing the Red Hat Support Plug-in
Note
- Use yum to install the redhat-support-plugin-rhev plug-in:
#
yum install redhat-support-plugin-rhev
C.6. Using Red Hat Support Plug-in
Note
Figure C.2. Red Hat Support Plug-in - Login Window
Figure C.3. Red Hat Support Plug-in - Query Results in the Left-Hand Navigation List
Figure C.4. Right-clicking on a Context Menu to Access Red Hat Support Plug-in
Figure C.5. Red Hat Support Plug-in - Opening a New Support Case
Red Hat Documentation
tab to open the documentation relevant to the part of the Administration Portal currently on the screen.
Figure C.6. Red Hat Support Plug-in - Accessing Documentation
Appendix D. Red Hat Enterprise Virtualization and SSL
D.1. Replacing the Red Hat Enterprise Virtualization Manager SSL Certificate
Warning
/etc/pki
directory or any subdirectories. The permission for the /etc/pki
and the /etc/pki/ovirt-engine
directory must remain as the default 755.
You want to use your organization's commercially signed certificate to identify your Red Hat Enterprise Virtualization Manager to users connecting over HTTPS.
Note
This procedure requires a PEM formatted certificate from your commercial certificate issuing authority, a .nokey file, and a .cer file. The .nokey and .cer files are sometimes distributed as a certificate-key bundle in the P12 format.
Procedure D.1. Replacing the Red Hat Enterprise Virtualization Manager Apache SSL Certificate
- The Manager has been configured to use
/etc/pki/ovirt-engine/apache-ca.pem
, which is symbolically linked to/etc/pki/ovirt-engine/ca.pem
. Remove the symbolic link.# rm /etc/pki/ovirt-engine/apache-ca.pem
- Save your commercially issued certificate as
/etc/pki/ovirt-engine/apache-ca.pem
. The certificate chain must be complete up to the root certificate. The chain order is important and should be from the last intermediate certificate to the root certificate.mv YOUR-3RD-PARTY-CERT.pem /etc/pki/ovirt-engine/apache-ca.pem
- Move your P12 bundle to
/etc/pki/ovirt-engine/keys/apache.p12
. - Extract the key from the bundle.
# openssl pkcs12 -in /etc/pki/ovirt-engine/keys/apache.p12 -nocerts -nodes > /etc/pki/ovirt-engine/keys/apache.key.nopass
- Extract the certificate from the bundle.
# openssl pkcs12 -in /etc/pki/ovirt-engine/keys/apache.p12 -nokeys > /etc/pki/ovirt-engine/certs/apache.cer
- Restart the Apache server.
# service httpd restart
Your users can now connect to the portals without being warned about the authenticity of the certificate used to encrypt https traffic.
Appendix E. Using Search, Bookmarks, and Tags
E.1. Searches
E.1.1. Performing Searches in Red Hat Enterprise Virtualization
Note
E.1.2. Search Syntax and Examples
result type: {criteria} [sortby sort_spec]
The following examples describe how the search query is used and help you to understand how Red Hat Enterprise Virtualization assists with building search queries.
Table E.1. Example Search Queries
Example | Result |
---|---|
Hosts: Vms.status = up | Displays a list of all hosts running virtual machines that are up. |
Vms: domain = qa.company.com | Displays a list of all virtual machines running on the specified domain. |
Vms: users.name = Mary | Displays a list of all virtual machines belonging to users with the user name Mary. |
Events: severity > normal sortby time | Displays the list of all Events whose severity is higher than Normal, sorted by time. |
E.1.3. Search Auto-Completion
Hosts: Vms.status = down
Table E.2. Example Search Queries Using Auto-Completion
Input | List Items Displayed | Action |
---|---|---|
h | Hosts (1 option only) |
Select
Hosts or;
Type
Hosts
|
Hosts: |
All host properties
| Type v |
Hosts: v | host properties starting with a v | Select Vms or type Vms |
Hosts: Vms | All virtual machine properties | Type s |
Hosts: Vms.s | All virtual machine properties beginning with s | Select status or type status |
Hosts: Vms.status | =
=!
| Select or type = |
Hosts: Vms.status = | All status values | Select or type down |
E.1.4. Search Result Type Options
- Vms for a list of virtual machines
- Host for a list of hosts
- Pools for a list of pools
- Template for a list of templates
- Event for a list of events
- Users for a list of users
- Cluster for a list of clusters
- Datacenter for a list of data centers
- Storage for a list of storage domains
E.1.5. Search Criteria
{criteria}
is as follows:
<prop><operator><value>
<obj-type><prop><operator><value>
The following table describes the parts of the syntax:
Table E.3. Example Search Criteria
Part | Description | Values | Example | Note |
---|---|---|---|---|
prop | The property of the searched-for resource. Can also be the property of a resource type (see obj-type ), or tag (custom tag). | Limit your search to objects with a certain property. For example, search for objects with a status property. | Status | -- |
obj-type | A resource type that can be associated with the searched-for resource. | These are system objects, like data centers and virtual machines. | Users | -- |
operator | Comparison operators. |
=
!= (not equal)
>
<
>=
<=
| -- | Value options depend on obj-type. |
Value | What the expression is being compared to. |
String
Integer
Ranking
Date (formatted according to Regional Settings)
|
Jones
256
normal
|
|
E.1.6. Search: Multiple Criteria and Wildcards
<value>
part of the syntax for strings. For example, to find all users beginning with m, enter m*
.
AND
and OR
. For example:
Vms: users.name = m* AND status = Up
Vms: users.name = m* AND tag = "paris-loc"
AND
or OR
, AND
is implied. AND
precedes OR
, and OR
precedes implied AND
.
E.1.7. Search: Determining Search Order
sortby
. Sort direction (asc
for ascending, desc
for descending) can be included.
events: severity > normal sortby time desc
E.1.8. Searching for Data Centers
Table E.4. Searching for Data Centers
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the data center. |
name | String | The name of the data center. |
description | String | A description of the data center. |
type | String | The type of data center. |
status | List | The availability of the data center. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The number of results to display per page. |
Datacenter: type = nfs and status != up
- A storage type of NFS and status other than up
E.1.9. Searching for Clusters
Table E.5. Searching Clusters
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Datacenter.datacenter-prop | Depends on property type | The property of the data center associated with the cluster. |
Datacenter | String | The data center to which the cluster belongs. |
name | String | The unique name that identifies the clusters on the network. |
description | String | The description of the cluster. |
initialized | String | True or False indicating the status of the cluster. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The number of results to display per page. |
Clusters: initialized = true or name = Default
- initialized; or
- named Default
E.1.10. Searching for Hosts
Table E.6. Searching for Hosts
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the host. |
Templates.templates-prop | Depends on property type | The property of the templates associated with the host. |
Events.events-prop | Depends on property type | The property of the events associated with the host. |
Users.users-prop | Depends on property type | The property of the users associated with the host. |
name | String | The name of the host. |
status | List | The availability of the host. |
cluster | String | The cluster to which the host belongs. |
address | String | The unique name that identifies the host on the network. |
cpu_usage | Integer | The percent of processing power used. |
mem_usage | Integer | The percentage of memory used. |
network_usage | Integer | The percentage of network usage. |
load | Integer | Jobs waiting to be executed in the run-queue per processor, in a given time slice. |
version | Integer | The version number of the operating system. |
cpus | Integer | The number of CPUs on the host. |
memory | Integer | The amount of memory available. |
cpu_speed | Integer | The processing speed of the CPU. |
cpu_model | String | The type of CPU. |
active_vms | Integer | The number of Vms currently running. |
migrating_vms | Integer | The number of Vms currently being migrated. |
committed_mem | Integer | The percentage of committed memory. |
tag | String | The tag assigned to the host. |
type | String | The type of host. |
datacenter | String | The data center to which the host belongs. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The number of results to display per page. |
Hosts: cluster = Default and Vms.os = rhel6
- Are part of the Default cluster and host virtual machines running the Red Hat Enterprise Linux 6 operating system.
E.1.11. Searching for Networks
Table E.7. Searching for Networks
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Cluster_network.clusternetwork-prop | Depends on property type | The property of the cluster associated with the network. |
Host_Network.hostnetwork-prop | Depends on property type | The property of the host associated with the network. |
name | String | The human readable name that identifies the network. |
description | String | Keywords or text describing the network, optionally used when creating the network. |
vlanid | Integer | The VLAN ID of the network. |
stp | String | Whether Spanning Tree Protocol (STP) is enabled or disabled for the network. |
mtu | Integer | The maximum transmission unit for the logical network. |
vmnetwork | String | Whether the network is only used for virtual machine traffic. |
datacenter | String | The data center to which the network is attached. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The page number of results to display. |
Network: mtu > 1500 and vmnetwork = true
- with a maximum transmission unit greater than 1500 bytes
- which are set up for use by only virtual machines.
E.1.12. Searching for Storage
Table E.8. Searching for Storage
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the storage. |
Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the storage. |
name | String | The unique name that identifies the storage on the network. |
status | String | The status of the storage domain. |
datacenter | String | The data center to which the storage belongs. |
type | String | The type of the storage. |
size | Integer | The size of the storage. |
used | Integer | The amount of the storage that is used. |
committed | Integer | The amount of the storage that is committed. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The number of results to display per page. |
Storage: size > 200 or used < 50
- total storage space greater than 200 GB; or
- used storage space less than 50 GB.
E.1.13. Searching for Disks
Table E.9. Searching for Disks
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Datacenters.datacenters-prop | Depends on property type | The property of the data centers associated with the disk. |
Storages.storages-prop | Depends on property type | The property of the storage associated with the disk. |
alias | String | The human readable name that identifies the storage on the network. |
description | String | Keywords or text describing the disk, optionally used when creating the disk. |
provisioned_size | Integer | The virtual size of the disk. |
size | Integer | The size of the disk. |
actual_size | Integer | The actual size allocated to the disk. |
creation_date | Integer | The date the disk was created. |
bootable | String | Whether the disk can or cannot be booted. Valid values are one of 0 , 1 , yes , or no |
shareable | String | Whether the disk can or cannot be attached to more than one virtual machine at a time. Valid values are one of 0 , 1 , yes , or no |
format | String | The format of the disk. Can be one of unused , unassigned , cow , or raw . |
status | String | The status of the disk. Can be one of unassigned , ok , locked , invalid , or illegal . |
disk_type | String | The type of the disk. Can be one of image or lun . |
number_of_vms | Integer | The number of virtual machine(s) to which the disk is attached. |
vm_names | String | The name(s) of the virtual machine(s) to which the disk is attached. |
quota | String | The name of the quota enforced on the virtual disk. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The page number of results to display. |
Disks: format = cow and provisioned_size > 8
- Qcow, also known as thin provisioning, format; and
- an allocated disk size greater than 8 GB.
E.1.14. Searching for Volumes
Table E.10. Searching for Volumes
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Volume.cluster-prop | Depends on property type | The property of the clusters associated with the volume. |
Cluster | String | The name of the cluster associated with the volume. |
name | String | The human readable name that identifies the volume. |
type | String | Can be one of distribute, replicate, distributed_replicate, stripe, or distributed_stripe. |
transport_type | Integer | Can be one of tcp or rdma |
replica_count | Integer | Number of replica. |
stripe_count | Integer | Number of stripes. |
status | String | The status of the volume. Can be one of Up or Down. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The page number of results to display. |
Volume: transport_type = rdma and stripe_count >= 2
- Transport type set to RDMA; and
- with 2 or more stripes.
E.1.15. Searching for Virtual Machines
Table E.11. Searching for Virtual Machines
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the virtual machine. |
Templates.templates-prop | Depends on property type | The property of the templates associated with the virtual machine. |
Events.events-prop | Depends on property type | The property of the events associated with the virtual machine. |
Users.users-prop | Depends on property type | The property of the users associated with the virtual machine. |
name | String | The name of the virtual machine. |
status | List | The availability of the virtual machine. |
ip | Integer | The IP address of the virtual machine. |
uptime | Integer | The number of minutes that the virtual machine has been running. |
domain | String | The domain (usually Active Directory domain) that groups these machines. |
os | String | The operating system selected when the virtual machine was created. |
creationdate | Date | The date on which the virtual machine was created. |
address | String | The unique name that identifies the virtual machine on the network. |
cpu_usage | Integer | The percent of processing power used. |
mem_usage | Integer | The percentage of memory used. |
network_usage | Integer | The percentage of network used. |
memory | Integer | The maximum memory defined. |
apps | String | The applications currently installed on the virtual machine. |
cluster | List | The cluster to which the virtual machine belongs. |
pool | List | The virtual machine pool to which the virtual machine belongs. |
loggedinuser | String | The name of the user currently logged in to the virtual machine. |
tag | List | The tags to which the virtual machine belongs. |
datacenter | String | The data center to which the virtual machine belongs. |
type | List | The virtual machine type (server or desktop). |
quota | String | The name of the quota associated with the virtual machine. |
description | String | Keywords or text describing the virtual machine, optionally used when creating the virtual machine. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The page number of results to display. |
Vms: template.name = Win* and user.name = ""
- The template on which the virtual machine is based begins with Win and the virtual machine is assigned to any user.
Vms: cluster = Default and os = windowsxp
- The cluster to which the virtual machine belongs is named Default and the virtual machine is running the Windows XP operating system.
E.1.16. Searching for Pools
Table E.12. Searching for Pools
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
name | String | The name of the pool. |
description | String | The description of the pool. |
type | List | The type of pool. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The page number of results to display. |
Pools: type = automatic
- Type of automatic
E.1.17. Searching for Templates
Table E.13. Searching for Templates
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Vms.Vms-prop | String | The property of the virtual machines associated with the template. |
Hosts.hosts-prop | String | The property of the hosts associated with the template. |
Events.events-prop | String | The property of the events associated with the template. |
Users.users-prop | String | The property of the users associated with the template. |
name | String | The name of the template. |
domain | String | The domain of the template. |
os | String | The type of operating system. |
creationdate | Integer |
The date on which the template was created.
Date format is mm/dd/yy.
|
childcount | Integer | The number of Vms created from the template. |
mem | Integer | Defined memory. |
description | String | The description of the template. |
status | String | The status of the template. |
cluster | String | The cluster associated with the template. |
datacenter | String | The data center associated with the template. |
quota | String | The quota associated with the template. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The page number of results to display. |
Template: Events.severity >= normal and Vms.uptime > 0
- Events of normal or greater severity have occurred on VMs derived from the template, and the VMs are still running.
E.1.18. Searching for Users
Table E.14. Searching for Users
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the user. |
Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the user. |
Templates.templates-prop | Depends on property type | The property of the templates associated with the user. |
Events.events-prop | Depends on property type | The property of the events associated with the user. |
name | String | The name of the user. |
lastname | String | The last name of the user. |
usrname | String | The unique name of the user. |
department | String | The department to which the user belongs. |
group | String | The group to which the user belongs. |
title | String | The title of the user. |
status | String | The status of the user. |
role | String | The role of the user. |
tag | String | The tag to which the user belongs. |
pool | String | The pool to which the user belongs. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The page number of results to display. |
Users: Events.severity > normal and Vms.status = up or Vms.status = pause
- Events of greater than normal severity have occurred on their virtual machines AND the virtual machines are still running; or
- The users' virtual machines are paused.
E.1.19. Searching for Events
Table E.15. Searching for Events
Property (of resource or resource-type) | Type | Description (Reference) |
---|---|---|
Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the event. |
Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the event. |
Templates.templates-prop | Depends on property type | The property of the templates associated with the event. |
Users.users-prop | Depends on property type | The property of the users associated with the event. |
Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the event. |
Volumes.Volumes-prop | Depends on property type | The property of the volumes associated with the event. |
type | List | Type of the event. |
severity | List | The severity of the event: Warning/Error/Normal. |
message | String | Description of the event type. |
time | Integer | Time at which the event occurred. |
usrname | String | The user name associated with the event. |
event_host | String | The host associated with the event. |
event_vm | String | The virtual machine associated with the event. |
event_template | String | The template associated with the event. |
event_storage | String | The storage associated with the event. |
event_datacenter | String | The data center associated with the event. |
event_volume | String | The volume associated with the event. |
correlation_id | Integer | The identification number of the event. |
sortby | List | Sorts the returned results by one of the resource properties. |
page | Integer | The page number of results to display. |
Events: Vms.name = testdesktop and Hosts.name = gonzo.example.com
- The event occurred on the virtual machine named
testdesktop
while it was running on the hostgonzo.example.com
.
E.2. Bookmarks
E.2.1. Saving a Query String as a Bookmark
A bookmark can be used to remember a search query, and shared with other users.
Procedure E.1. Saving a Query String as a Bookmark
- Enter the desired search query in the search bar and perform the search.
- Click the star-shaped Bookmark button to the right of the search bar to open the New Bookmark window.
Figure E.1. Bookmark Icon
- Enter the Name of the bookmark.
- Edit the Search string field (if applicable).
- Click OK to save the query as a bookmark and close the window.
- The search query is saved and displays in the Bookmarks pane.
You have saved a search query as a bookmark for future reuse. Use the Bookmark pane to find and select the bookmark.
E.2.2. Editing a Bookmark
You can modify the name and search string of a bookmark.
Procedure E.2. Editing a Bookmark
- Click the Bookmarks tab on the far left side of the screen.
- Select the bookmark you wish to edit.
- Click the Edit button to open the Edit Bookmark window.
- Change the Name and Search string fields as necessary.
- Click OK to save the edited bookmark.
You have edited a bookmarked search query.
E.2.3. Deleting a Bookmark
When a bookmark is no longer needed, remove it.
Procedure E.3. Deleting a Bookmark
- Click the Bookmarks tab on the far left side of the screen.
- Select the bookmark you wish to remove.
- Click the Remove button to open the Remove Bookmark window.
- Click OK to remove the selected bookmark.
You have removed a bookmarked search query.
E.3. Tags
E.3.1. Using Tags to Customize Interactions with Red Hat Enterprise Virtualization
E.3.2. Creating a Tag
You can edit the name and description of a tag.
Procedure E.4. Creating a Tag
- Click the Tags tab on the left side of the screen.
- Select the node under which you wish to create the tag. For example, to create it at the highest level, click the root node.
- Click the New button to open the New Tag window.
- Enter the Name and Description of the new tag.
- Click OK to create the tag.
The new tag is created and displays on the Tags tab.
E.3.3. Modifying a Tag
You can edit the name and description of a tag.
Procedure E.5. Modifying a Tag
- Click the Tags tab on the left side of the screen.
- Select the tag you wish to modify.
- Click Edit to open the Edit Tag window.
- Change the Name and Description fields as necessary.
- Click OK to save the edited tag.
You have modified the properties of a tag.
E.3.4. Deleting a Tag
When a tag is no longer needed, remove it.
Procedure E.6. Deleting a Tag
- Click the Tags tab on the left side of the screen.
- Select the tag you wish to delete.
- Click Remove to open the Remove Tag(s) window. The message warns you that removing the tag will also remove all descendants of the tag.
- Click OK to delete the selected tag.
You have removed the tag and all its descendants. The tag is also removed from all the objects that it was attached to.
E.3.5. Adding and Removing Tags to and from Objects
You can assign tags to and remove tags from hosts, virtual machines, and users.
Procedure E.7. Adding and Removing Tags to and from Objects
- Use the resource tab, tree mode, or the search function to find and select the object(s) you wish to tag or untag.
- Click the Assign Tags button to open the Assign Tags window.
- Select the check box to assign a tag to the object, or clear the check box to detach the tag from the object.
- Click OK.
The specified tag is now added or removed as a custom property of the selected object(s).
E.3.6. Searching for Objects Using Tags
- Enter a search query using
tag
as the property and the desired value or set of values as criteria for the search.The objects tagged with the specified criteria are listed in the results list.
Appendix F. Branding
F.1. Branding
F.1.1. Re-Branding the Manager
/etc/ovirt-engine/branding/
directory on the system on which the Manager is installed. The files comprise a set of cascading style sheet files that are used to style various aspects of the graphical user interface and a set of properties files that contain messages and links that are incorporated into various components of the Manager.
F.1.2. Login Screen
- The border
- The header image on the left
- The header image on the right
- The header text
common.css
.
F.1.3. Administration Portal Screen
- The logo
- The left background image
- The center background image
- The right background image
- The text to the right of the logo
web_admin.css
.
F.1.4. User Portal Screen
- The logo
- The center background image
- The right background image
- The border around the main grid
- The text above the Logged in user label
user_portal.css
.
F.1.5. Pop-Up Windows
- The border
- The header image on the left
- The header center image (repeated)
common.css
.
F.1.6. Tabs
- Active
- Inactive
common.css
and user_portal.css
.
F.1.7. The Welcome Page
- The page title
- The header (left, center and right)
- The error message
- The link to forward and the associated message for that link
welcome_style.css
.
The template file for the Welcome Page is a regular HTML file of the name welcome_page.template
that does not contain HTML
, HEAD
or BODY
tags. This file is inserted directly into the Welcome Page itself, and acts as a container for the content that is displayed in the Welcome Page. As such, you must edit this file to add new links or change the content itself. Another feature of the template file is that it contains placeholder text such as {user_portal}
that are replaced by corresponding text in the messages.properties
file when the Welcome Page is processed.
F.1.8. The Page Not Found Page
- The page title
- The header (left, center and right)
- The error message
- The link to forward and the associated message for that link
welcome_style.css
.
Appendix G. Revision History
Revision History | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Revision 3.4-43 | Thu 30 Apr 2015 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-42 | Tue 24 Mar 2015 | Tahlia Richardson | |||||||||||||
| |||||||||||||||
Revision 3.4-41 | Thu 05 Feb 2015 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-40 | Thu 05 Feb 2015 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-39 | Fri 12 Dec 2014 | Julie Wu | |||||||||||||
| |||||||||||||||
Revision 3.4-38 | Thurs 11 Dec 2014 | Tahlia Richardson | |||||||||||||
| |||||||||||||||
Revision 3.4-37 | Mon 08 Dec 2014 | Julie Wu | |||||||||||||
| |||||||||||||||
Revision 3.4-36 | Thurs 20 Nov 2014 | Tahlia Richardson | |||||||||||||
| |||||||||||||||
Revision 3.4-35 | Wed 19 Nov 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-34 | Fri 10 Oct 2014 | Julie Wu | |||||||||||||
| |||||||||||||||
Revision 3.4-33 | Wed 3 Sep 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-32 | Mon 25 Aug 2014 | Julie Wu | |||||||||||||
| |||||||||||||||
Revision 3.4-31 | Wed 11 Jun 2014 | Andrew Burden | |||||||||||||
| |||||||||||||||
Revision 3.4-27 | Wed 30 Apr 2014 | Zac Dover | |||||||||||||
| |||||||||||||||
Revision 3.4-26 | Tue 29 Apr 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-25 | Mon 28 Apr 2014 | Timothy Poitras | |||||||||||||
| |||||||||||||||
Revision 3.4-24 | Mon 28 Apr 2014 | Jodi Biddle | |||||||||||||
| |||||||||||||||
Revision 3.4-23 | Wed 23 Apr 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-22 | Tue 22 Apr 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-21 | Thu 17 Apr 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-20 | Wed 16 Apr 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-19 | Tue 15 Apr 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-18 | Fri 11 Apr 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-17 | Thu 10 Apr 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-16 | Tue 08 Apr 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-15 | Thu 03 Apr 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-14 | Wed 02 Apr 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-13 | Tue 01 Apr 2014 | Zac Dover | |||||||||||||
| |||||||||||||||
Revision 3.4-7 | Mon 31 Mar 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-6 | Fri 28 Mar 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-5 | Thu 27 Mar 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-4 | Tue 25 Mar 2014 | Lucy Bopf | |||||||||||||
| |||||||||||||||
Revision 3.4-3 | Tue 25 Mar 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-2 | Wed 19 Mar 2014 | Andrew Dahms | |||||||||||||
| |||||||||||||||
Revision 3.4-1 | Mon 17 Mar 2014 | Andrew Dahms | |||||||||||||
|