ManageIQ
Latest
Versions: Latest / Quinteros / Petrosian / Oparin / Najdorf / Morphy / Lasker / Kasparov / Jansa / Ivanchuk / Hammer / Gaprindashvili / Fine / Euwe

1. Installing ManageIQ

Installing ManageIQ on Red Hat Virtualization consists of the following steps:

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

  2. Uploading the appliance image to the Red Hat Virtualization data storage domain.

  3. Creating a virtual machine based on the appliance.

After you have completed all the procedures in this chapter, you will have a working environment which you can further configure and customize.

Requirements

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.

See Creating a Virtual Machine in the Red Hat Virtualization Virtual Machine Management Guide for information on specifying memory for a new virtual machine.

1.1. Obtaining the Appliance

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.

After the image completes downloading, you are ready to upload the CloudForms appliance to your Red Hat Virtualization environment and create a virtual machine.

1.2. Uploading the Appliance to Red Hat Virtualization

Upload the qcow2 appliance image to your Red Hat Virtualization data storage domain from the Red Hat Virtualization Administration Portal.

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 Red Hat Virtualization Administration Portal.

  2. Click Storage  Disks.

  3. Select Upload  Start.

  4. Click Choose File, and select the appliance image to upload.

  5. Under Disk Options, enter an Alias for the image.

  6. (Optional) Edit other fields in Disk Options if desired.

  7. Click OK.

A progress bar in the Status column indicates the status of the upload. You can also pause, cancel, or resume uploads from the Upload menu.

The status shows OK when the image has completed uploading.

See the Uploading Images to a Data Storage Domain in the Red Hat Virtualization Administration Guide for more information.
Increasing the Upload Timeout Value

  1. If the upload times out and you see the message, Reason: timeout due to transfer inactivity, increase the timeout value:

    # engine-config -s TransferImageClientInactivityTimeoutInSeconds=6000

  2. Restart the ovirt-engine service:

    # systemctl restart ovirt-engine

1.3. Creating a ManageIQ Virtual Machine

After uploading the appliance to the data domain, create a virtual machine containing the ManageIQ image and a second disk for the database:

  1. In Compute  Virtual Machines, click New to open the New Virtual Machine dialog.

  2. From the General tab, specify a name for the virtual machine and any other details.

  3. Click Attach.

  4. Select the ManageIQ appliance you uploaded from the list of images and click OK.

  5. Click the VM to open its details screen, and click the Disks tab.

  6. Click Edit to the disk, and check Bootable if it is not marked already.

  7. Click OK.

  8. Add a second disk for the database:

    1. Click the General tab and click the Edit button to edit the virtual machine.

    2. Click + and Create to create a disk for the database (VMDB).

    3. Specify a Size in GB for the disk that allows sufficient space for your database. Red Hat recommends allocating the virtual machine disk fully at the time of creation. Three main factors affect the size of your database over time:

      • Virtual Machine Count: the most important factor in the calculation of virtual machine database (VMDB) size over time.

      • Host Count: the number of hosts associated with the provider.

      • Storage Count: the number of individual storage elements as seen from the perspective of the provider or host. It is not the total number of virtual disks for all virtual machines.

        See "Database Requirements" in the Deployment Planning Guide for size considerations.

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

    5. Specify any other values as desired.

  9. Click OK to create the disk and return to the New Virtual Machine window.

  10. Add a network interface to the virtual machine by selecting a vNIC profile from the nic1 list.

  11. Click OK to save your changes to the virtual machine.

  12. Start the ManageIQ appliance by clicking the Run button.

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 the security key from another appliance.

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

  7. Choose 3) Join Region in External Database for the database location.

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

  9. Enter the port number or leave blank for the default (5432).

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

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

  12. Enter the chosen database user’s password.

  13. 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