Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Self-Hosted Engine Guide

Red Hat Virtualization 4.1

Installing and Maintaining the Red Hat Virtualization Self-Hosted Engine

Red Hat Virtualization Documentation Team

Red Hat Customer Content Services

Abstract

A comprehensive guide to the self-hosted engine.

Chapter 1. Introduction
Copy link

A self-hosted engine is a virtualized environment in which the Red Hat Virtualization Manager, or engine, runs on a virtual machine on the hosts managed by that Manager. The virtual machine is created as part of the host configuration, and the Manager is installed and configured in parallel to the host configuration process. The primary benefit of the self-hosted engine is that it requires less hardware to deploy an instance of Red Hat Virtualization as the Manager runs as a virtual machine, not on physical hardware. Additionally, the Manager is configured to be highly available. If the host running the Manager virtual machine goes into maintenance mode, or fails unexpectedly, the virtual machine migrates automatically to another host in the environment. Hosts that can run the Manager virtual machine are referred to as self-hosted engine nodes. At least two self-hosted engine nodes are required to support the high availability feature.
For the Manager virtual machine installation, a RHV-M Virtual Appliance is provided. Manually installing the Manager virtual machine is not supported. To customize the Manager virtual machine, you can use a custom cloud-init script with the appliance. Creating custom cloud-init scripts is currently outside the scope of this documentation. A default cloud-init script can be generated during the deployment.
Expand
Table 1.1. Supported OS versions to Deploy Self-Hosted Engine
System Type
Supported Versions
Red Hat Enterprise Linux host
7.4
Red Hat Virtualization Host
7.4
HostedEngine-VM (Manager)
7.4
For hardware requirements, see Host Requirements in the Planning and Prerequisites Guide.

Important

To avoid potential timing or authentication issues, configure the Network Time Protocol (NTP) on the hosts, Manager, and other servers in the environment to synchronize with the same NTP server. See Configuring NTP Using the chrony Suite and Synchronizing the System Clock with a Remote Server in the Red Hat Enterprise Linux 7 System Administrator’s Guide.
On Red Hat Enterprise Linux hosts, the Cockpit user interface or hosted-engine --deploy can be used to deploy the self-hosted engine. On Red Hat Virtualization Host (RHVH), self-hosted engine deployment is performed through the Cockpit user interface. The Cockpit user interface is a UI version of the hosted-engine script that assists with configuring the host and Manager virtual machine.

Note

Cockpit is the preferred installation method.

Chapter 2. Deploying Self-Hosted Engine
Copy link

This chapter describes how to deploy the self-hosted engine on Red Hat Enterprise Linux hosts and the Red Hat Virtualization Host, and how to administer the Manager virtual machine.

Important

See Self-Hosted Engine Recommendations in the Planning and Prerequisites Guide for specific recommendations about the self-hosted engine environment.
If you plan to use bonded interfaces for high availability or VLANs to separate different types of traffic (for example, for storage or management connections), you should configure them before deployment. See Networking Recommendations in the Planning and Prerequisites Guide.
If you want to deploy the self-hosted engine with Red Hat Gluster Storage as part of a Red Hat Hyperconverged Infrastructure (RHHI) environment, see the Deploying Red Hat Hyperconverged Infrastructure Guide for more information.

2.1.1. Installing the Self-Hosted Engine Packages
Copy link

Ensure the host is registered and subscribed to the required entitlements. See Subscribing to the Required Entitlements in the Installation Guide for more information.
You can install the self-hosted engine from the command line by using hosted-engine --deploy, or through the Cockpit user interface. Different packages are required depending on the method you choose.

Procedure 2.1. Installing the Self-Hosted Engine

  1. Install the packages required to install the self-hosted engine.
    • To install self-hosted engine using hosted-engine --deploy: 
      # yum install ovirt-hosted-engine-setup
      Copy to Clipboard Toggle word wrap
    • To install self-hosted engine using the Cockpit user interface: 
      yum install cockpit-ovirt-dashboard
      Copy to Clipboard Toggle word wrap
  2. Optionally install the RHV-M Virtual Appliance package for the Manager virtual machine installation. Alternatively, the script will prompt you to download it during deployment. 
    # yum install rhvm-appliance
    Copy to Clipboard Toggle word wrap

2.1.2. Initiating Self-Hosted Engine Deployment
Copy link

The hosted-engine script or Cockpit user interface is provided to assist with configuring the host, and the Manager virtual machine. Both methods ask you a series of questions, and configures your environment based on your answers.

Note

If using the script, use the hosted-engine --check-deployed command to check whether a self-hosted engine has already been deployed. An error will only be displayed if no self-hosted engine has been deployed. If a self-hosted engine has already been deployed, subsequent deployments will fail. See Chapter 3, Troubleshooting a Self-Hosted Engine Deployment if you need to troubleshoot an existing deployement, or clean up a failed deployment in order to redeploy the self-hosted engine.

Prerequisites

  • You must have a freshly installed Red Hat Enterprise Linux 7 system with the ovirt-hosted-engine-setup or cockpit-ovirt-dashboard package installed.
  • You must have prepared storage for your self-hosted engine environment. At least two storage domains are required:
    • A shared storage domain dedicated to the Manager virtual machine. This domain is created during the self-hosted engine deployment, and must be at least 68 GB.
    • A data storage domain for regular virtual machine data. This domain must be added to the self-hosted engine environment after the deployment is complete.

      Warning

      Red Hat strongly recommends that you have additional active data storage domains available in the same data center as the self-hosted engine environment.
      If you deploy the self-hosted engine in a data center with only one active data storage domain, and if that data storage domain is corrupted, you will be unable to add new data storage domains or to remove the corrupted data storage domain. You will have to redeploy the self-hosted engine.
    For more information on preparing storage for your deployment, see the Storage chapter of the Administration Guide.

    Important

    If you are using iSCSI storage, do not use the same iSCSI target for the shared storage domain and data storage domain.
  • You must have a fully qualified domain name prepared for your Manager and the host. Forward and reverse lookup records must both be set in the DNS.
  • You must have the RHV-M Virtual Appliance for the Manager installation. If you have not manually installed the rhvm-appliance package package, it will be downloaded and installed automatically.
  • To use the RHV-M Virtual Appliance for the Manager installation, one directory must be at least 5 GB. The deployment process will check if /var/tmp has enough space to extract the appliance files. If not, you can specify a different directory or mount external storage. The VDSM user and KVM group must have read, write, and execute permissions on the directory.

Procedure 2.2. Initiating a RHEL-based Self-Hosted Engine Deployment

  • Initiating Hosted Engine Deployment

    The deployment is initiated differently depending whether you are using the hosted-engine --deploy command or Cockpit user interface.
    • To deploy the self-hosted engine using hosted-engine --deploy, it is recommended to use the screen window manager to run the script to avoid losing the session in case of network or terminal disruption. If not already installed, install the screen package, which is available in the standard Red Hat Enterprise Linux repository. 
      # yum install screen
      Copy to Clipboard Toggle word wrap 
      # screen
      Copy to Clipboard Toggle word wrap 
      # hosted-engine --deploy
      Copy to Clipboard Toggle word wrap

      Note

      To escape the script at any time, use the CTRL+D keyboard combination to abort deployment. In the event of session timeout or connection disruption, run screen -d -r to recover the hosted-engine deployment session.
    • To deploy the self-hosted engine using the Cockpit user interface, log in to the UI at https://HostIPorFQDN:9090 and navigate to Virtualization > Hosted Engine.
      Select Standard to perform a standard self-hosted engine installation, and click Start.
      View larger image
Refer to Section 2.3, “Deploying the Self-Hosted Engine” for information about questions asked during the deployment process, and configuration information.
On Red Hat Virtualization Host (RHVH), self-hosted engine deployment is performed through the Cockpit user interface. A UI version of the hosted-engine script assists with configuring the host and Manager virtual machine. The script asks you a series of questions, and configures your environment based on your answers.

Prerequisites

  • You must have a freshly installed Red Hat Virtualization Host system. The Performance Profile in the System sub-tab of the Cockpit user interface must be set to virtual-host.
  • You must have prepared storage for your self-hosted engine environment. At least two storage domains are required:
    • A shared storage domain dedicated to the Manager virtual machine. This domain is created during the self-hosted engine deployment, and must be at least 68 GB.
    • A data storage domain for regular virtual machine data. This domain must be added to the self-hosted engine environment after the deployment is complete.

      Warning

      Red Hat strongly recommends that you have additional active data storage domains available in the same data center as the self-hosted engine environment.
      If you deploy the self-hosted engine in a data center with only one active data storage domain, and if that data storage domain is corrupted, you will be unable to add new data storage domains or to remove the corrupted data storage domain. You will have to redeploy the self-hosted engine.
    For more information on preparing storage for your deployment, see the Storage chapter of the Administration Guide.

    Important

    If you are using iSCSI storage, do not use the same iSCSI target for the shared storage domain and data storage domain.
  • You must have a fully qualified domain name prepared for your Manager and the host. Forward and reverse lookup records must both be set in the DNS.
  • To use the RHV-M Virtual Appliance for the Manager installation, one directory must be at least 5 GB. The hosted-engine script first checks if /var/tmp has enough space to extract the appliance files. If not, you can specify a different directory or mount external storage. The VDSM user and KVM group must have read, write, and execute permissions on the directory.

Procedure 2.3. Initiating a RHVH-based Self-Hosted Engine

  • Initiating Self-Hosted Engine Deployment

    Log in to the Cockpit user interface at https://HostIPorFQDN:9090 and navigate to Virtualization > Hosted Engine. Click Start.
    View larger image
Refer to Section 2.3, “Deploying the Self-Hosted Engine” for information about questions asked during the deployment process, and configuration information.

2.3. Deploying the Self-Hosted Engine
Copy link

After initiating a self-hosted engine deployment using hosted-engine --deploy or the Cockpit user interface, you are asked a series of questions to configure the host and Manager virtual machine. The fields in the deployment script are pre-populated with a default answer if one is available; change or enter your answers as necessary.
In this procedure, the deployment questions are presented in text form. In the Cockpit use interface, click Next when prompted.

Procedure 2.4. Deloying the Self-hosted Engine

  1. Beginning Deployment

    Select Yes to begin the deployment. 
    During customization use CTRL-D to abort.
Continuing will configure this host for serving as hypervisor and create a VM where you have to install the engine afterwards.
Are you sure you want to continue? (Yes, No)[Yes]:
    Copy to Clipboard Toggle word wrap

  2. Downloading the RHV-M Virtual Appliance

    If you have not manually downloaded the RHV-M Virtual Appliance, you can download and install it during deployment. Select Yes to download the appliance. 
    The oVirt engine appliance is now required to deploy hosted-engine.
You could get oVirt engine appliance installing ovirt-engine-appliance rpm.
Do you want to install ovirt-engine-appliance rpm? (Yes, No) [Yes]:
    Copy to Clipboard Toggle word wrap

  3. Configuring Storage

    Select the type of storage to use. 
    Please specify the storage you would like to use (glusterfs, iscsi, fc, nfs3, nfs4)[nfs3]:
    Copy to Clipboard Toggle word wrap
    • For NFS storage types, specify the full address, using either the FQDN or IP address, and path name of the shared storage domain. 
      Please specify the full shared storage connection path to use (example: host:/path): storage.example.com:/hosted_engine/nfs
      Copy to Clipboard Toggle word wrap
    • For iSCSI, specify the iSCSI portal IP address, port, user name and password, and select a target name from the auto-detected list. You can only select one iSCSI target during the deployment. 
      Please specify the iSCSI portal IP address:           
Please specify the iSCSI portal port [3260]:           
Please specify the iSCSI portal user:           
Please specify the iSCSI portal password:
Please specify the target name (auto-detected values) [default]:
      Copy to Clipboard Toggle word wrap
    • For Gluster storage, specify the full address, using either the FQDN or IP address, and path name of the shared storage domain.

      Important

      Only replica 3 Gluster storage is supported. Ensure the following configuration has been made:
      • In the /etc/glusterfs/glusterd.vol file on all three Gluster servers, set rpc-auth-allow-insecure to on. 
        option rpc-auth-allow-insecure on
        Copy to Clipboard Toggle word wrap
      • Configure the volume as follows: 
        gluster volume set volume cluster.quorum-type auto
gluster volume set volume network.ping-timeout 10
gluster volume set volume auth.allow \*
gluster volume set volume group virt
gluster volume set volume storage.owner-uid 36
gluster volume set volume storage.owner-gid 36
gluster volume set volume server.allow-insecure on
        Copy to Clipboard Toggle word wrap 
      Please specify the full shared storage connection path to use (example: host:/path): storage.example.com:/hosted_engine/gluster_volume
      Copy to Clipboard Toggle word wrap
    • For Fibre Channel, the host bus adapters must be configured and connected, and the hosted-engine script will auto-detect the LUNs available. The LUNs must not contain any existing data. 
      The following luns have been found on the requested target:
[1]     3514f0c5447600351       30GiB   XtremIO XtremApp
										status: used, paths: 2 active
			
[2]     3514f0c5447600352       30GiB   XtremIO XtremApp
										status: used, paths: 2 active

Please select the destination LUN (1, 2) [1]:
      Copy to Clipboard Toggle word wrap

  4. Configuring the Network

    The deployment detects possible network interface controllers (NICs) to use as a management bridge for the environment. 
    iptables was detected on your computer, do you wish setup to configure it? (Yes, No)[Yes]:
    Copy to Clipboard Toggle word wrap 
    Please indicate a nic to set ovirtmgmt bridge on: (eth1, eth0) [eth1]:
    Copy to Clipboard Toggle word wrap 
    Please indicate a pingable gateway IP address [X.X.X.X]:
    Copy to Clipboard Toggle word wrap

  5. Configuring the Virtual Machine

    The script will automatically detect the RHV-M Virtual Appliances available; select the appropriate appliance. 
     The following appliance have been found on your system:
