Installing Red Hat CloudForms on Red Hat Virtualization

Red Hat CloudForms 4.1

How to install and configure Red Hat CloudForms on a Red Hat Virtualization environment

Red Hat CloudForms Documentation Team

Abstract

This guide provides instructions on how to install and configure Red Hat CloudForms on a Red Hat Virtualization environment.
If you have a suggestion for improving this guide or have found an error, please submit a Bugzilla report at http://bugzilla.redhat.com against Red Hat CloudForms Management Engine for the Documentation component. Please provide specific details, such as the section number, guide name, and CloudForms version so we can easily locate the content.

1. Installing Red Hat CloudForms

Red Hat CloudForms is able to be installed and ready to configure in a few quick steps. After downloading Red Hat CloudForms as a virtual machine image template from the Red Hat Customer Portal, the installation process takes you through the steps of uploading the appliance to a Red Hat Virtualization environment.

Important

After installing the Red Hat CloudForms appliance, you must configure the database for Red Hat CloudForms. See Section 2.3, “Configuring a Database for Red Hat CloudForms”.

1.1. Obtaining the Appliance

  1. Go to access.redhat.com and log in to the Red Hat Customer Portal using your customer account details.
  2. Click Downloads in the menu bar.
  3. Click A-Z to sort the product downloads alphabetically.
  4. Click Red Hat CloudFormsDownload Latest to access the product download page.
  5. From the list of installers and images, select the CFME Red Hat Virtual Appliance download link.

1.2. Uploading the Appliance on Red Hat Virtualization Manager

The method for uploading the CloudForms 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 Red Hat CloudForms 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.
  • 8 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.
Note

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. Open the Upload Image screen in the Administration Portal:

    • From the Disks tab, select Start from the Upload drop-down.
    • Alternatively, from the Storage tab select the storage domain, then select the Disks sub-tab, and select Start from the Upload drop-down.
  2. In the Upload Image screen, click Browse and select the image on the local disk.
  3. Set Image Type to QCOW2.
  4. 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.
  5. Click OK.

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

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 Red Hat CloudForms appliance using the image uploader:

  1. Change to the directory containing the Red Hat CloudForms 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.

    Note

    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): **********
    Important

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

It takes approximately 90 minutes to upload the Red Hat CloudForms 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 into 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 Red Hat CloudForms appliance OVA archive to this directory.
  4. Extract the OVA file using the tar command:

    $ tar xvf cfme-rhevm-5.3-15.x86_64.rhevm.ova
  5. Set the following permissions:

    chown -R 36:36 images/
    chown -R 36:36 master/

1.3. Running Red Hat CloudForms

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

  1. Import the appliance image from the export storage domain as a template in a Red Hat Virtualization data storage domain. Use the newimagename you specified when you uploaded the image to find the image to import as a template. Once the import is complete, check the template for a network interface (NIC). If the template does not include one, create a NIC for it.
  2. Create a new virtual machine using the Red Hat CloudForms appliance template as a basis. See the Red Hat Virtualization Administration Guide for instructions.
  3. Add a database disk if you are hosting the database on the same machine as the appliance.
  4. Start the newly created Red Hat CloudForms appliance virtual machine.

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

2. Configuring Red Hat CloudForms

Although the Red Hat CloudForms appliance comes configured to be integrated immediately into your environment, you can make some changes to its configuration.

Note

The Red Hat CloudForms appliance is intended to have minimal configuration options.

2.1. Changing Configuration Settings

The procedure describes how to make changes to the configuration settings on the Red Hat CloudForms appliance.

  1. 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.
  2. Enter the appliance_console command. The Red Hat CloudForms appliance summary screen displays.
  3. Press Enter to manually configure settings.
  4. Press the number for the item you want to change, and press Enter. The options for your selection are displayed.
  5. Follow the prompts to make the changes.
  6. Press Enter to accept a setting where applicable.
Note

The Red Hat CloudForms appliance console automatically logs out after five minutes of inactivity.

2.2. Advanced Configuration Settings

