Versions: Euwe / Fine / Latest /

1. Installing ManageIQ

Installing ManageIQ consists of the following steps:

  1. Downloading the appliance for your environment as a virtual machine image template.

  2. Setting up a virtual machine based on the appliance.

  3. Configuring the ManageIQ appliance.

After you have completed all the procedures in this guide, you will have a working environment on which additional customizations and configurations can be performed.

1.1. Obtaining the appliance

The following procedure outlines how to obtain a copy of the appliance from the ManageIQ homepage.

  1. In a browser, navigate to manageiq.org/download.

  2. Select Red Hat Virtualization from the --Choose your platform-- list.

  3. Select Stable from the --Choose a release-- list.

  4. Follow the instructions to download the appliance.

1.2. Uploading the Appliance on Red Hat Virtualization

The method for uploading the ManageIQ appliance differs depending on the Red Hat Virtualization version you are using.

In Red Hat Virtualization 4.0 and newer, upload the QCOW2 appliance image using the Red Hat Virtualization Administration Portal.

In Red Hat Enterprise Virtualization 3.6 and earlier, upload the OVA appliance image using the image uploader tool. You can also use this method for Red Hat Virtualization 4.0 systems.

Uploading the ManageIQ appliance file to Red Hat Virtualization requires:

  • 44 GB of storage space on both the export domain and the local partition where /tmp resides, as the OVF archive is locally expanded into that directory.

  • 12 GB RAM.

  • 4 vCPUs.

1.2.1. Uploading the Appliance Using the Administration Portal

In Red Hat Virtualization 4.0 and newer, upload the QCOW2 appliance image using the Red Hat Virtualization Administration Portal. After uploading the image, create a disk and attach it to a virtual machine.

Prerequisites:
  • You must configure the Image I/O Proxy when running engine-setup. See Configuring the Red Hat Virtualization Manager in the Red Hat Virtualization Installation Guide for more information.

  • Internet Explorer 10, Firefox 35, or Chrome 13 or greater is required to perform this upload procedure. Previous browser versions do not support the required HTML5 APIs.

  • You must import the required certificate authority into the web browser used to access the Administration Portal.

To import the certificate authority, browse to https://<engine_address>/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA and select all the trust settings. Refer to the instructions to install the certificate authority in Firefox, Internet Explorer, or Google Chrome.

To upload the appliance
  1. Log in to the Administration Portal.

  2. Click the Disks tab.

  3. Select Start from the Upload menu.

  4. Click Browse, and select the image on the local disk.

  5. Set Image Type to QCOW2.

  6. Fill in the Disk Option fields. See Explanation of Settings in the New Virtual Disk Window in the Red Hat Virtualization Administration Guide for a description of the relevant fields.

  7. Click OK.

A progress bar will indicate the status of the upload. You can also pause, cancel, or resume uploads from the Upload menu.

See the Uploading a Disk Image to a Storage Domain in the Red Hat Virtualization Administration Guide for more information.

1.2.2. Uploading the Appliance with the Image Uploader

In Red Hat Enterprise Virtualization 3.6 and earlier, upload the appliance as an OVA image using the image uploader tool. Red Hat Virtualization 4.0 supports this method as well.

Refer to The Image Uploader Tool in the Red Hat Virtualization Administration Guide for more details on using the image uploader.

To install the image uploader, install the rhevm-image-uploader package containing the engine-image-uploader script to your local machine:

# yum install rhevm-image-uploader

Upload the ManageIQ appliance using the image uploader:

  1. Change to the directory containing the ManageIQ appliance.

  2. Run the following command:

    # engine-image-uploader -N `newimagename` -e `myexportdomain` -v -m upload cfme-rhevm-5.3-15.x86_64.rhevm.ova

    Substitute newimagename with your chosen name for the image, and substitute myexportdomain with your chosen export storage domain.

    It is recommended to use -v (verbose logging) when using the engine-image-uploader script to see the progression of the upload.
  3. Enter the password of the default administrative user for your Red Hat Enterprise Virtualization Manager when prompted.

    Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort): **********

    Ensure your Red Hat Enterprise Virtualization Manager has administrator access to the chosen export storage domain.

It takes approximately 90 minutes to upload the ManageIQ appliance file to the Red Hat Enterprise Virtualization Manager. Once the OVA is uploaded and imported as a template, add a network adapter to the template itself.

1.2.3. Uploading the Appliance Manually