[1] - The oVirt Engine Appliance image (OVA)
[2] - Directly select an OVA file
Please select an appliance (1, 2) [1]:
    Copy to Clipboard Toggle word wrap
    Select the vnc or spice console type to connect to the virtual machine. 
    Please specify the console type you would like to use to connect to the VM (vnc, spice) [vnc]:
    Copy to Clipboard Toggle word wrap
    Specify Yes if you want cloud-init to perform the initial configuration of the Manager virtual machine. Specify Generate for cloud-init to performs tasks like setting the root password, configuring networking, configuring the host name, injecting an answers file for engine-setup to use, and running engine-setup on boot. Optionally, select Existing if you have an existing cloud-init script to take care of more sophisticated functions of cloud-init. 
    Would you like to use cloud-init to customize the appliance on the first boot (Yes, No)[Yes]?
    Copy to Clipboard Toggle word wrap 
    Would you like to generate on-fly a cloud-init ISO image (of no-cloud type)
or do you have an existing one (Generate, Existing)[Generate]?
    Copy to Clipboard Toggle word wrap

    Note

    For more information on cloud-init, see https://cloudinit.readthedocs.org/en/latest/.
    Specify the FQDN for the Manager virtual machine. 
    Please provide the FQDN you would like to use for the engine appliance.
Note: This will be the FQDN of the engine VM you are now going to launch.
It should not point to the base host or to any other existing machine.
Engine VM FQDN: (leave it empty to skip): manager.example.com
    Copy to Clipboard Toggle word wrap
    Specify the domain name to use for the Manager if different from the default. 
    Please provide the domain name you would like to use for the engine appliance.
Engine VM domain: [domain.example.com]
    Copy to Clipboard Toggle word wrap
    Specify whether to automatically execute engine-setup when the Manager first boots, and to restart the Manager virtual machine as a monitored service.

    Important

    If you select No you still have the option of running engine-setup --accept-defaults to automatically accept all questions that have default answers. This option should be used with caution and only if you are familiar with engine-setup. 
    Automatically execute engine-setup on the engine appliance on first boot (Yes, No)[Yes]?
    Copy to Clipboard Toggle word wrap 
    Automatically restart the engine VM as a monitored service after engine-setup (Yes, No)[Yes]?
    Copy to Clipboard Toggle word wrap
    Enter the root password for the Manager. 
    Enter root password that will be used for the engine appliance (leave it empty to skip): p@ssw0rd
    Copy to Clipboard Toggle word wrap 
    Confirm appliance root password: p@ssw0rd
    Copy to Clipboard Toggle word wrap
    Enter an SSH public key that will allow you to later log in to the Manager as the root user, and specify whether to enable SSH access for the root user. 
    Enter ssh public key for the root user that will be used for the engine appliance (leave it empty to skip): ssh-rsa AAAAB3NzaBlyc2EAAAADAQABAAABAQDN79V0/3Y3R0iyoCvu7fbw0Mtggm7tHb76yMA4asmU2DBk7ql3AguTNAK9p7Hkc1FANjXGvAZh2vBk+OFN51F/mqe4mgWM1CrpJcsM5ouReT+HkJpMb2f8tU14ZGVRuB/JYfwzsXhs6Jx6Nhh810yqlduTODRDhR9tOtvmtv4cb5VoJhlpppsQOkVxGfB7fPRVucw5PMAUJDwFsOqvtqjuvbGniMYvSZwhv7Nw5Su8WOpMnyr3WfUfDdIAWli5rk4hBHWRZC4zbRsZK03V8wua3PZE0sX3iNvJy4g/s5ynwLytTz7zPXjdyTsYm7BMX8IDhariXY10cYso+fIfjyjf example@redhat.com
    Copy to Clipboard Toggle word wrap 
    Do you want to enable ssh access for the root user (yes, no, without-password) [yes]:
    Copy to Clipboard Toggle word wrap
    Specify the Manager disk size and memory size. 
    Please specify the size of the VM disk in GB: [50]:
    Copy to Clipboard Toggle word wrap 
    Please specify the memory size of the VM in MB (Defaults to appliance OVF value): [4096]:
    Copy to Clipboard Toggle word wrap
    Specify the CPU type to be used by the Manager and the number of virtual CPUs to use. 
    The following CPU types are supported by this host:
- model_SandyBridge: Intel SandyBridge Family
- model_Westmere: Intel Westmere Family
- model_Nehalem: Intel Nehalem Family
- model_Penryn: Intel Penryn Family
- model_Conroe: Intel Conroe Family
Please specify the CPU type to be used by the VM [model_SandyBridge]:
    Copy to Clipboard Toggle word wrap 
    Please specify the number of virtual CPUs for the VM [Defaults to appliance OVF value: 4]:
    Copy to Clipboard Toggle word wrap
    Specify a MAC address for the Manager virtual machine, or accept a randomly generated one. The MAC address can be used to update your DHCP and DNS server before installing the operating system on the virtual machine. If you want to provide the Manager virtual machine with an IP address via DHCP, ensure that you have a valid DHCP reservation for that MAC address. The deployment script will not configure the DHCP server for you. 
    You may specify a MAC address for the VM or accept a randomly generated default [00:16:3e:77:b2:a4]:
    Copy to Clipboard Toggle word wrap
    Specify the networking details of the virtual machine. 
    How should the engine VM network be configured (DHCP, Static)[DHCP]?
    Copy to Clipboard Toggle word wrap
    If you specified Static, enter the IP address of the Manager.

    Important

    The static IP address must belong to the same subnet as the host. For example, if the host is in 10.1.1.0/24, the Manager virtual machine's IP must be in the same subnet (10.1.1.1-254/24). 
    Please enter the IP address to be used for the engine VM [10.x.x.x]:
    Copy to Clipboard Toggle word wrap 
    Please provide a comma-separated list (max3) of IP addresses of domain name servers for the engine VM
Engine VM DNS (leave it empty to skip):
    Copy to Clipboard Toggle word wrap 
    Add lines for the appliance itself and for this host to /etc/hosts on the engine VM?
Note: ensuring that this host could resolve the engine VM hostname is still up to you (Yes, No)[No]
    Copy to Clipboard Toggle word wrap

  6. Configuring the Self-hosted Engine

    Specify a password for the admin@internal user to access the Administration Portal. Provide the name and TCP port number of the SMTP server, the email address used to send email notifications, and a comma-separated list of email addresses to receive these notifications. 
    Enter engine admin password: p@ssw0rd
    Copy to Clipboard Toggle word wrap 
    Confirm engine admin password: p@ssw0rd
    Copy to Clipboard Toggle word wrap 
    Please provide the name of the SMTP server through which we will send notifications [localhost]:
    Copy to Clipboard Toggle word wrap 
    Please provide the TCP port number of the SMTP server [25]:
    Copy to Clipboard Toggle word wrap 
    Please provide the email address from which notifications will be sent [root@localhost]:
    Copy to Clipboard Toggle word wrap 
    Please provide a comma-separated list of email addresses which will get notifications [root@localhost]:
    Copy to Clipboard Toggle word wrap

  7. Configuration Preview

    Before proceeding, the configuration values entered are displayed, and prompts for confirmation to proceed with these values. 
    Please confirm installation settings (Yes, No)[Yes]: Yes
    Copy to Clipboard Toggle word wrap
    The deployment creates the Manager virtual machine, starts the ovirt-engine and high availability services, and connects the host and shared storage domain to the Manager virtual machine.
    When the hosted-engine deployment completes successfully, the Red Hat Virtualization Manager is configured and running on your host. The Manager has already configured the data center, cluster, host, the Manager virtual machine, and a shared storage domain dedicated to the Manager virtual machine.

    Important

    Log in as the admin@internal user to continue configuring the Manager and add further resources. You must create another data domain for the data center to be initialized to host regular virtual machine data, and for the Manager virtual machine to be visible. See Storage in the Administration Guide for different storage options and on how to add a data storage domain.
    Link your Red Hat Virtualization Manager to a directory server so you can add additional users to the environment. Red Hat Virtualization supports many directory server types; for example, Red Hat Directory Server (RHDS), Red Hat Identity Management (IdM), Active Directory, and many other types. Add a directory server to your environment using the ovirt-engine-extension-aaa-ldap-setup interactive setup script. For more information, see Configuring an External LDAP Provider in the Administration Guide.
    The answers you gave during configuration are saved to a file to help with disaster recovery. If a destination is not specified using the --generate-answer=<file> argument, the answer file is generated at /etc/ovirt-hosted-engine/answers.conf.

  8. Subscribing to the Required Entitlements

    Subscribe the Manager virtual machine to the required entitlements. See Subscribing to the Required Entitlements in the Installation Guide for more information.

2.4. Administering the Manager Virtual Machine
Copy link

The hosted-engine utility is provided to assist with administering the Manager virtual machine. It can be run on any self-hosted engine nodes in the environment. For all the options, run hosted-engine --help. For additional information on a specific command, run hosted-engine --command --help. See Section 3.1, “Troubleshooting the Manager Virtual Machine” for more information.

Procedure 2.5. Updating the Self-Hosted Engine Configuration on the Shared Storage Domain

The following procedure shows you how to update the self-hosted engine configuration file (/var/lib/ovirt-hosted-engine-ha/broker.conf) on the shared storage domain after the initial deployment. Currently, you can configure email notifications using SMTP for any HA state transitions on the self-hosted engine nodes. The keys that can be updated include: smtp-server, smtp-port, source-email, destination-emails, and state_transition.
  1. On a self-hosted engine node, set the smtp-server key to the desired SMTP server address: 
    # hosted-engine --set-shared-config smtp-server smtp.example.com --type=broker
    Copy to Clipboard Toggle word wrap

    Note

    To verify that the self-hosted engine configuration file has been updated, run: 
    # hosted-engine --get-shared-config smtp-server --type=broker
broker : smtp.example.com, type : broker
    Copy to Clipboard Toggle word wrap
  2. Check that the default SMTP port (port 25) has been configured: 
    # hosted-engine --get-shared-config smtp-port --type=broker
broker : 25, type : broker
    Copy to Clipboard Toggle word wrap
  3. Specify an email address you want the SMTP server to use to send out email notifications. Only one address can be specified. 
    # hosted-engine --set-shared-config source-email source@example.com --type=broker
    Copy to Clipboard Toggle word wrap
  4. Specify the destination email address to receive email notifications. To specify multiple email addresses, separate each address by a comma. 
    # hosted-engine --set-shared-config destination-emails destination1@example.com,destination2@example.com --type=broker
    Copy to Clipboard Toggle word wrap
To verify that SMTP has been properly configured for your self-hosted engine environment, change the HA state on a self-hosted engine node and check if email notifications were sent. For example, you can change the HA state by placing HA agents into maintenance mode. See Section 5.1, “Maintaining the Self-Hosted Engine” for more information.
If the Manager virtual machine shuts down or needs to be migrated, there must be enough memory on a self-hosted engine node for the Manager virtual machine to restart on or migrate to it. This memory can be reserved on multiple self-hosted engine nodes by using a scheduling policy. The scheduling policy checks if enough memory to start the Manager virtual machine will remain on the specified number of additional self-hosted engine nodes before starting or migrating any virtual machines. See Creating a Scheduling Policy in the Administration Guide for more information about scheduling policies.
Additional self-hosted engine nodes need to be added to the Red Hat Virtualization Manager so that enough memory can be reserved on them for the Manager virtual machine to restart on or migrate to it. See Chapter 7, Installing Additional Hosts to a Self-Hosted Environment.

Procedure 2.6. Configuring Memory Slots Reserved for the Self-Hosted Engine on Additional Hosts

  1. Click the Cluster tab and select the cluster containing the self-hosted engine nodes.
  2. Click Edit.
  3. Click the Scheduling Policy tab.
  4. Click + and select HeSparesCount.
  5. Enter the number of additional self-hosted engine nodes that will reserve enough free memory to start the Manager virtual machine.
  6. Click OK.
To confirm whether the self-hosted engine has already been deployed run hosted-engine --check-deployed. An error will only be displayed if the self-hosted engine has not been deployed.

3.1. Troubleshooting the Manager Virtual Machine
Copy link

Check the status of the Manager virtual machine by running hosted-engine --vm-status.

Note

Any changes made to the Manager virtual machine will take about 20 seconds before they are reflected in the status command output.
Depending on the Engine status in the output, see the following suggestions to find or fix the issue.
Engine status: "health": "good", "vm": "up" "detail": "up"
  1. If the Manager virtual machine is up and running as normal, you will see the following output: 
    --== Host 1 status ==--

Status up-to-date              : True
Hostname                       : hypervisor.example.com
Host ID                        : 1
Engine status                  : {"health": "good", "vm": "up", "detail": "up"}
Score                          : 3400
stopped                        : False
Local maintenance              : False
crc32                          : 99e57eba
Host timestamp                 : 248542
    Copy to Clipboard Toggle word wrap
  2. If the output is normal but you cannot connect to the Manager, check the network connection.
Engine status: "reason": "failed liveliness check", "health": "bad", "vm": "up", "detail": "up"
  1. If the health is bad and the vm is up, the HA services will try to restart the Manager virtual machine to get the Manager back. If it does not succeed within a few minutes, enable the global maintenance mode from the command line so that the hosts are no longer managed by the HA services. 
    # hosted-engine --set-maintenance --mode=global
    Copy to Clipboard Toggle word wrap
  2. Connect to the console. When prompted, enter the operating system's root password. For more console options, see https://access.redhat.com/solutions/2221461. 
    # hosted-engine --console
    Copy to Clipboard Toggle word wrap
  3. Ensure that the Manager virtual machine's operating system is running by logging in.
  4. Check the status of the ovirt-engine service: 
    # systemctl status -l ovirt-engine
    Copy to Clipboard Toggle word wrap 
    # journalctl -u ovirt-engine
    Copy to Clipboard Toggle word wrap
  5. Check the following logs: /var/log/messages, /var/log/ovirt-engine/engine.log and /var/log/ovirt-engine/server.log.
  6. After fixing the issue, reboot the Manager virtual machine manually from one of the self-hosted engine nodes: 
    # hosted-engine --vm-shutdown
# hosted-engine --vm-start
    Copy to Clipboard Toggle word wrap

    Note

    When the self-hosted engine nodes are in global maintenance mode, the Manager virtual machine must be rebooted manually. If you try to reboot the Manager virtual machine by sending a reboot command from the command line, the Manager virtual machine will remain powered off. This is by design.
  7. On the Manager virtual machine, verify that the ovirt-engine service is up and running: 
    # systemctl status ovirt-engine.service
    Copy to Clipboard Toggle word wrap
  8. After ensuring the Manager virtual machine is up and running, close the console session and disable the maintenance mode to enable the HA services again: 
    # hosted-engine --set-maintenance --mode=none
    Copy to Clipboard Toggle word wrap