After logging in, you can use the following menu items for advanced configuration of the appliance:

  • Use Set DHCP Network Configuration to use DHCP to obtain the IP address and network configuration for your Red Hat CloudForms appliance. The appliance is initially configured as a DHCP client with bridged networking.
  • Use Set Static Network Configuration if you have a specific IP address and network settings you need to use for the Red Hat CloudForms appliance.
  • Use Test Network Configuration to check that name resolution is working correctly.
  • Use Set Hostname to specify a hostname for the Red Hat CloudForms appliance.

    Important

    A valid fully qualified hostname for the Red Hat CloudForms appliance is required for SmartState analysis to work correctly,

  • Use Set Timezone, Date, and Time to configure the time zone, date, and time for the Red Hat CloudForms appliance.
  • Use Restore Database from Backup to restore the VMDB database from a previous backup.
  • Use Setup Database Region to create regions for VMDB replication.
  • Use Configure Database to configure the VMDB database. Use this option to configure the database for the appliance after installing and running it for the first time.
  • Use Extend Temporary Storage to add temporary storage to the appliance. The appliance formats an unpartitioned disk attached to the appliance host and mounts it at /var/www/miq_tmp. The appliance uses this temporary storage directory to perform certain image download functions.
  • Use Configure External Authentication (httpd) to configure authentication through an IPA server.
  • Use Generate Custom Encryption Key to regenerate the encryption key used to encode plain text password.
  • Use Harden Appliance Using SCAP Configuration to apply Security Content Automation Protocol (SCAP) standards to the appliance. You can view these SCAP rules in the /var/www/miq/lib/appliance_console/config/scap_rules.yml file.
  • Use Stop Server Processes to stop all server processes. You may need to do this to perform maintenance.
  • Use Start Server Processes to start the server. You may need to do this after performing maintenance.
  • Use Restart Appliance to restart the Red Hat CloudForms appliance. You can either restart the appliance and clear the logs or just restart the appliance.
  • Use Shut Down Appliance to power down the appliance and exit all processes.
  • Use Summary Information to go back to the network summary screen for the Red Hat CloudForms appliance.
  • Use Quit to leave the Red Hat CloudForms appliance console.

2.3. Configuring a Database for Red Hat CloudForms

Before using Red Hat CloudForms, configure the database options for it. Red Hat CloudForms provides two options for database configuration:

  • Install an internal PostgreSQL database to the appliance
  • Configure the appliance to use an external PostgreSQL database

2.4. Configuring an Internal Database

Important

Before installing an internal database, add a disk to the infrastructure hosting your appliance. See the documentation specific to your infrastructure for instructions on how to add a disk. As a storage disk usually cannot be added while a virtual machine is running, Red Hat recommends adding the disk before starting the appliance. Red Hat CloudForms only supports installing of an internal VMDB on blank disks. The installation will fail if the disks are not blank.

  1. Start the appliance and open a terminal from your virtualization or cloud provider.
  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 Red Hat CloudForms appliance summary screen displays.
  4. Press Enter to manually configure settings.
  5. Select 8) Configure Database from the menu.
  6. You are prompted to create or fetch an encryption key.

    • If this is the first Red Hat CloudForms appliance, choose 1) Create key.
    • If this is not the first Red Hat CloudForms appliance, choose 2) Fetch key from remote machine to fetch the key from the first Red Hat CloudForms appliance. All Red Hat CloudForms appliances in a multi-region deployment must use the same key.
  7. Choose 1) Internal for the database location.
  8. Choose a disk for the database. For example:

    1)  /dev/vdb: 20480
    
    Choose disk:

    Enter 1 to choose /dev/vdb for the database location.

  9. When prompted, enter a unique three digit region ID to create a new region.

    Important

    Creating a new region destroys any existing data on the chosen database.

  10. Confirm the configuration when prompted.

Red Hat CloudForms configures the internal database.

2.5. Configuring an External Database

The postgresql.conf file used with Red Hat CloudForms databases requires specific settings for correct operation. For example, it must correctly reclaim table space, control session timeouts, and format the PostgreSQL server log for improved system support. Due to these requirements, Red Hat recommends that external Red Hat CloudForms databases use a postgresql.conf file based on the standard file used by the Red Hat CloudForms appliance.

Ensure you configure the settings in the postgresql.conf to suit your system. For example, customize the shared_buffers setting according to the amount of real storage available in the external system hosting the PostgreSQL instance. In addition, depending on the aggregate number of appliances expected to connect to the PostgreSQL instance, it may be necessary to alter the max_connections setting.

Because the postgresql.conf file controls the operation of all databases managed by a single instance of PostgreSQL, do not mix Red Hat CloudForms databases with other types of databases in a single PostgreSQL instance.

Note

Red Hat CloudForms 4.x requires PostgreSQL version 9.4.

  1. Start the appliance and open a terminal console from your virtualization or cloud provider.
  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 Red Hat CloudForms appliance summary screen displays.
  4. Press Enter to manually configure settings.
  5. Select 8) Configure Database from the menu.
  6. You are prompted to create or fetch a security key.

    • If this is the first Red Hat CloudForms appliance, select the option to create a key.
    • If this is not the first Red Hat CloudForms appliance, select the option to fetch the key from the first Red Hat CloudForms appliance. All Red Hat CloudForms appliances in a multi-region deployment must use the same key.
  7. Choose 2) External 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.

Red Hat CloudForms will then configure the external database.

2.6. Configuring a Worker Appliance

You can configure a worker appliance through the terminal. These 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 from your virtualization or cloud provider.
  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 Red Hat CloudForms appliance summary screen displays.
  4. Press Enter to manually configure settings.
  5. Select 8) Configure Database from the menu.
  6. You are prompted to create or fetch a security key. Select the option to fetch the key from the first Red Hat CloudForms appliance. All Red Hat CloudForms appliances in a multi-region deployment must use the same key.
  7. Choose 2) External 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 Red Hat CloudForms

Once Red Hat CloudForms is installed, you can log in and perform administration tasks.

Log in to Red Hat CloudForms 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 Red Hat CloudForms.

  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.