The following procedure provides manual upload instructions if the image uploader tool is not available or fails to upload.

  1. Log in to a host in your Red Hat Virtualization system with a mount to the export storage domain.

  2. Change to the export storage domain’s directory.

  3. Copy the ManageIQ appliance OVF archive to this directory.

  4. Run the ls command to locate the directory named after a GUID, and change to that directory.

  5. Extract the OVF file using the tar command, substituting the .ova filename with your download. For example:

    [root@localhost 4a8fc2b1-0a57-47fd-b622-7e170981305b]# tar xvf ../cfme-rhevm-5.9.0.17-1.x86_64.rhevm.ova
    images/
    images/896d49ac-a5e4-4b73-8448-9778bb76ce32/
    images/896d49ac-a5e4-4b73-8448-9778bb76ce32/26e85696-78a4-4a82-aedd-bf60a4aa7dae.meta
    images/896d49ac-a5e4-4b73-8448-9778bb76ce32/26e85696-78a4-4a82-aedd-bf60a4aa7dae
    master/
    master/vms/
    master/vms/647d5765-17fe-436d-aff1-82243e79976a/
    master/vms/647d5765-17fe-436d-aff1-82243e79976a/647d5765-17fe-436d-aff1-82243e79976a.ovf
  6. Change ownership of the images and master export directories so the appliance can be imported as a template:

    [root@localhost 4a8fc2b1-0a57-47fd-b622-7e170981305b]# chown -R 36:36 master/
    [root@localhost 4a8fc2b1-0a57-47fd-b622-7e170981305b]# chown -R 36:36 images/

    The Red Hat Virtualization export domain shows the ManageIQ appliance in the administration portal.

1.3. Running ManageIQ

After uploading the appliance to the export storage domain, import it as a template and create a virtual machine.

  1. Import the appliance image from the export storage domain as a template in a Red Hat Virtualization data storage domain:

    1. Click the Storage tab, then select the export storage domain you uploaded the image to.

    2. From the details pane, click the Template Import tab, and select the image (newimagename) you uploaded.

    3. Click Import, and specify the Cluster and CPU Profile as desired.

    4. Click OK.

      You can check the import status on the Events tab. See Exporting and Importing Virtual Machines and Templates in the Red Hat Virtualization Virtual Machine Management Guide for additional information.

  2. Check if the template has a network interface (NIC). If the template does not include one, create a NIC for it:

    1. From the Templates tab, select the template you imported to view its details.

    2. From the details pane, click the Network Interfaces tab to check if a NIC is listed. If there is an existing NIC, continue to the next step. If no existing NIC is shown:

      1. Create a NIC by clicking New in the Network Interfaces tab.

      2. In the New Network Interface dialog, specify any values as desired or leave the defaults.

      3. Click OK.

        The new NIC shows in the Network Interfaces tab.

  3. Create a new virtual machine using the ManageIQ appliance template as a basis:

    1. From the Templates tab, select the ManageIQ template.

    2. Click New VM to open the New Virtual Machine dialog.

    3. Specify a name for the virtual machine, and any other details as desired.

    4. Click OK.

      The virtual machine is created. To view the virtual machine, select the data center, then the Virtual Machines tab to view a list of all virtual machines.

  4. Add a database disk if you are hosting the database on the same machine as the appliance:

    1. To add a disk, select your virtual machine from the Virtual Machines tab.

    2. From the details pane, click the Disks tab.

    3. Click New to open the New Virtual Disk dialog.

    4. Specify a Size in GB for the disk that allows sufficient space for your database. See "Database Requirements" in the Deployment Planning Guide for size considerations.

    5. Set the Allocation Policy to Preallocated (thick provisioning) for best performance.

    6. Specify any other values as desired.

    7. Click OK to create the disk.

  5. To start the ManageIQ appliance, select the virtual machine from the Virtual Machines tab and click greentriangle (Run).

Your Red Hat Virtualization environment now contains a running ManageIQ appliance.

2. Configuring ManageIQ

After installing ManageIQ and running it for the first time, you must perform some basic configuration. To configure ManageIQ, you must at a minimum:

  1. Add a disk to the infrastructure hosting your appliance.

  2. Configure the database.

Configure the ManageIQ appliance using the internal appliance console.

2.1. Accessing the Appliance Console

  1. Start the appliance and open a terminal console.

  2. After starting the appliance, log in with a user name of root and the default password of smartvm. This displays the Bash prompt for the root user.

  3. Enter the appliance_console command. The ManageIQ appliance summary screen displays.

  4. Press Enter to manually configure settings.

  5. Press the number for the item you want to change, and press Enter. The options for your selection are displayed.

  6. Follow the prompts to make the changes.

  7. Press Enter to accept a setting where applicable.

The ManageIQ appliance console automatically logs out after five minutes of inactivity.

2.2. Configuring a Worker Appliance

You can use multiple appliances to facilitate horizontal scaling, as well as for dividing up work by roles. Accordingly, configure an appliance to handle work for one or many roles, with workers within the appliance carrying out the duties for which they are configured. You can configure a worker appliance through the terminal. The following steps demonstrate how to join a worker appliance to an appliance that already has a region configured with a database.

  1. Start the appliance and open a terminal console.

  2. After starting the appliance, log in with a user name of root and the default password of smartvm. This displays the Bash prompt for the root user.

  3. Enter the appliance_console command. The ManageIQ appliance summary screen displays.

  4. Press Enter to manually configure settings.

  5. Select 5) Configure Database from the menu.

  6. You are prompted to create or fetch a security key. Since this is not the first ManageIQ appliance, choose 2) Fetch key from remote machine. For worker and multi-region setups, use this option to copy key from another appliance.

    All ManageIQ appliances in a multi-region deployment must use the same key.

  7. Choose 2) Create Region in External Database for the database location.

  8. Enter the database hostname or IP address when prompted.

  9. Enter the database name or leave blank for the default (vmdb_production).

  10. Enter the database username or leave blank for the default (root).

  11. Enter the chosen database user’s password.

  12. Confirm the configuration if prompted.