Engine status: "vm": "down", "health": "bad", "detail": "unknown", "reason": "vm not running on this host"
  1. If you have more than one host in your environment, ensure that another host is not currently trying to restart the Manager virtual machine.
  2. Ensure that you are not in global maintenance mode.
  3. Check the ovirt-ha-agent logs in /var/log/ovirt-hosted-engine-ha/agent.log.
  4. Try to reboot the Manager virtual machine manually from one of the self-hosted engine nodes: 
    # hosted-engine --vm-shutdown
# hosted-engine --vm-start
    Copy to Clipboard Toggle word wrap
Engine status: "vm": "unknown", "health": "unknown", "detail": "unknown", "reason": "failed to getVmStats"
This status means that ovirt-ha-agent failed to get the virtual machine's details from VDSM.
  1. Check the VDSM logs in /var/log/vdsm/vdsm.log.
  2. Check the ovirt-ha-agent logs in /var/log/ovirt-hosted-engine-ha/agent.log.
Engine status: The self-hosted engine's configuration has not been retrieved from shared storage
If you receive the status The hosted engine configuration has not been retrieved from shared storage. Please ensure that ovirt-ha-agent is running and the storage server is reachable there is an issue with the ovirt-ha-agent service, or with the storage, or both.
  1. Check the status of ovirt-ha-agent on the host: 
    # systemctl status -l ovirt-ha-agent
    Copy to Clipboard Toggle word wrap 
    # journalctl -u ovirt-ha-agent
    Copy to Clipboard Toggle word wrap
  2. If the ovirt-ha-agent is down, restart it: 
    # systemctl start ovirt-ha-agent
    Copy to Clipboard Toggle word wrap
  3. Check the ovirt-ha-agent logs in /var/log/ovirt-hosted-engine-ha/agent.log.
  4. Check that you can ping the shared storage.
  5. Check whether the shared storage is mounted.

Additional Troubleshooting Commands:

Important

Contact the Red Hat Support Team if you feel you need to run any of these commands to troubleshoot your self-hosted engine environment.
  • hosted-engine --reinitialize-lockspace: This command is used when the sanlock lockspace is broken. Ensure that the global maintenance mode is enabled and that the Manager virtual machine is stopped before reinitializing the sanlock lockspaces.
  • hosted-engine --clean-metadata: Remove the metadata for a host's agent from the global status database. This makes all other hosts forget about this host. Ensure that the target host is down and that the global maintenance mode is enabled.
  • hosted-engine --check-liveliness: This command checks the liveliness page of the ovirt-engine service. You can also check by connecting to https://engine-fqdn/ovirt-engine/services/health/ in a web browser.
  • hosted-engine --connect-storage: This command instructs VDSM to prepare all storage connections needed for the host and and the Manager virtual machine. This is normally run in the back-end during the self-hosted engine deployment. Ensure that the global maintenance mode is enabled if you need to run this command to troubleshoot storage issues.
If a self-hosted engine deployment was interrupted, subsequent deployments will fail with an error message. The error will differ depending on the stage in which the deployment failed. If you receive an error message, run the cleanup script to clean up the failed deployment.

Procedure 3.1. Running the Cleanup Script

  1. Run /usr/sbin/ovirt-hosted-engine-cleanup and select y to remove anything left over from the failed self-hosted engine deployment. 
    # /usr/sbin/ovirt-hosted-engine-cleanup
This will de-configure the host to run ovirt-hosted-engine-setup from scratch. 
Caution, this operation should be used with care.
Are you sure you want to proceed? [y/n]
    Copy to Clipboard Toggle word wrap
  2. Define whether to reinstall on the same shared storage device or select a different shared storage device.
    • To deploy the installation on the same storage domain, clean up the storage domain by running the following command on the for NFS, Gluster, PosixFS or local storage domains: 
      # rm -rf storage location/*
      Copy to Clipboard Toggle word wrap
    • For iSCSI or Fibre Channel Protocol (FCP) storage, see https://access.redhat.com/solutions/2121581 for information on how to clean up the storage.
    • Alternatively, select a different shared storage device.
  3. Redeploy the self-hosted engine.

4.1. Migrating to a Self-Hosted Environment
Copy link

To migrate an existing instance of a standard Red Hat Virtualization to a self-hosted engine environment, use the hosted-engine script to assist with the task. The script asks you a series of questions, and configures your environment based on your answers. The Manager from the standard Red Hat Virtualization environment is referred to as the BareMetal-Manager in the following procedure.
The RHV-M Virtual Appliance shortens the process by reducing the required user interaction with the Manager virtual machine. However, although the appliance can automate engine-setup in a standard installation, in the migration process engine-setup must be run manually so that you can restore the BareMetal-Manager backup file on the new Manager virtual machine beforehand.
The migration involves the following key actions:
  • Run the hosted-engine script to configure the host to be used as a self-hosted engine node and to create a new Red Hat Virtualization virtual machine.
  • Back up the the engine database and configuration files using the engine-backup tool, copy the backup to the new Manager virtual machine, and restore the backup using the --mode=restore parameter of engine-backup. Run engine-setup to complete the Manager virtual machine configuration.
  • Follow the hosted-engine script to complete the setup.

Prerequisites

  • Prepare a new host with the ovirt-hosted-engine-setup package installed. See Section 2.1, “Initiating Self-Hosted Engine Deployment on Red Hat Enterprise Linux Hosts” for more information on subscriptions and package installation. The host must be a supported version of the current Red Hat Virtualization environment.

    Note

    If you intend to use an existing host, place the host in maintenance and remove it from the existing environment. See Removing a Host in the Administration Guide for more information.
  • Prepare storage for your self-hosted engine environment. The self-hosted engine requires a shared storage domain dedicated to the Manager virtual machine. This domain is created during deployment, and must be at least 68 GB. For more information on preparing storage for your deployment, see the Storage chapter of the Administration Guide.

    Important

    If you are using iSCSI storage, do not use the same iSCSI target for the shared storage domain and data storage domain.
  • Obtain the RHV-M Virtual Appliance by installing the rhvm-appliance package. The RHV-M Virtual Appliance is always based on the latest supported Manager version. Ensure the Manager version in your current environment is updated to the latest supported Y-stream version as the Manager version needs to be the same for the migration.
  • To use the RHV-M Virtual Appliance for the Manager installation, ensure one directory is at least 5 GB. The hosted-engine script first checks if /var/tmp has enough space to extract the appliance files. If not, you can specify a different directory or mount external storage. The VDSM user and KVM group must have read, write, and execute permissions on the directory.
  • The fully qualified domain name of the new Manager must be the same fully qualified domain name as that of the BareMetal-Manager. Forward and reverse lookup records must both be set in DNS.
  • You must have access and can make changes to the BareMetal-Manager.
  • The virtual machine to which the BareMetal-Manager is being migrated must have the same amount of RAM as the physical machine from which the BareMetal-Manager is being migrated. If you must migrate to a virtual machine that has less RAM than the physical machine from which the BareMetal-Manager is migrated, see the following Red Hat Knowledgebase article: https://access.redhat.com/articles/2705841.

Procedure 4.1. Migrating to a Self-Hosted Environment

  1. Initiating a Self-Hosted Engine Deployment

    Note

    If your original installation was version 3.5 or earlier, and the name of the management network is rhevm, you must modify the answer file before running hosted-engine --deploy. For more information, see https://access.redhat.com/solutions/2292861.
    Run the hosted-engine script. To escape the script at any time, use the CTRL+D keyboard combination to abort deployment. It is recommended to use the screen window manager to run the script to avoid losing the session in case of network or terminal disruption. If not already installed, install the screen package, which is available in the standard Red Hat Enterprise Linux repository. 
    # yum install screen
    Copy to Clipboard Toggle word wrap 
    # screen
    Copy to Clipboard Toggle word wrap 
    # hosted-engine --deploy
    Copy to Clipboard Toggle word wrap

    Note

    In the event of session timeout or connection disruption, run screen -d -r to recover the hosted-engine deployment session.

  2. Configuring Storage

    Select the type of storage to use. 
    During customization use CTRL-D to abort.
Please specify the storage you would like to use (glusterfs, iscsi, fc, nfs3, nfs4)[nfs3]:
    Copy to Clipboard Toggle word wrap
    • For NFS storage types, specify the full address, using either the FQDN or IP address, and path name of the shared storage domain. 
      Please specify the full shared storage connection path to use (example: host:/path): storage.example.com:/hosted_engine/nfs
      Copy to Clipboard Toggle word wrap
    • For iSCSI, specify the iSCSI portal IP address, port, user name and password, and select a target name from the auto-detected list. You can only select one iSCSI target during the deployment. 
      Please specify the iSCSI portal IP address:           
Please specify the iSCSI portal port [3260]:           
Please specify the iSCSI portal user:           
Please specify the iSCSI portal password:
Please specify the target name (auto-detected values) [default]:
      Copy to Clipboard Toggle word wrap
    • For Gluster storage, specify the full address, using either the FQDN or IP address, and path name of the shared storage domain.

      Important

      Only replica 3 Gluster storage is supported. Ensure the following configuration has been made:
      • In the /etc/glusterfs/glusterd.vol file on all three Gluster servers, set rpc-auth-allow-insecure to on. 
        option rpc-auth-allow-insecure on
        Copy to Clipboard Toggle word wrap
      • Configure the volume as follows: 
        gluster volume set volume cluster.quorum-type auto
gluster volume set volume network.ping-timeout 10
gluster volume set volume auth.allow \*
gluster volume set volume group virt
gluster volume set volume storage.owner-uid 36
gluster volume set volume storage.owner-gid 36
gluster volume set volume server.allow-insecure on
        Copy to Clipboard Toggle word wrap 
      Please specify the full shared storage connection path to use (example: host:/path): storage.example.com:/hosted_engine/gluster_volume
      Copy to Clipboard Toggle word wrap
    • For Fibre Channel, the host bus adapters must be configured and connected, and the hosted-engine script will auto-detect the LUNs available. The LUNs must not contain any existing data. 
      The following luns have been found on the requested target:
[1]     3514f0c5447600351       30GiB   XtremIO XtremApp
                        status: used, paths: 2 active
          
[2]     3514f0c5447600352       30GiB   XtremIO XtremApp
                        status: used, paths: 2 active

Please select the destination LUN (1, 2) [1]:
      Copy to Clipboard Toggle word wrap

  3. Configuring the Network

    The script detects possible network interface controllers (NICs) to use as a management bridge for the environment. It then checks your firewall configuration and offers to modify it for console (SPICE or VNC) access HostedEngine-VM. Provide a pingable gateway IP address, to be used by the ovirt-ha-agent to help determine a host's suitability for running HostedEngine-VM. 
    Please indicate a nic to set rhvm bridge on: (eth1, eth0) [eth1]:
iptables was detected on your computer, do you wish setup to configure it? (Yes, No)[Yes]: 
Please indicate a pingable gateway IP address [X.X.X.X]:
    Copy to Clipboard Toggle word wrap

  4. Configuring the Virtual Machine

    The script creates a virtual machine to be configured as the Red Hat Virtualization Manager, referred to in this procedure as HostedEngine-VM. Select disk for the boot device type, and the script will automatically detect the RHV-M Appliances available. Select an appliance. 
             Please specify the device to boot the VM from (choose disk for the oVirt engine appliance) 
         (cdrom, disk, pxe) [disk]: 
         Please specify the console type you would like to use to connect to the VM (vnc, spice) [vnc]: vnc
[ INFO ] Detecting available oVirt engine appliances
         The following appliance have been found on your system:
               [1] - The oVirt Engine Appliance image (OVA)
               [2] - Directly select an OVA file
         Please select an appliance (1, 2) [1]:
[ INFO ] Checking OVF archive content (could take a few minutes depending on archive size)
    Copy to Clipboard Toggle word wrap
    Specify Yes if you want cloud-init to take care of the initial configuration of the Manager virtual machine. Specify Generate for cloud-init to take care of tasks like setting the root password, configuring networking, and configuring the host name. Optionally, select Existing if you have an existing cloud-init script to take care of more sophisticated functions of cloud-init. Specify the FQDN for the Manager virtual machine. This must be the same FQDN provided for the BareMetal-Manager.

    Note

    For more information on cloud-init, see https://cloudinit.readthedocs.org/en/latest/. 
    Would you like to use cloud-init to customize the appliance on the first boot (Yes, No)[Yes]? Yes
Would you like to generate on-fly a cloud-init no-cloud ISO image or do you have an existing one(Generate, Existing)[Generate]? Generate
Please provide the FQDN you would like to use for the engine appliance.
Note: This will be the FQDN of the engine VM you are now going to launch.
It should not point to the base host or to any other existing machine.
Engine VM FQDN: (leave it empty to skip): manager.example.com
    Copy to Clipboard Toggle word wrap
    You must answer No to the following question so that you can restore the BareMetal-Manager backup file on HostedEngine-VM before running engine-setup. 
    Automatically execute engine-setup on the engine appliance on first boot (Yes, No)[Yes]? No
    Copy to Clipboard Toggle word wrap
    Configure the Manager domain name, root password, networking, hardware, and console access details. 
    Enter root password that will be used for the engine appliance (leave it empty to skip): p@ssw0rd
Confirm appliance root password: p@ssw0rd
The following CPU types are supported by this host:
    - model_Penryn: Intel Penryn Family
    - model_Conroe: Intel Conroe Family
Please specify the CPU type to be used by the VM [model_Penryn]: 
Please specify the number of virtual CPUs for the VM [Defaults to appliance OVF value: 4]: 
You may specify a MAC address for the VM or accept a randomly generated default [00:16:3e:77:b2:a4]: 
How should the engine VM network be configured (DHCP, Static)[DHCP]? Static
Please enter the IP address to be used for the engine VM: 192.168.x.x
Please provide a comma-separated list (max3) of IP addresses of domain name servers for the engine VM
Engine VM DNS (leave it empty to skip):
Add lines for the appliance itself and for this host to /etc/hosts on the engine VM?
Note: ensuring that this host could resolve the engine VM hostname is still up to you (Yes, No)[No] Yes
    Copy to Clipboard Toggle word wrap

  5. Configuring the Self-Hosted Engine

    Specify the name for Host-HE1 to be identified in the Red Hat Virtualization environment, and the password for the admin@internal user to access the Administration Portal. Finally, provide the name and TCP port number of the SMTP server, the email address used to send email notifications, and a comma-separated list of email addresses to receive these notifications. 
    Enter engine admin password: p@ssw0rd