3. Logging In After Installing ManageIQ

Once ManageIQ is installed, you can log in and perform administration tasks.

Log in to ManageIQ for the first time after installing by:

  1. Navigate to the URL for the login screen. (https://xx.xx.xx.xx on the virtual machine instance)

  2. Enter the default credentials (Username: admin | Password: smartvm) for the initial login.

  3. Click Login.

3.1. Changing the Default Login Password

Change your password to ensure more private and secure access to ManageIQ.

  1. Navigate to the URL for the login screen. (https://xx.xx.xx.xx on the virtual machine instance)

  2. Click Update Password beneath the Username and Password text fields.

  3. Enter your current Username and Password in the text fields.

  4. Input a new password in the New Password field.

  5. Repeat your new password in the Verify Password field.

  6. Click Login.

Appendix A: Appendix

A.1. Appliance Console Command-Line Interface (CLI)

Currently, the appliance_console_cli feature is a subset of the full functionality of the appliance_console itself, and covers functions most likely to be scripted using the command-line interface (CLI).

  1. After starting the ManageIQ appliance, log in with a user name of root and the default password of smartvm. This displays the Bash prompt for the root user.

  2. Enter the appliance_console_cli or appliance_console_cli --help command to see a list of options available with the command, or simply enter appliance_console_cli --option <argument> directly to use a specific option.

Table 1. Database Configuration Options

Option

Description

--region (-r)

region number (create a new region in the database - requires database credentials passed)

--internal (-i)

internal database (create a database on the current appliance)

--dbdisk

database disk device path (for configuring an internal database)

--hostname (-h)

database hostname

--port

database port (defaults to 5432)

--username (-U)

database username (defaults to root)

--password (-p)

database password

--dbname (-d)

database name (defaults to vmdb_production)

Table 2. v2_key Options

Option

Description

--key (-k)

create a new v2_key

--fetch-key (-K)

fetch the v2_key from the given host

--force-key (-f)

create or fetch the key even if one exists

--sshlogin

ssh username for fetching the v2_key (defaults to root)

--sshpassword

ssh password for fetching the v2_key

Table 3. IPA Server Options

Option

Description

--host (-H)

set the appliance hostname to the given name

--ipaserver (-e)

IPA server FQDN

--ipaprincipal (-n)

IPA server principal (default: admin)

--ipapassword (-w)

IPA server password

--ipadomain (-o)

IPA server domain (optional). Will be based on the appliance domain name if not specified.

--iparealm (-l)

IPA server realm (optional). Will be based on the domain name of the ipaserver if not specified.

--uninstall-ipa (-u)

uninstall IPA client

  • In order to configure authentication through an IPA server, in addition to using Configure External Authentication (httpd) in the appliance_console, external authentication can be optionally configured via the appliance_console_cli (command-line interface).

  • Specifying --host will update the hostname of the appliance. If this step was already performed via the appliance_console and the necessary updates made to /etc/hosts if DNS is not properly configured, the --host option can be omitted.

Table 4. Certificate Options

Option

Description

--ca (-c)

CA name used for certmonger (default: ipa)

--postgres-client-cert (-g)

install certs for postgres client

--postgres-server-cert

install certs for postgres server

--http-cert

install certs for http server (to create certs/httpd* values for a unique key)

--extauth-opts (-x)

external authentication options

The certificate options augment the functionality of the certmonger tool and enable creating a certificate signing request (CSR), and specifying certmonger the directories to store the keys.

Table 5. Other Options

Option

Description

--logdisk (-l)

log disk path

--tmpdisk

initialize the given device for temp storage (volume mounted at /var/www/miq_tmp)

--verbose (-v)

print more debugging info

Example Usage
$ ssh root@appliance.test.company.com

To create a new database locally on the server using /dev/sdb:

# appliance_console_cli --internal --dbdisk /dev/sdb --region 0 --password smartvm

To copy the v2_key from a host some.example.com to local machine:

# appliance_console_cli --fetch-key some.example.com --sshlogin root --sshpassword smartvm

You could combine the two to join a region where db.example.com is the appliance hosting the database:

# appliance_console_cli --fetch-key db.example.com --sshlogin root --sshpassword smartvm --hostname db.example.com --password mydatabasepassword

To configure external authentication:

# appliance_console_cli --host appliance.test.company.com
                        --ipaserver ipaserver.test.company.com
                        --ipadomain test.company.com
                        --iparealm TEST.COMPANY.COM
                        --ipaprincipal admin
                        --ipapassword smartvm1

To uninstall external authentication:

# appliance_console_cli  --uninstall-ipa