Confirm engine admin password: p@ssw0rd
Enter the name which will be used to identify this host inside the Administrator Portal [hosted_engine_1]:
Please provide the FQDN for the engine you would like to use.
          This needs to match the FQDN that you will use for the engine installation within the VM.
          Note: This will be the FQDN of the VM you are now going to create,
          it should not point to the base host or to any other existing machine.
          Engine FQDN:  []: manager.example.com
Please provide the name of the SMTP server through which we will send notifications [localhost]: 
Please provide the TCP port number of the SMTP server [25]: 
Please provide the email address from which notifications will be sent [root@localhost]: 
Please provide a comma-separated list of email addresses which will get notifications [root@localhost]:
    Copy to Clipboard Toggle word wrap

  6. Configuration Preview

    Before proceeding, the hosted-engine script displays the configuration values you have entered, and prompts for confirmation to proceed with these values. 
    Bridge interface                 : eth1
Engine FQDN                      : manager.example.com
Bridge name                      : ovirtmgmt
Host address                     : host.example.com
SSH daemon port                  : 22
Firewall manager                 : iptables
Gateway address                  : X.X.X.X
Host name for web application    : Host-HE1
Host ID                          : 1
Image size GB                    : 50
Storage connection               : storage.example.com:/hosted_engine/nfs
Console type                     : vnc
Memory size MB                   : 4096
MAC address                      : 00:16:3e:77:b2:a4
Boot type                        : pxe
Number of CPUs                   : 2
CPU Type                         : model_Penryn

Please confirm installation settings (Yes, No)[Yes]:
    Copy to Clipboard Toggle word wrap

  7. Creating HostedEngine-VM

    The script creates the virtual machine to be configured as HostedEngine-VM and provides connection details. You must manually run engine-setup after restoring the backup file on HostedEngine-VM before the hosted-engine script can proceed on Host-HE1. 
    [ INFO  ] Stage: Transaction setup
...
[ INFO  ] Creating VM
          You can now connect to the VM with the following command:
                  /bin/remote-viewer vnc://localhost:5900
          Use temporary password "3463VnKn" to connect to vnc console.
          Please note that in order to use remote-viewer you need to be able to run graphical applications.
          This means that if you are using ssh you have to supply the -Y flag (enables trusted X11 forwarding).
          Otherwise you can run the command from a terminal in your preferred desktop environment.
          If you cannot run graphical applications you can connect to the graphic console from another host or connect to the serial console using the following command:
          socat UNIX-CONNECT:/var/run/ovirt-vmconsole-console/8f74b589-8c6f-4a32-9adf-6e615b69de07.sock,user=ovirt-vmconsole STDIO,raw,echo=0,escape=1
          Please ensure that your Guest OS is properly configured to support serial console according to your distro documentation.
          Follow http://www.ovirt.org/Serial_Console_Setup#I_need_to_access_the_console_the_old_way for more info.
          If you need to reboot the VM you will need to start it manually using the command:
          hosted-engine --vm-start
          You can then set a temporary password using the command:
          hosted-engine --add-console-password
          Please install and setup the engine in the VM.
          You may also be interested in subscribing to "agent" RHN/Satellite channel and installing rhevm-guest-agent-common package in the VM.
        
        
          The VM has been rebooted.
          To continue please install oVirt-Engine in the VM
          (Follow http://www.ovirt.org/Quick_Start_Guide for more info).
        
          Make a selection from the options below:
          (1) Continue setup - oVirt-Engine installation is ready and ovirt-engine service is up
          (2) Abort setup
          (3) Power off and restart the VM
          (4) Destroy VM and abort setup
        
          (1, 2, 3, 4)[1]:
    Copy to Clipboard Toggle word wrap
    Connect to the virtual machine using the VNC protocol with the following command. Replace FQDN with the fully qualified domain name or the IP address of the self-hosted engine node. 
    # /bin/remote-viewer vnc://FQDN:5900
    Copy to Clipboard Toggle word wrap

  8. Enabling SSH on HostedEngine-VM

    SSH password authentication is not enabled by default on the RHV-M Virtual Appliance. Connect to HostedEngine-VM via VNC and enable SSH password authentication so that you can access the virtual machine via SSH later to restore the BareMetal-Manager backup file and configure the new Manager. Verify that the sshd service is running. Edit /etc/ssh/sshd_config and change the following two options to yes: 
    [...]
PermitRootLogin yes       
[...]
PasswordAuthentication yes
    Copy to Clipboard Toggle word wrap
    Restart the sshd service for the changes to take effect. 
    # systemctl restart sshd.service
    Copy to Clipboard Toggle word wrap

  9. Disabling BareMetal-Manager

    Connect to BareMetal-Manager, the Manager of your established Red Hat Virtualization environment, and stop the ovirt-engine service and prevent it from running. 
    # systemctl stop ovirt-engine.service
# systemctl disable ovirt-engine.service
    Copy to Clipboard Toggle word wrap

    Note

    Though stopping BareMetal-Manager from running is not obligatory, it is recommended as it ensures no changes are made to the environment after the backup is created. Additionally, it prevents BareMetal-Manager and HostedEngine-VM from simultaneously managing existing resources.

  10. Updating DNS

    Update your DNS so that the FQDN of the Red Hat Virtualization environment correlates to the IP address of HostedEngine-VM and the FQDN previously provided when configuring the hosted-engine deployment script on Host-HE1. In this procedure, FQDN was set as manager.example.com because in a migrated hosted-engine setup, the FQDN provided for the engine must be identical to that given in the engine setup of the original engine.

  11. Creating a Backup of BareMetal-Manager

    1. Ensure the management network (ovirtmgmt)is configured as a VM network before performing the backup. For more information, see Explanation of Settings and Controls in the New Logical Network and Edit Logical Network Windows in the Administration Guide.
    Connect to BareMetal-Manager and run the engine-backup command with the --mode=backup, --file=FILE, and --log=LogFILE parameters to specify the backup mode, the name of the backup file created and used for the backup, and the name of the log file to be created to store the backup log. 
    # engine-backup --mode=backup --file=FILE --log=LogFILE
    Copy to Clipboard Toggle word wrap

  12. Copying the Backup File to HostedEngine-VM

    On BareMetal-Manager, secure copy the backup file to HostedEngine-VM. In the following example, manager.example.com is the FQDN for HostedEngine-VM, and /backup/ is any designated folder or path. If the designated folder or path does not exist, you must connect to HostedEngine-VM and create it before secure copying the backup from BareMetal-Manager. 
    # scp -p FILE LogFILE manager.example.com:/backup/
    Copy to Clipboard Toggle word wrap

  13. Registering HostedEngine-VM

    Register HostedEngine-VM with Red Hat Subscription Management and enable the required repositories. See Subscribing to the Required Entitlements in the Installation Guide.

  14. Restoring the Backup File on HostedEngine-VM

    Use the engine-backup tool to restore a complete backup. If you configured the BareMetal-Manager database(s) manually during engine-setup, follow the instructions at Section 6.2.3, “Restoring the Self-Hosted Engine Manager Manually” to restore the backup environment manually.
    • If you are only restoring the Manager, run: 
      # engine-backup --mode=restore --file=file_name --log=log_file_name --provision-db --restore-permissions
      Copy to Clipboard Toggle word wrap
    • If you are restoring the Manager and Data Warehouse, run: 
      # engine-backup --mode=restore --file=file_name --log=log_file_name --provision-db --provision-dwh-db --restore-permissions
      Copy to Clipboard Toggle word wrap
    If successful, the following output displays: 
    You should now run engine-setup.
Done.
    Copy to Clipboard Toggle word wrap

  15. Configuring HostedEngine-VM

    Configure the restored Manager virtual machine. This process identifies the existing configuration settings and database content. Confirm the settings. Upon completion, the setup provides an SSH fingerprint and an internal Certificate Authority hash. 
    # engine-setup
    Copy to Clipboard Toggle word wrap 
    [ INFO  ] Stage: Initializing
[ INFO  ] Stage: Environment setup
Configuration files: ['/etc/ovirt-engine-setup.conf.d/10-packaging.conf', '/etc/ovirt-engine-setup.conf.d/20-setup-ovirt-post.conf']
Log file: /var/log/ovirt-engine/setup/ovirt-engine-setup-20140304075238.log
Version: otopi-1.1.2 (otopi-1.1.2-1.el6ev)
[ INFO  ] Stage: Environment packages setup
[ INFO  ] Yum Downloading: rhel-65-zstream/primary_db 2.8 M(70%)
[ INFO  ] Stage: Programs detection
[ INFO  ] Stage: Environment setup
[ INFO  ] Stage: Environment customization
         
          --== PACKAGES ==--
         
[ INFO  ] Checking for product updates...
[ INFO  ] No product updates found
         
          --== NETWORK CONFIGURATION ==--
         
Setup can automatically configure the firewall on this system.
Note: automatic configuration of the firewall may overwrite current settings.
Do you want Setup to configure the firewall? (Yes, No) [Yes]: 
[ INFO  ] iptables will be configured as firewall manager.
         
          --== DATABASE CONFIGURATION ==--
         
         
          --== OVIRT ENGINE CONFIGURATION ==--
         
         
          --== PKI CONFIGURATION ==--
         
         
          --== APACHE CONFIGURATION ==--
         
         
          --== SYSTEM CONFIGURATION ==--
         
         
          --== END OF CONFIGURATION ==--
         
[ INFO  ] Stage: Setup validation
[ INFO  ] Cleaning stale zombie tasks
         
          --== CONFIGURATION PREVIEW ==--
         
          Default SAN wipe after delete           : False
          Firewall manager                        : iptables
          Update Firewall                         : True
          Host FQDN                               : manager.example.com
          Engine database secured connection      : False
          Engine database host                    : X.X.X.X
          Engine database user name               : engine
          Engine database name                    : engine
          Engine database port                    : 5432
          Engine database host name validation    : False
          Engine installation                     : True
          PKI organization                        : example.com
          NFS mount point                         : /var/lib/exports/iso
          Configure VMConsole Proxy               : True
          Engine Host FQDN                        : manager.example.com
          Configure WebSocket Proxy               : True
         
          Please confirm installation settings (OK, Cancel) [OK]:
    Copy to Clipboard Toggle word wrap

  16. Synchronizing the Host and the Manager

    Return to Host-HE1 and continue the hosted-engine deployment script by selecting option 1: 
    (1) Continue setup - oVirt-Engine installation is ready and ovirt-engine service is up
    Copy to Clipboard Toggle word wrap
    The script displays the internal Certificate Authority hash, and prompts you to select the cluster to which to add Host-HE1. 
    [ INFO  ] Engine replied: DB Up!Welcome to Health Status!
[ INFO  ] Acquiring internal CA cert from the engine
[ INFO  ] The following CA certificate is going to be used, please immediately interrupt if not correct:
[ INFO  ] Issuer: C=US, O=example.com, CN=manager.example.com.23240, Subject: C=US, O=example.com, CN=manager.example.com.23240, Fingerprint (SHA-1): XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
[ INFO  ] Connecting to the Engine
          Enter the name of the cluster to which you want to add the host (DB1, DB2, Default) [Default]:
[ INFO  ] Waiting for the host to become operational in the engine. This may take several minutes...
[ INFO  ] The VDSM Host is now operational
[ INFO  ] Saving hosted-engine configuration on the shared storage domain
          Please shutdown the VM allowing the system to launch it as a monitored service.
          The system will wait until the VM is down.
    Copy to Clipboard Toggle word wrap

  17. Shutting Down HostedEngine-VM

    Shut down HostedEngine-VM. 
    # shutdown -h now
    Copy to Clipboard Toggle word wrap

  18. Setup Confirmation

    Return to Host-HE1 to confirm it has detected that HostedEngine-VM is down. 
    [ INFO  ] Enabling and starting HA services
[ INFO  ] Stage: Clean up
[ INFO  ] Generating answer file '/var/lib/ovirt-hosted-engine-setup/answers/answers-20160509162843.conf'
[ INFO  ] Generating answer file '/etc/ovirt-hosted-engine/answers.conf'
[ INFO  ] Stage: Pre-termination
[ INFO  ] Stage: Termination
[ INFO  ] Hosted Engine successfully set up
    Copy to Clipboard Toggle word wrap
Your Red Hat Virtualization engine has been migrated to a self-hosted engine setup. The Manager is now operating on a virtual machine on Host-HE1, called HostedEngine-VM in the environment. As HostedEngine-VM is highly available, it is migrated to other self-hosted engine nodes in the environment when applicable.

Chapter 5. Maintenance and Upgrading Resources
Copy link

5.1. Maintaining the Self-Hosted Engine
Copy link

The maintenance modes enable you to start, stop, and modify the Manager virtual machine without interference from the high-availability agents, and to restart and modify the self-hosted engine nodes in the environment without interfering with the Manager.
There are three maintenance modes that can be enforced:
  • global - All high-availability agents in the cluster are disabled from monitoring the state of the Manager virtual machine. The global maintenance mode must be applied for any setup or upgrade operations that require the ovirt-engine service to be stopped, such as upgrading to a later version of Red Hat Virtualization.
  • local - The high-availability agent on the node issuing the command is disabled from monitoring the state of the Manager virtual machine. The node is exempt from hosting the Manager virtual machine while in local maintenance mode; if hosting the Manager virtual machine when placed into this mode, the Manager will migrate to another node, provided there is one available. The local maintenance mode is recommended when applying system changes or updates to a self-hosted engine node.
  • none - Disables maintenance mode, ensuring that the high-availability agents are operating.

Procedure 5.1. Maintaining a RHEL-Based Self-Hosted Engine (Local Maintenance)

  1. Place a self-hosted engine node into the local maintenance mode:
    • In the Administration Portal, select a self-hosted engine node and click Managament → Maintenance. The local maintenance mode is automatically triggered for that node.
    • You can also set the maintenance mode from the command line: 
      # hosted-engine --set-maintenance --mode=local
      Copy to Clipboard Toggle word wrap
  2. After you have completed any maintenance tasks, disable the maintenance mode: 
    # hosted-engine --set-maintenance --mode=none
    Copy to Clipboard Toggle word wrap

Procedure 5.2. Maintaining a RHEL-Based Self-Hosted Engine (Global Maintenance)

  1. Place self-hosted engine nodes into global maintenance mode:
    • In the Administration Portal, right-click any self-hosted engine node, and select Enable Global HA Maintenance.
    • You can also set the maintenance mode from the command line: 
      # hosted-engine --set-maintenance --mode=global
      Copy to Clipboard Toggle word wrap
  2. After you have completed any maintenance tasks, disable the maintenance mode: 
    # hosted-engine --set-maintenance --mode=none
    Copy to Clipboard Toggle word wrap
To remove a self-hosted engine node from your environment, place the node into maintenance mode, undeploy the node, and optionally remove it. The node can be managed as a regular host after the HA services have been stopped, and the self-hosted engine configuration files have been removed.

Procedure 5.3. Removing a Host from a Self-Hosted Engine Environment

  1. In the Administration Portal, click the Hosts tab. Select the self-hosted engine node and click Management → Maintenance to set it to the local maintenance mode.
  2. Click Installation → Reinstall.
  3. Click the Hosted Engine tab and select UNDEPLOY. This action stops the ovirt-ha-agent and ovirt-ha-broker services and removes the self-hosted engine configuration file.
  4. Click OK.
  5. Optionally, click Remove to open the Remove Host(s) confirmation window, and click OK.

5.3. Upgrading a Self-Hosted Engine Environment
Copy link

To upgrade your Red Hat Virtualization self-hosted engine environment from version 4.0 to 4.1, upgrade the Manager virtual machine, the self-hosted engine nodes, and any standard hosts. All hosts in a self-hosted engine environment must be the same version; you cannot upgrade only some of the hosts.
To upgrade a version of Red Hat Virtualization earlier than 4.0 to Red Hat Virtualization 4.1, you must sequentially upgrade to any later versions of Red Hat Virtualization before upgrading to the latest version. For example, if you are using Red Hat Enterprise Virtualization 3.6, you must upgrade to the latest minor version of Red Hat Virtualization 4.0 before you can upgrade to Red Hat Virtualization 4.1. See the Upgrade Guide for Red Hat Virtualization 4.0 for instructions to upgrade to the latest 4.0 minor version.
Before upgrading the Manager virtual machine, ensure the /var/tmp directory contains 5 GB free space to extract the appliance files. If it does not, you can specify a different directory or mount alternate storage that does have the required space. The VDSM user and KVM group must have read, write, and execute permissions on the directory.
The upgrade process involves the following key steps:
  • Place the high-availability agents that manage the Manager virtual machine into global maintenance mode.
  • Upgrade the Manager virtual machine.
  • Place a self-hosted engine node into maintenance. The Manager virtual machine and other virtual machines will be migrated to another host in the cluster if necessary.
  • Update the self-hosted engine node. Repeat for all hosts. Red Hat recommends updating all hosts in the environment, including standard hosts.
  • After all hosts in the cluster and the Manager virtual machine have been upgraded, change the cluster compatibility version to 4.1.

Procedure 5.4. Upgrading a Self-Hosted Engine Environment

  1. Disable the high-availability agents on all the self-hosted engine nodes. In the Hosts tab, right-click a self-hosted engine node and select Enable Global HA Maintenance.
    After a few minutes, check that the General tab in the details pane reports Hosted Engine HA: Global Maintenance Enabled to confirm that the environment is in maintenance mode.
  2. Log in to the Manager virtual machine to upgrade the Red Hat Virtualization Manager.
    1. Enable the Red Hat Virtualization Manager 4.1 and Red Hat Virtualization Tools repositories: 
      # subscription-manager repos --enable=rhel-7-server-rhv-4.1-rpms
# subscription-manager repos --enable=rhel-7-server-rhv-4-tools-rpms
      Copy to Clipboard Toggle word wrap
    2. Update the setup packages: 
      # yum update ovirt\*setup\*
      Copy to Clipboard Toggle word wrap
    3. Run engine-setup and follow the prompts to upgrade the Red Hat Virtualization Manager: 
      # engine-setup
      Copy to Clipboard Toggle word wrap
    4. Remove or disable the Red Hat Virtualization Manager 4.0 repository to ensure the system does not use any Red Hat Virtualization Manager 4.0 packages: 
      # subscription-manager repos --disable=rhel-7-server-rhv-4.0-rpms
      Copy to Clipboard Toggle word wrap
    5. Update the base operating system: 
      # yum update
      Copy to Clipboard Toggle word wrap

      Important

      If any kernel packages were updated, reboot the Manager virtual machine manually to complete the update. See Troubleshooting the Manager Virtual Machine.
    6. Disable global maintenance. In the Administration Portal, click the Hosts tab. Right-click a self-hosted engine node and select Disable Global HA Maintenance.
  3. Update the self-hosted engine nodes, then any standard hosts in the environment:
    1. In the Administration Portal, click the Hosts tab. Right-click a host and select Management → Maintenance to place the host into local maintenance. If the host is hosting the Manager virtual machine, the virtual machine will be migrated to another host. Any other virtual machines will be migrated according to your virtual machine migration policy. The high-availability agents are automatically placed into local maintenance.
    2. Ensure the correct repository is enabled: 
      # subscription-manager repos --enable=rhel-7-server-rhv-4-mgmt-agent-rpms
# subscription-manager repos --enable=rhel-7-server-ansible-2-rpms
      Copy to Clipboard Toggle word wrap
    3. Update the host:
      • On a Red Hat Enterprise Linux host, log in to the host machine and run the following command: 
        # yum update
        Copy to Clipboard Toggle word wrap
      • On a Red Hat Virtualization Host (RHVH), log in to the Cockpit user interface, click Terminal, and run the following command: 
        # yum update
        Copy to Clipboard Toggle word wrap

      Important

      If any kernel packages were updated, reboot the host to complete the update.
    4. Select the same host and click Management → Activate.
    5. Repeat these steps to update all hosts.
  4. Update the cluster and data center compatibility version to 4.1. See Post-Upgrade Tasks in the Upgrade Guide for more information.

    Important

    Only update the compatibility version if all hosts have been updated for Red Hat Virtualization 4.1 to avoid some hosts becoming non-operational.
Updating a self-hosted engine to a minor release requires placing the machine in global maintenance mode and then following the standard procedures for updating between minor versions.
  1. Ensure you have subscribed the Manager virtual machine to the required entitlements. See Subscribing to the Required Entitlements in the Installation Guide for more information.
  2. Place the system in global maintenance mode. See Section 5.1, “Maintaining the Self-Hosted Engine” for details.
  3. Follow the procedures for updating between minor versions using engine-setup. See Updates Between Minor Releases in the Upgrade Guide for details.
  4. Disable global maintenance mode. See Section 5.1, “Maintaining the Self-Hosted Engine” for details.
To upgrade a Red Hat Enterprise Virtualization 3.6 self-hosted engine environment that contains only Red Hat Enterprise Virtualization Hypervisors (RHEV-H) to Red Hat Virtualization 4.0 and later, you must remove the hosts and upgrade them to Red Hat Virtualization Host (RHVH). Because the host "upgrade" is actually a reinstall, you can skip the 4.0 version of RHVH and reinstall the hosts with RHVH 4.1 directly.
Self-hosted engine nodes in Red Hat Enterprise Virtualization 3.6 are added using the hosted-engine --deploy command, which is not available on RHVH 4.1 for adding more nodes, and self-hosted engine nodes in Red Hat Virtualization 4.1 are added using the UI, which is not available in Red Hat Enterprise Virtualization 3.6. Therefore, to upgrade the environment from 3.6 to 4.1, you must first install a self-hosted engine node running RHVH 4.0, on which the hosted-engine --deploy command is deprecated but still available.

Note

This scenario does not impact self-hosted engine environments that contain some (or only) Red Hat Enterprise Linux self-hosted engine nodes, as they can be updated without being removed from the environment.
Upgrading from a Red Hat Enterprise Virtualization 3.6 self-hosted engine environment with RHEV-H 3.6 hosts to a Red Hat Virtualization 4.1 environment with RHVH 4.1 hosts involves the following key steps:
  • Install a new RHVH 4.0 host and add it to the 3.6 self-hosted engine environment. The new host can be an existing RHEV-H 3.6 host removed from the environment and reinstalled with RHVH 4.0.
  • Upgrade the Manager from 3.6 to 4.0.
  • Remove the rest of the RHEV-H 3.6 hosts and reinstall them with RHVH 4.1.
  • Add the RHVH 4.1 hosts to the 4.0 environment.
  • Upgrade the Manager from 4.0 to 4.1.
  • Update the remaining RHVH 4.0 host to RHVH 4.1.
Alternatively, you can install a 3.6 version of RHVH in the 3.6 environment and perform a standard stepped upgrade from 3.6 to 4.0, and 4.0 to 4.1. See Red Hat Virtualization Hosts in the Red Hat Enterprise Virtualization 3.6 Self-Hosted Engine Guide for more information.

Procedure 5.5. Upgrading a RHEV-H 3.6 Self-Hosted Engine to a RHVH 4.1 Self-Hosted Engine

  1. If you are removing a RHEV-H 3.6 host from the environment to reinstall with RHVH 4.0, see Section 5.2, “Removing a Host from a Self-Hosted Engine Environment”.
  2. Upgrade the environment from 3.6 to 4.0 using the instructions in Upgrading a RHEV-H-Based Self-Hosted Engine Environment in the Red Hat Virtualization 4.0 Self-Hosted Engine Guide.
  3. Upgrade each RHEV-H 3.6 host directly to RHVH 4.1:
    1. Remove the host from the self-hosted engine environment. See Section 5.2, “Removing a Host from a Self-Hosted Engine Environment”.
    2. Reinstall the host with RHVH 4.1. See Installing Red Hat Virtualization Host in the Installation Guide.
    3. Add the host to the 4.0 environment. See Installing Additional Hosts to a Self-Hosted Environment in the Red Hat Virtualization 4.0 Self-Hosted Engine Guide.
  4. Upgrade the Manager and the remaining RHVH 4.0 host to 4.1 using the instructions in Section 5.3, “Upgrading a Self-Hosted Engine Environment”.
The nature of the self-hosted engine, and the relationship between the self-hosted engine nodes and the Manager virtual machine, means that backing up and restoring a self-hosted engine environment requires additional considerations to that of a standard Red Hat Virtualization environment. In particular, the self-hosted engine nodes remain in the environment at the time of backup, which can result in a failure to synchronize the new node and Manager virtual machine after the environment has been restored.
To address this, Red Hat recommends that one of the nodes be placed into maintenance mode prior to backup, thereby freeing it from a virtual load. This failover host can then be used to deploy the new self-hosted engine.
If a self-hosted engine node is carrying a virtual load at the time of backup, then a host with any of the matching identifiers - IP address, FQDN, or name - cannot be used to deploy a restored self-hosted engine. Conflicts in the database will prevent the host from synchronizing with the restored Manager virtual machine. The failover host, however, can be removed from the restored Manager virtual machine prior to synchronization.

Note

A failover host at the time of backup is not strictly necessary if a new host is used to deploy the self-hosted engine. The new host must have a unique IP address, FQDN, and name so that it does not conflict with any of the hosts present in the database backup.

Procedure 6.1. Workflow for Backing Up the Self-Hosted Engine Environment

This procedure provides an example of the workflow for backing up a self-hosted engine using a failover host. This host can then be used later to deploy the restored self-hosted engine environment. For more information on backing up the self-hosted engine, see Section 6.1, “Backing up the Self-Hosted Engine Manager Virtual Machine”.
  1. The Manager virtual machine is running on Host 2 and the six regular virtual machines in the environment are balanced across the three hosts.
    View larger image
    Place Host 1 into maintenance mode. This will migrate the virtual machines on Host 1 to the other hosts, freeing it of any virtual load and enabling it to be used as a failover host for the backup.
  2. Host 1 is in maintenance mode. The two virtual machines it previously hosted have been migrated to Host 3.
    View larger image
    Use engine-backup to create backups of the environment. After the backup has been taken, Host 1 can be activated again to host virtual machines, including the Manager virtual machine.

Procedure 6.2. Workflow for Restoring the Self-Hosted Engine Environment

This procedure provides an example of the workflow for restoring the self-hosted engine environment from a backup. The failover host deploys the new Manager virtual machine, which then restores the backup. Directly after the backup has been restored, the failover host is still present in the Red Hat Virtualization Manager because it was in the environment when the backup was created. Removing the old failover host from the Manager enables the new host to synchronize with the Manager virtual machine and finalize deployment. For more information on restoring the self-hosted engine, see Section 6.2, “Restoring the Self-Hosted Engine Environment”.
  1. Host 1 has been used to deploy a new self-hosted engine and has restored the backup taken in the previous example procedure. Deploying the restored environment involves additional steps to that of a regular self-hosted engine deployment:
    • After Red Hat Virtualization Manager has been installed on the Manager virtual machine, but before engine-setup is first run, restore the backup using the engine-backup tool.
    • After engine-setup has configured and restored the Manager, log in to the Administration Portal and remove Host 1, which will be present from the backup. If old Host 1 is not removed, and is still present in the Manager when finalizing deployment on new Host 1, the Manager virtual machine will not be able to synchronize with new Host 1 and the deployment will fail.
    View larger image
    After Host 1 and the Manager virtual machine have synchronized and the deployment has been finalized, the environment can be considered operational on a basic level. With only one self-hosted engine node, the Manager virtual machine is not highly available. However, if necessary, high-priority virtual machines can be started on Host 1.
    Any standard RHEL-based hosts - hosts that are present in the environment but are not self-hosted engine nodes - that are operational will become active, and the virtual machines that were active at the time of backup will now be running on these hosts and available in the Manager.
  2. Host 2 and Host 3 are not recoverable in their current state. These hosts need to be removed from the environment, and then added again to the environment using the hosted-engine deployment script. For more information on these actions, see Section 6.2.4, “Removing Non-Operational Hosts from a Restored Self-Hosted Engine Environment” and Chapter 7, Installing Additional Hosts to a Self-Hosted Environment.
    View larger image
    Host 2 and Host 3 have been re-deployed into the restored environment. The environment is now as it was in the first image, before the backup was taken, with the exception that the Manager virtual machine is hosted on Host 1.
Red Hat recommends backing up your self-hosted engine environment regularly. The supported backup method uses the engine-backup tool and can be performed without interrupting the ovirt-engine service. The engine-backup tool only allows you to back up the Red Hat Virtualization Manager virtual machine, but not the self-hosted engine node that runs the Manager virtual machine or other virtual machines hosted in the environment.

Warning

The engine-backup tool must be used for backup and restoration. If a third-party tool is used, it must back up the tar file produced by the engine-backup tool.

Procedure 6.3. Backing up the Original Red Hat Virtualization Manager

  1. Preparing the Failover Host

    A failover host, one of the self-hosted engine nodes in the environment, must be placed into maintenance mode so that it has no virtual load at the time of the backup. This host can then later be used to deploy the restored self-hosted engine environment. Any of the self-hosted engine nodes can be used as the failover host for this backup scenario, however the restore process is more straightforward if Host 1 is used. The default name for the Host 1 host is hosted_engine_1; this was set when the hosted-engine deployment script was initially run.
    1. Log in to one of the self-hosted engine nodes.
    2. Confirm that the hosted_engine_1 host is Host 1: 
       # hosted-engine --vm-status
      Copy to Clipboard Toggle word wrap
    3. Log in to the Administration Portal.
    4. Click the Hosts tab.
    5. Select the hosted_engine_1 host in the results list, and click Management → Maintenance.
    6. Click Ok.
    Depending on the virtual load of the host, it may take some time for all the virtual machines to be migrated. Proceed to the next step after the host status has changed to Maintenance.

  2. Creating a Backup of the Manager

    On the Manager virtual machine, back up the configuration settings and database content, replacing [EngineBackupFile] with the file name for the backup file, and [LogFILE] with the file name for the backup log. 
    # engine-backup --mode=backup --file=[EngineBackupFile] --log=[LogFILE]
    Copy to Clipboard Toggle word wrap

  3. Backing up the Files to an External Server

    Back up the files to an external server. In the following example, [Storage.example.com] is the fully qualified domain name of a network storage server that will store the backup until it is needed, and /backup/ is any designated folder or path. The backup files must be accessible to restore the configuration settings and database content. 
    # scp -p [EngineBackupFiles] [Storage.example.com:/backup/EngineBackupFiles]
    Copy to Clipboard Toggle word wrap

  4. Activating the Failover Host

    Bring the hosted_engine_1 host out of maintenance mode.
    1. Log in to the Administration Portal.
    2. Click the Hosts tab.
    3. Select hosted_engine_1 from the results list.
    4. Click Management → Activate.
You have backed up the configuration settings and database content of the Red Hat Virtualization Manager virtual machine.

6.2. Restoring the Self-Hosted Engine Environment
Copy link

This section explains how to restore a self-hosted engine environment from a backup on a newly installed host. The supported restore method uses the engine-backup tool.

Warning

The restoration procedure requires the tar backup file produced by the engine-backup tool. If a third-party tool is used, it must create a backup of the tar file.
Restoring a self-hosted engine environment involves the following key actions:
  1. Create a newly installed Red Hat Enterprise Linux host and run the hosted-engine deployment script.
  2. Restore the Red Hat Virtualization Manager configuration settings and database content in the new Manager virtual machine.
  3. Remove self-hosted engine nodes in a Non Operational state and re-install them into the restored self-hosted engine environment.

Prerequisites

  • To restore a self-hosted engine environment, you must prepare a newly installed Red Hat Enterprise Linux system on a physical host.
  • The operating system version of the new host and Manager must be the same as that of the original host and Manager.
  • You must have Red Hat Subscription Manager entitlements for your new environment. For a list of the required repositories, see Subscribing to the Required Entitlements in the Installation Guide.
  • The fully qualified domain name of the new Manager must be the same fully qualified domain name as that of the original Manager. Forward and reverse lookup records must both be set in DNS.
  • You must prepare storage for the new self-hosted engine environment to use as the Manager virtual machine's shared storage domain. This domain must be at least 68 GB. For more information on preparing storage for your deployment, see the Storage chapter of the Administration Guide.
You can restore a self-hosted engine on hardware that was used in the backed-up environment. However, you must use the failover host for the restored deployment. The failover host, Host 1, used in Section 6.1, “Backing up the Self-Hosted Engine Manager Virtual Machine” uses the default hostname of hosted_engine_1 which is also used in this procedure. Due to the nature of the restore process for the self-hosted engine, before the final synchronization of the restored engine can take place, this failover host will need to be removed, and this can only be achieved if the host had no virtual load when the backup was taken. You can also restore the backup on a separate hardware which was not used in the backed up environment and this is not a concern.

Important

This procedure assumes that you have a freshly installed Red Hat Enterprise Linux system on a physical host, have subscribed the host to the required entitlements, and installed the ovirt-hosted-engine-setup package. See Subscribing to the Required Entitlements in the Installation Guide and Section 2.1.1, “Installing the Self-Hosted Engine Packages” for more information.

Procedure 6.4. Creating a New Self-Hosted Environment to be Used as the Restored Environment

  1. Updating DNS

    Update your DNS so that the fully qualified domain name of the Red Hat Virtualization environment correlates to the IP address of the new Manager. In this procedure, fully qualified domain name was set as Manager.example.com. The fully qualified domain name provided for the engine must be identical to that given in the engine setup of the original engine that was backed up.

  2. Initiating Hosted Engine Deployment

    On the newly installed Red Hat Enterprise Linux host, run the hosted-engine deployment script. To escape the script at any time, use the CTRL+D keyboard combination to abort deployment. If running the hosted-engine deployment script over a network, it is recommended to use the screen window manager to avoid losing the session in case of network or terminal disruption. Install the screen package first if not installed. 
    # screen
    Copy to Clipboard Toggle word wrap 
    # hosted-engine --deploy
    Copy to Clipboard Toggle word wrap

  3. Preparing for Initialization

    The script begins by requesting confirmation to use the host as a hypervisor for use in a self-hosted engine environment. 
    Continuing will configure this host for serving as hypervisor and create a VM where you have to install oVirt Engine afterwards. 
Are you sure you want to continue? (Yes, No)[Yes]:
    Copy to Clipboard Toggle word wrap

  4. Configuring Storage

    Select the type of storage to use. 
    During customization use CTRL-D to abort.
Please specify the storage you would like to use (glusterfs, iscsi, fc, nfs3, nfs4)[nfs3]:
    Copy to Clipboard Toggle word wrap
    • For NFS storage types, specify the full address, using either the FQDN or IP address, and path name of the shared storage domain. 
      Please specify the full shared storage connection path to use (example: host:/path): storage.example.com:/hosted_engine/nfs
      Copy to Clipboard Toggle word wrap
    • For iSCSI, specify the iSCSI portal IP address, port, user name and password, and select a target name from the auto-detected list. You can only select one iSCSI target during the deployment. 
      Please specify the iSCSI portal IP address:           
Please specify the iSCSI portal port [3260]:           
Please specify the iSCSI portal user:           
Please specify the iSCSI portal password:
Please specify the target name (auto-detected values) [default]:
      Copy to Clipboard Toggle word wrap
    • For Gluster storage, specify the full address, using either the FQDN or IP address, and path name of the shared storage domain.

      Important

      Only replica 3 Gluster storage is supported. Ensure the following configuration has been made:
      • In the /etc/glusterfs/glusterd.vol file on all three Gluster servers, set rpc-auth-allow-insecure to on. 
        option rpc-auth-allow-insecure on
        Copy to Clipboard Toggle word wrap
      • Configure the volume as follows: 
        gluster volume set volume cluster.quorum-type auto
gluster volume set volume network.ping-timeout 10
gluster volume set volume auth.allow \*
gluster volume set volume group virt
gluster volume set volume storage.owner-uid 36
gluster volume set volume storage.owner-gid 36
gluster volume set volume server.allow-insecure on
        Copy to Clipboard Toggle word wrap 
      Please specify the full shared storage connection path to use (example: host:/path): storage.example.com:/hosted_engine/gluster_volume
      Copy to Clipboard Toggle word wrap
    • For Fibre Channel, the host bus adapters must be configured and connected, and the hosted-engine script will auto-detect the LUNs available. The LUNs must not contain any existing data. 
      The following luns have been found on the requested target:
[1]     3514f0c5447600351       30GiB   XtremIO XtremApp
                        status: used, paths: 2 active
          
[2]     3514f0c5447600352       30GiB   XtremIO XtremApp
                        status: used, paths: 2 active

Please select the destination LUN (1, 2) [1]:
      Copy to Clipboard Toggle word wrap

  5. Configuring the Network

    The script detects possible network interface controllers (NICs) to use as a management bridge for the environment. It then checks your firewall configuration and offers to modify it for console (SPICE or VNC) access the Manager virtual machine. Provide a pingable gateway IP address, to be used by the ovirt-ha-agent, to help determine a host's suitability for running a Manager virtual machine. 
    Please indicate a nic to set ovirtmgmt bridge on: (eth1, eth0) [eth1]:
iptables was detected on your computer, do you wish setup to configure it? (Yes, No)[Yes]: 
Please indicate a pingable gateway IP address [X.X.X.X]:
    Copy to Clipboard Toggle word wrap

  6. Configuring the New Manager Virtual Machine

    The script creates a virtual machine to be configured as the new Manager virtual machine. Specify the boot device and, if applicable, the path name of the installation media, the image alias, the CPU type, the number of virtual CPUs, and the disk size. Specify a MAC address for the Manager virtual machine, or accept a randomly generated one. The MAC address can be used to update your DHCP server prior to installing the operating system on the Manager virtual machine. Specify memory size and console connection type for the creation of Manager virtual machine. 
    Please specify the device to boot the VM from (cdrom, disk, pxe) [cdrom]: 
Please specify an alias for the Hosted Engine image [hosted_engine]:  
The following CPU types are supported by this host:
          - model_Penryn: Intel Penryn Family
          - model_Conroe: Intel Conroe Family
Please specify the CPU type to be used by the VM [model_Penryn]: 
Please specify the number of virtual CPUs for the VM [Defaults to minimum requirement: 2]: 
Please specify the disk size of the VM in GB [Defaults to minimum requirement: 25]: 
You may specify a MAC address for the VM or accept a randomly generated default [00:16:3e:77:b2:a4]: 
Please specify the memory size of the VM in MB [Defaults to minimum requirement: 4096]: 
Please specify the console type you want to use to connect to the VM (vnc, spice) [vnc]:
    Copy to Clipboard Toggle word wrap

  7. Identifying the Name of the Host

    Specify the password for the admin@internal user to access the Administration Portal.
    A unique name must be provided for the name of the host, to ensure that it does not conflict with other resources that will be present when the engine has been restored from the backup. The name hosted_engine_1 can be used in this procedure because this host was placed into maintenance mode before the environment was backed up, enabling removal of this host between the restoring of the engine and the final synchronization of the host and the engine. 
    Enter engine admin password: 
Confirm engine admin password:
Enter the name which will be used to identify this host inside the Administration Portal [hosted_engine_1]:
    Copy to Clipboard Toggle word wrap

  8. Configuring the Hosted Engine

    Provide the fully qualified domain name for the new Manager virtual machine. This procedure uses the fully qualified domain name Manager.example.com. Provide the name and TCP port number of the SMTP server, the email address used to send email notifications, and a comma-separated list of email addresses to receive these notifications.

    Important

    The fully qualified domain name provided for the engine (Manager.example.com) must be the same fully qualified domain name provided when original Manager was initially set up. 
    Please provide the FQDN for the engine you would like to use.
This needs to match the FQDN that you will use for the engine installation within the VM.
 Note: This will be the FQDN of the VM you are now going to create,
 it should not point to the base host or to any other existing machine.
 Engine FQDN: Manager.example.com
Please provide the name of the SMTP server through which we will send notifications [localhost]: 
Please provide the TCP port number of the SMTP server [25]: 
Please provide the email address from which notifications will be sent [root@localhost]: 
Please provide a comma-separated list of email addresses which will get notifications [root@localhost]:
    Copy to Clipboard Toggle word wrap

  9. Configuration Preview

    Before proceeding, the hosted-engine deployment script displays the configuration values you have entered, and prompts for confirmation to proceed with these values. 
    Bridge interface                   : eth1
Engine FQDN                        : Manager.example.com
Bridge name                        : ovirtmgmt
SSH daemon port                    : 22
Firewall manager                   : iptables
Gateway address                    : X.X.X.X
Host name for web application      : hosted_engine_1
Host ID                            : 1
Image alias                        : hosted_engine
Image size GB                      : 25
Storage connection                 : storage.example.com:/hosted_engine/nfs
Console type                       : vnc
Memory size MB                     : 4096
MAC address                        : 00:16:3e:77:b2:a4
Boot type                          : pxe
Number of CPUs                     : 2
CPU Type                           : model_Penryn

Please confirm installation settings (Yes, No)[Yes]:
    Copy to Clipboard Toggle word wrap

  10. Creating the New Manager Virtual Machine

    The script creates the virtual machine to be configured as the Manager virtual machine and provides connection details. You must install an operating system on it before the hosted-engine deployment script can proceed on Hosted Engine configuration. 
    [ INFO  ] Stage: Transaction setup
[ INFO  ] Stage: Misc configuration
[ INFO  ] Stage: Package installation
[ INFO  ] Stage: Misc configuration
[ INFO  ] Configuring libvirt
[ INFO  ] Configuring VDSM
[ INFO  ] Starting vdsmd
[ INFO  ] Waiting for VDSM hardware info
[ INFO  ] Waiting for VDSM hardware info
[ INFO  ] Configuring the management bridge
[ INFO  ] Creating Storage Domain
[ INFO  ] Creating Storage Pool
[ INFO  ] Connecting Storage Pool
[ INFO  ] Verifying sanlock lockspace initialization
[ INFO  ] Creating VM Image
[ INFO  ] Disconnecting Storage Pool
[ INFO  ] Start monitoring domain
[ INFO  ] Configuring VM
[ INFO  ] Updating hosted-engine configuration
[ INFO  ] Stage: Transaction commit
[ INFO  ] Stage: Closing up
[ INFO  ] Creating VM
You can now connect to the VM with the following command:
      /usr/bin/remote-viewer vnc://localhost:5900
Use temporary password "3477XXAM" to connect to vnc console.
Please note that in order to use remote-viewer you need to be able to run graphical applications.
This means that if you are using ssh you have to supply the -Y flag (enables trusted X11 forwarding).
Otherwise you can run the command from a terminal in your preferred desktop environment.
If you cannot run graphical applications you can connect to the graphic console from another host or connect to the console using the following command:
virsh -c qemu+tls://Test/system console HostedEngine
If you need to reboot the VM you will need to start it manually using the command:
hosted-engine --vm-start
You can then set a temporary password using the command:
hosted-engine --add-console-password
The VM has been started.  Install the OS and shut down or reboot it.  To continue please make a selection:
         
  (1) Continue setup - VM installation is complete
  (2) Reboot the VM and restart installation
  (3) Abort setup
  (4) Destroy VM and abort setup
         
  (1, 2, 3, 4)[1]:
    Copy to Clipboard Toggle word wrap
    Using the naming convention of this procedure, connect to the virtual machine using VNC with the following command: 
    /usr/bin/remote-viewer vnc://hosted_engine_1.example.com:5900
    Copy to Clipboard Toggle word wrap

  11. Installing the Virtual Machine Operating System

    Connect to Manager virtual machine and install a Red Hat Enterprise Linux 7 operating system.

  12. Synchronizing the Host and the Manager

    Return to the host and continue the hosted-engine deployment script by selecting option 1: 
    (1) Continue setup - VM installation is complete
    Copy to Clipboard Toggle word wrap 
    Waiting for VM to shut down...
[ INFO  ] Creating VM
You can now connect to the VM with the following command:
      /usr/bin/remote-viewer vnc://localhost:5900
Use temporary password "3477XXAM" to connect to vnc console.
Please note that in order to use remote-viewer you need to be able to run graphical applications.
This means that if you are using ssh you have to supply the -Y flag (enables trusted X11 forwarding).
Otherwise you can run the command from a terminal in your preferred desktop environment.
If you cannot run graphical applications you can connect to the graphic console from another host or connect to the console using the following command:
virsh -c qemu+tls://Test/system console HostedEngine
If you need to reboot the VM you will need to start it manually using the command:
hosted-engine --vm-start
You can then set a temporary password using the command:
hosted-engine --add-console-password
Please install and setup the engine in the VM.
You may also be interested in subscribing to "agent" RHN/Satellite channel and installing rhevm-guest-agent-common package in the VM.
To continue make a selection from the options below:
  (1) Continue setup - engine installation is complete
  (2) Power off and restart the VM
  (3) Abort setup
  (4) Destroy VM and abort setup
         
  (1, 2, 3, 4)[1]:
    Copy to Clipboard Toggle word wrap

  13. Installing the Manager

    Connect to the new Manager virtual machine, register it with Red Hat Subscription Management, and enable the required repositories. See Subscribing to the Required Entitlements in the Installation Guide.
    Ensure the latest versions of all installed packages are in use, and install the rhevm packages. 
    # yum update
    Copy to Clipboard Toggle word wrap

    Note

    Reboot the machine if any kernel related packages have been updated. 
    # yum install rhevm
    Copy to Clipboard Toggle word wrap
After the packages have completed installation, you will be able to continue with restoring the self-hosted engine Manager.

6.2.2. Restoring the Self-Hosted Engine Manager
Copy link

The following procedure outlines how to use the engine-backup tool to automate the restore of the configuration settings and database content for a backed-up self-hosted engine Manager virtual machine and Data Warehouse. The procedure only applies to components that were configured automatically during the initial engine-setup. If you configured the database(s) manually during engine-setup, follow the instructions at Section 6.2.3, “Restoring the Self-Hosted Engine Manager Manually” to restore the back-up environment manually.

Procedure 6.5. Restoring the Self-Hosted Engine Manager

  1. Secure copy the backup files to the new Manager virtual machine. This example copies the files from a network storage server to which the files were copied in Section 6.1, “Backing up the Self-Hosted Engine Manager Virtual Machine”. In this example, Storage.example.com is the fully qualified domain name of the storage server, /backup/EngineBackupFiles is the designated file path for the backup files on the storage server, and /backup/ is the path to which the files will be copied on the new Manager. 
    # scp -p Storage.example.com:/backup/EngineBackupFiles /backup/
    Copy to Clipboard Toggle word wrap
  2. Use the engine-backup tool to restore a complete backup.
    • If you are only restoring the Manager, run: 
      # engine-backup --mode=restore --file=file_name --log=log_file_name --provision-db --restore-permissions
      Copy to Clipboard Toggle word wrap
    • If you are restoring the Manager and Data Warehouse, run: 
      # engine-backup --mode=restore --file=file_name --log=log_file_name --provision-db --provision-dwh-db --restore-permissions
      Copy to Clipboard Toggle word wrap
    If successful, the following output displays: 
    You should now run engine-setup.
Done.
    Copy to Clipboard Toggle word wrap
  3. Configure the restored Manager virtual machine. This process identifies the existing configuration settings and database content. Confirm the settings. Upon completion, the setup provides an SSH fingerprint and an internal Certificate Authority hash. 
    # engine-setup
    Copy to Clipboard Toggle word wrap 
    [ INFO  ] Stage: Initializing
[ INFO  ] Stage: Environment setup
Configuration files: ['/etc/ovirt-engine-setup.conf.d/10-packaging.conf', '/etc/ovirt-engine-setup.conf.d/20-setup-ovirt-post.conf']
Log file: /var/log/ovirt-engine/setup/ovirt-engine-setup-20140304075238.log
Version: otopi-1.1.2 (otopi-1.1.2-1.el6ev)
[ INFO  ] Stage: Environment packages setup
[ INFO  ] Yum Downloading: rhel-65-zstream/primary_db 2.8 M(70%)
[ INFO  ] Stage: Programs detection
[ INFO  ] Stage: Environment setup
[ INFO  ] Stage: Environment customization
         
          --== PACKAGES ==--
         
[ INFO  ] Checking for product updates...
[ INFO  ] No product updates found
         
          --== NETWORK CONFIGURATION ==--
         
Setup can automatically configure the firewall on this system.
Note: automatic configuration of the firewall may overwrite current settings.
Do you want Setup to configure the firewall? (Yes, No) [Yes]: 
[ INFO  ] iptables will be configured as firewall manager.
         
          --== DATABASE CONFIGURATION ==--
         
         
          --== OVIRT ENGINE CONFIGURATION ==--
         
          Skipping storing options as database already prepared
         
          --== PKI CONFIGURATION ==--
         
          PKI is already configured
         
          --== APACHE CONFIGURATION ==--
         
         
          --== SYSTEM CONFIGURATION ==--
         
         
          --== END OF CONFIGURATION ==--
         
[ INFO  ] Stage: Setup validation
[ INFO  ] Cleaning stale zombie tasks
         
          --== CONFIGURATION PREVIEW ==--
         
          Database name                      : engine
          Database secured connection        : False
          Database host                      : X.X.X.X
          Database user name                 : engine
          Database host name validation      : False
          Database port                      : 5432
          NFS setup                          : True
          Firewall manager                   : iptables
          Update Firewall                    : True
          Configure WebSocket Proxy          : True
          Host FQDN                          : Manager.example.com
          NFS mount point                    : /var/lib/exports/iso
          Set application as default page    : True
          Configure Apache SSL               : True
         
          Please confirm installation settings (OK, Cancel) [OK]:
    Copy to Clipboard Toggle word wrap

  4. Removing the Host from the Restored Environment

    If the deployment of the restored self-hosted engine is on new hardware that has a unique name not present in the backed-up engine, skip this step. This step is only applicable to deployments occurring on the failover host, hosted_engine_1. Because this host was present in the environment at time the backup was created, it maintains a presence in the restored engine and must first be removed from the environment before final synchronization can take place.
    1. Log in to the Administration Portal.
    2. Click the Hosts tab. The failover host, hosted_engine_1, will be in maintenance mode and without a virtual load, as this was how it was prepared for the backup.
    3. Click Remove.
    4. Click Ok.

    Note

    If the host you are trying to remove becomes non-operational, see Section 6.2.4, “Removing Non-Operational Hosts from a Restored Self-Hosted Engine Environment” for instructions on how to force the removal of a host.

  5. Synchronizing the Host and the Manager

    Return to the host and continue the hosted-engine deployment script by selecting option 1: 
    (1) Continue setup - engine installation is complete
    Copy to Clipboard Toggle word wrap 
    [ INFO  ] Engine replied: DB Up!Welcome to Health Status!
[ INFO  ] Waiting for the host to become operational in the engine. This may take several minutes...
[ INFO  ] Still waiting for VDSM host to become operational...
    Copy to Clipboard Toggle word wrap
    At this point, hosted_engine_1 will become visible in the Administration Portal with Installing and Initializing states before entering a Non Operational state. The host will continue to wait for the VDSM host to become operational until it eventually times out. This happens because another host in the environment maintains the Storage Pool Manager (SPM) role and hosted_engine_1 cannot interact with the storage domain because the SPM host is in a Non Responsive state. When this process times out, you are prompted to shut down the virtual machine to complete the deployment. When deployment is complete, the host can be manually placed into maintenance mode and activated through the Administration Portal. 
    [ INFO  ] Still waiting for VDSM host to become operational...
[ ERROR ] Timed out while waiting for host to start. Please check the logs.
[ ERROR ] Unable to add hosted_engine_2 to the manager
          Please shutdown the VM allowing the system to launch it as a monitored service.
          The system will wait until the VM is down.
    Copy to Clipboard Toggle word wrap
  6. Shut down the new Manager virtual machine. 
    # shutdown -h now
    Copy to Clipboard Toggle word wrap
  7. Return to the host to confirm it has detected that the Manager virtual machine is down. 
    [ INFO  ] Enabling and starting HA services
          Hosted Engine successfully set up
[ INFO  ] Stage: Clean up
[ INFO  ] Stage: Pre-termination
[ INFO  ] Stage: Termination
    Copy to Clipboard Toggle word wrap
  8. Activate the host.
    1. Log in to the Administration Portal.
    2. Click the Hosts tab.
    3. Select hosted_engine_1 and click Management → Maintenance. The host may take several minutes before it enters maintenance mode.
    4. Click Management → Activate.
    Once active, hosted_engine_1 immediately contends for SPM, and the storage domain and data center become active.
  9. Migrate virtual machines to the active host by manually fencing the Non Responsive hosts. In the Administration Portal, right-click the hosts and select Confirm 'Host has been Rebooted'.
    Any virtual machines that were running on that host at the time of the backup will now be removed from that host, and move from an Unknown state to a Down state. These virtual machines can now be run on hosted_engine_1. The host that was fenced can now be forcefully removed using the REST API.
The environment has now been restored to a point where hosted_engine_1 is active and is able to run virtual machines in the restored environment. The remaining self-hosted engine nodes in Non Operational state can now be removed by following the steps in Section 6.2.4, “Removing Non-Operational Hosts from a Restored Self-Hosted Engine Environment” and then re-installed into the environment by following the steps in Chapter 7, Installing Additional Hosts to a Self-Hosted Environment.

Note

If the Manager database is restored successfully, but the Manager virtual machine appears to be Down and cannot be migrated to another self-hosted engine node, you can enable a new Manager virtual machine and remove the dead Manager virtual machine from the environment by following the steps provided in https://access.redhat.com/solutions/1517683.
The following procedure outlines how to manually restore the configuration settings and database content for a backed-up self-hosted engine Manager virtual machine.

Procedure 6.6. Restoring the Self-Hosted Engine Manager

  1. Manually create an empty database to which the database content in the backup can be restored. The following steps must be performed on the machine where the database is to be hosted.
    1. If the database is to be hosted on a machine other than the Manager virtual machine, install the postgresql-server package. This step is not required if the database is to be hosted on the Manager virtual machine because this package is included with the rhevm package. 
      # yum install postgresql-server
      Copy to Clipboard Toggle word wrap
    2. Initialize the postgresql database, start the postgresql service, and ensure this service starts on boot: 
      # postgresql-setup initdb
# systemctl start postgresql.service
# systemctl enable postgresql.service
      Copy to Clipboard Toggle word wrap
    3. Enter the postgresql command line: 
      # su postgres
$ psql
      Copy to Clipboard Toggle word wrap
    4. Create the engine user: 
      postgres=# create role engine with login encrypted password 'password';
      Copy to Clipboard Toggle word wrap
      If you are also restoring Data Warehouse, create the ovirt_engine_history user on the relevant host: 
      postgres=# create role ovirt_engine_history with login encrypted password 'password';
      Copy to Clipboard Toggle word wrap
    5. Create the new database: 
      postgres=# create database database_name owner engine template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
      Copy to Clipboard Toggle word wrap
      If you are also restoring the Data Warehouse, create the database on the relevant host: 
      postgres=# create database database_name owner ovirt_engine_history template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
      Copy to Clipboard Toggle word wrap
    6. Exit the postgresql command line and log out of the postgres user: 
      postgres=# \q
$ exit
      Copy to Clipboard Toggle word wrap
    7. Edit the /var/lib/pgsql/data/pg_hba.conf file as follows:
      • For each local database, 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
        Copy to Clipboard Toggle word wrap
      • For each remote database:
        • 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
          Copy to Clipboard Toggle word wrap
        • Allow TCP/IP connections to the database. Edit the /var/lib/pgsql/data/postgresql.conf file and add the following line: 
          listen_addresses='*'
          Copy to Clipboard Toggle word wrap
          This example configures the postgresql service to listen for connections on all interfaces. You can specify an interface by giving its IP address.
        • Open the default port used for PostgreSQL database connections, and save the updated firewall rules: 
          # iptables -I INPUT 5 -p tcp -s Manager_IP_Address --dport 5432 -j ACCEPT
# service iptables save
          Copy to Clipboard Toggle word wrap
    8. Restart the postgresql service: 
      # systemctl restart postgresql.service
      Copy to Clipboard Toggle word wrap
  2. Secure copy the backup files to the new Manager virtual machine. This example copies the files from a network storage server to which the files were copied in Section 6.1, “Backing up the Self-Hosted Engine Manager Virtual Machine”. In this example, Storage.example.com is the fully qualified domain name of the storage server, /backup/EngineBackupFiles is the designated file path for the backup files on the storage server, and /backup/ is the path to which the files will be copied on the new Manager. 
    # scp -p Storage.example.com:/backup/EngineBackupFiles /backup/
    Copy to Clipboard Toggle word wrap
  3. Restore a complete backup or a database-only backup with the --change-db-credentials parameter to pass the credentials of the new database. The database_location for a database local to the Manager is localhost.

    Note

    The following examples use a --*password option for each database without specifying a password, which will prompt for a password for each database. Passwords can be supplied for these options in the command itself, however this is not recommended as the password will then be stored in the shell history. Alternatively, --*passfile=password_file options can be used for each database to securely pass the passwords to the engine-backup tool without the need for interactive prompts.
    • Restore a complete backup: 
      # engine-backup --mode=restore --file=file_name --log=log_file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password
      Copy to Clipboard Toggle word wrap
      If Data Warehouse is also being restored as part of the complete backup, include the revised credentials for the additional database: 
      engine-backup --mode=restore --file=file_name --log=log_file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password --change-dwh-db-credentials --dwh-db-host=database_location --dwh-db-name=database_name --dwh-db-user=ovirt_engine_history --dwh-db-password
      Copy to Clipboard Toggle word wrap
    • Restore a database-only backup restoring the configuration files and the database backup: 
      # engine-backup --mode=restore --scope=files --scope=db --file=file_name --log=file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password
      Copy to Clipboard Toggle word wrap
      The example above restores a backup of the Manager database. 
      # engine-backup --mode=restore --scope=files --scope=dwhdb --file=file_name --log=file_name --change-dwh-db-credentials --dwh-db-host=database_location --dwh-db-name=database_name --dwh-db-user=ovirt_engine_history --dwh-db-password
      Copy to Clipboard Toggle word wrap
      The example above restores a backup of the Data Warehouse database.
    If successful, the following output displays: 
    You should now run engine-setup.
Done.
    Copy to Clipboard Toggle word wrap
  4. Configure the restored Manager virtual machine. This process identifies the existing configuration settings and database content. Confirm the settings. Upon completion, the setup provides an SSH fingerprint and an internal Certificate Authority hash. 
    # engine-setup
    Copy to Clipboard Toggle word wrap 
    [ INFO  ] Stage: Initializing
[ INFO  ] Stage: Environment setup
Configuration files: ['/etc/ovirt-engine-setup.conf.d/10-packaging.conf', '/etc/ovirt-engine-setup.conf.d/20-setup-ovirt-post.conf']
Log file: /var/log/ovirt-engine/setup/ovirt-engine-setup-20140304075238.log
Version: otopi-1.1.2 (otopi-1.1.2-1.el6ev)
[ INFO  ] Stage: Environment packages setup
[ INFO  ] Yum Downloading: rhel-65-zstream/primary_db 2.8 M(70%)
[ INFO  ] Stage: Programs detection
[ INFO  ] Stage: Environment setup
[ INFO  ] Stage: Environment customization
         
          --== PACKAGES ==--
         
[ INFO  ] Checking for product updates...
[ INFO  ] No product updates found
         
          --== NETWORK CONFIGURATION ==--
         
Setup can automatically configure the firewall on this system.
Note: automatic configuration of the firewall may overwrite current settings.
Do you want Setup to configure the firewall? (Yes, No) [Yes]: 
[ INFO  ] iptables will be configured as firewall manager.
         
          --== DATABASE CONFIGURATION ==--
         
         
          --== OVIRT ENGINE CONFIGURATION ==--
         
          Skipping storing options as database already prepared
         
          --== PKI CONFIGURATION ==--
         
          PKI is already configured
         
          --== APACHE CONFIGURATION ==--
         
         
          --== SYSTEM CONFIGURATION ==--
         
         
          --== END OF CONFIGURATION ==--
         
[ INFO  ] Stage: Setup validation
[ INFO  ] Cleaning stale zombie tasks
         
          --== CONFIGURATION PREVIEW ==--
         
          Database name                      : engine
          Database secured connection        : False
          Database host                      : X.X.X.X
          Database user name                 : engine
          Database host name validation      : False
          Database port                      : 5432
          NFS setup                          : True
          Firewall manager                   : iptables
          Update Firewall                    : True
          Configure WebSocket Proxy          : True
          Host FQDN                          : Manager.example.com
          NFS mount point                    : /var/lib/exports/iso
          Set application as default page    : True
          Configure Apache SSL               : True
         
          Please confirm installation settings (OK, Cancel) [OK]:
    Copy to Clipboard Toggle word wrap

  5. Removing the Host from the Restored Environment

    If the deployment of the restored self-hosted engine is on new hardware that has a unique name not present in the backed-up engine, skip this step. This step is only applicable to deployments occurring on the failover host, hosted_engine_1. Because this host was present in the environment at time the backup was created, it maintains a presence in the restored engine and must first be removed from the environment before final synchronization can take place.
    1. Log in to the Administration Portal.
    2. Click the Hosts tab. The failover host, hosted_engine_1, will be in maintenance mode and without a virtual load, as this was how it was prepared for the backup.
    3. Click Remove.
    4. Click Ok.

  6. Synchronizing the Host and the Manager

    Return to the host and continue the hosted-engine deployment script by selecting option 1: 
    (1) Continue setup - engine installation is complete
    Copy to Clipboard Toggle word wrap 
    [ INFO  ] Engine replied: DB Up!Welcome to Health Status!
[ INFO  ] Waiting for the host to become operational in the engine. This may take several minutes...
[ INFO  ] Still waiting for VDSM host to become operational...
    Copy to Clipboard Toggle word wrap
    At this point, hosted_engine_1 will become visible in the Administration Portal with Installing and Initializing states before entering a Non Operational state. The host will continue to wait for the VDSM host to become operational until it eventually times out. This happens because another host in the environment maintains the Storage Pool Manager (SPM) role and hosted_engine_1 cannot interact with the storage domain because the SPM host is in a Non Responsive state. When this process times out, you are prompted to shut down the virtual machine to complete the deployment. When deployment is complete, the host can be manually placed into maintenance mode and activated through the Administration Portal. 
    [ INFO  ] Still waiting for VDSM host to become operational...
[ ERROR ] Timed out while waiting for host to start. Please check the logs.
[ ERROR ] Unable to add hosted_engine_2 to the manager
          Please shutdown the VM allowing the system to launch it as a monitored service.
          The system will wait until the VM is down.
    Copy to Clipboard Toggle word wrap
  7. Shut down the new Manager virtual machine. 
    # shutdown -h now
    Copy to Clipboard Toggle word wrap
  8. Return to the host to confirm it has detected that the Manager virtual machine is down. 
    [ INFO  ] Enabling and starting HA services
          Hosted Engine successfully set up
[ INFO  ] Stage: Clean up
[ INFO  ] Stage: Pre-termination
[ INFO  ] Stage: Termination
    Copy to Clipboard Toggle word wrap
  9. Activate the host.
    1. Log in to the Administration Portal.
    2. Click the Hosts tab.
    3. Select hosted_engine_1 and click Management → Maintenance. The host may take several minutes before it enters maintenance mode.
    4. Click Management → Activate.
    Once active, hosted_engine_1 immediately contends for SPM, and the storage domain and data center become active.
  10. Migrate virtual machines to the active host by manually fencing the Non Responsive hosts. In the Administration Portal, right-click the hosts and select Confirm 'Host has been Rebooted'.
    Any virtual machines that were running on that host at the time of the backup will now be removed from that host, and move from an Unknown state to a Down state. These virtual machines can now be run on hosted_engine_1. The host that was fenced can now be forcefully removed using the REST API.
The environment has now been restored to a point where hosted_engine_1 is active and is able to run virtual machines in the restored environment. The remaining self-hosted engine nodes in Non Operational state can now be removed by following the steps in Section 6.2.4, “Removing Non-Operational Hosts from a Restored Self-Hosted Engine Environment” and then re-installed into the environment by following the steps in Chapter 7, Installing Additional Hosts to a Self-Hosted Environment.

Note

If the Manager database is restored successfully, but the Manager virtual machine appears to be Down and cannot be migrated to another self-hosted engine node, you can enable a new Manager virtual machine and remove the dead Manager virtual machine from the environment by following the steps provided in https://access.redhat.com/solutions/1517683.
Once a host has been fenced in the Administration Portal, it can be forcefully removed with a REST API request. This procedure will use cURL, a command line interface for sending requests to HTTP servers. Most Linux distributions include cURL. This procedure will connect to the Manager virtual machine to perform the relevant requests.

  1. Fencing the Non-Operational Host

    In the Administration Portal, right-click the hosts and select Confirm 'Host has been Rebooted'.
    Any virtual machines that were running on that host at the time of the backup will now be removed from that host, and move from an Unknown state to a Down state. The host that was fenced can now be forcefully removed using the REST API.

  2. Retrieving the Manager Certificate Authority

    Connect to the Manager virtual machine and use the command line to perform the following requests with cURL.
    Use a GET request to retrieve the Manager Certificate Authority (CA) certificate for use in all future API requests. In the following example, the --output option is used to designate the file hosted-engine.ca as the output for the Manager CA certificate. The --insecure option means that this initial request will be without a certificate. 
    # curl --output hosted-engine.ca --insecure https://[Manager.example.com]/ca.crt
    Copy to Clipboard Toggle word wrap

  3. Retrieving the GUID of the Host to be Removed

    Use a GET request on the hosts collection to retrieve the Global Unique Identifier (GUID) for the host to be removed. The following example includes the Manager CA certificate file, and uses the admin@internal user for authentication, the password for which will be prompted once the command is executed. 
    # curl --request GET --cacert hosted-engine.ca --user admin@internal https://[Manager.example.com]/api/hosts
    Copy to Clipboard Toggle word wrap
    This request returns the details of all of the hosts in the environment. The host GUID is a hexadecimal string associated with the host name. For more information on the Red Hat Virtualization REST API, see the Red Hat Virtualization REST API Guide.

  4. Removing the Fenced Host

    Use a DELETE request using the GUID of the fenced host to remove the host from the environment. In addition to the previously used options this example specifies headers to specify that the request is to be sent and returned using eXtensible Markup Language (XML), and the body in XML that sets the force action to be true. 
    curl --request DELETE --cacert hosted-engine.ca --user admin@internal --header "Content-Type: application/xml" --header "Accept: application/xml" --data "<action><force>true</force></action>" https://[Manager.example.com]/api/hosts/ecde42b0-de2f-48fe-aa23-1ebd5196b4a5
    Copy to Clipboard Toggle word wrap
    This DELETE request can be used to remove every fenced host in the self-hosted engine environment, as long as the appropriate GUID is specified.

  5. Removing the Self-Hosted Engine Configuration from the Host

    Remove the host's self-hosted engine configuration so it can be reconfigured when the host is re-installed to a self-hosted engine environment.
    Log in to the host and remove the configuration file: 
    # rm /etc/ovirt-hosted-engine/hosted-engine.conf
    Copy to Clipboard Toggle word wrap
The host can now be re-installed to the self-hosted engine environment.
Additional self-hosted engine nodes are added in the same way as a regular host, with an additional step to deploy the host as a self-hosted engine node. The shared storage domain is automatically detected and the node can be used as a failover host to host the Manager virtual machine when required. You can also attach regular hosts to a self-hosted engine environment, but they cannot host the Manager virtual machine. Red Hat highly recommends having at least two self-hosted engine nodes to ensure the Manager virtual machine is highly available. Additional hosts can also be added using the REST API. See Hosts in the REST API Guide.

Prerequisites

Procedure 7.1. Adding an Additional Self-Hosted Engine Node

  1. In the Administration Portal, click the Hosts resource tab.
  2. Click New.
    For information on additional host settings, see Explanation of Settings and Controls in the New Host and Edit Host Windows in the Administration Guide.
  3. Use the drop-down list to select the Data Center and Host Cluster for the new host.
  4. Enter the Name and the Address of the new host. The standard SSH port, port 22, is auto-filled in the SSH Port field.
  5. Select an authentication method to use for the Manager to access the host.
    • Enter the root user's password to use password authentication.
    • Alternatively, copy the key displayed in the SSH PublicKey field to /root/.ssh/authorized_keys on the host to use public key authentication.
  6. Optionally, configure power management, where the host has a supported power management card. For information on power management configuration, see Host Power Management Settings Explained in the Administration Guide.
  7. Click the Hosted Engine sub-tab.
  8. Select the Deploy radio button.
  9. Click OK.
You can migrate the engine database of a self-hosted engine to a remote database server after the Red Hat Virtualization Manager has been initially configured. Use engine-backup to create a database backup and restore it on the new database server. This procedure assumes that the new database server has Red Hat Enterprise Linux 7 installed and the appropriate subscriptions configured. See Subscribing to the Required Entitlements in the Installation Guide.
To migrate Data Warehouse to a separate machine, see Migrating Data Warehouse to a Separate Machine in the Data Warehouse Guide.

Procedure 8.1. Migrating the Database

  1. Log in to a self-hosted engine node and place the environment into global maintenance mode. This disables the High Availability agents and prevents the Manager virtual machine from being migrated during the procedure: 
    # hosted-engine --set-maintenance --mode=global
    Copy to Clipboard Toggle word wrap
  2. Log in to the Red Hat Virtualization Manager machine and stop the ovirt-engine service so that it does not interfere with the engine backup: 
    # systemctl stop ovirt-engine.service
    Copy to Clipboard Toggle word wrap
  3. Create the engine database backup: 
    # engine-backup --scope=files --scope=db --mode=backup --file=file_name --log=backup_log_name
    Copy to Clipboard Toggle word wrap
  4. Copy the backup file to the new database server: 
    # scp /tmp/engine.dump root@new.database.server.com:/tmp
    Copy to Clipboard Toggle word wrap
  5. Log in to the new database server and install engine-backup: 
    # yum install ovirt-engine-tools-backup
    Copy to Clipboard Toggle word wrap
  6. Restore the database on the new database server. file_name is the backup file copied from the Manager. 
    # engine-backup --mode=restore --scope=files --scope=db --file=file_name --log=restore_log_name --provision-db --no-restore-permissions
    Copy to Clipboard Toggle word wrap
  7. Now that the database has been migrated, start the ovirt-engine service: 
    # systemctl start ovirt-engine.service
    Copy to Clipboard Toggle word wrap
  8. Log in to a self-hosted engine node and turn off maintenance mode, enabling the High Availability agents: 
    # hosted-engine --set-maintenance --mode=none
    Copy to Clipboard Toggle word wrap

Legal Notice
Copy link

Copyright © 2016 Red Hat.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat