Red Hat Training

A Red Hat training course is available for Red Hat CloudForms

Installing CloudForms on VMware vSphere

Red Hat CloudForms 4.0

How to Install and Configure the CloudForms Management Engine Appliance on a VMware vSphere environment

Red Hat CloudForms Documentation Team

Abstract

This guide provides installation and configuration instructions for the CloudForms Management Engine Appliance. Information and procedures in this book are relevant to CloudForms Management Engine administrators.
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.

Chapter 1. Installing CloudForms

CloudForms Management Engine is able to be installed and ready to configure in a few quick steps. After downloading CloudForms Management Engine 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 supported virtualization or cloud provider.

Important

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

1.1. Obtaining the CloudForms Management Engine 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 VMware Virtual Appliance download link.

1.2. Uploading the Appliance on VMware vSphere

Uploading the CloudForms Management Engine Appliance file onto VMware vSphere systems has the following requirements:

  • 44 GB of space on the chosen vSphere datastore.
  • Administrator access to the vSphere Client.
  • Depending on your infrastructure, allow time for the upload.
Note

These are the procedural steps as of the time of writing. For more information, consult the VMware documentation.

Use the following procedure to upload the CloudForms Management Engine Appliance OVF template from your local file system using the vSphere Client.

  1. In the vSphere Client, select FileDeploy OVF Template. The Deploy OVF Template wizard appears.
  2. Specify the source location and click Next.

    • Select Deploy from File to browse your file system for the OVF template, for example cfme-vsphere-5.4-43.x86_64.vsphere.ova.
    • Select Deploy from URL to specify a URL to an OVF template located on the internet.
  3. View the OVF Template Details page and click Next.
  4. Select the deployment configuration from the drop-down menu and click Next. The option selected typically controls the memory settings, number of CPUs and reservations, and application-level configuration parameters.
  5. Select the host or cluster on which you want to deploy the OVF template and click Next.
  6. Select the host on which you want to run the run the CloudForms Management Engine appliance, and click Next.
  7. Navigate to, and select the resource pool where you want to run the CloudForms Management Engine appliance and click Next.
  8. Select a datastore to store the deployed CloudForms Management Engine Appliance, and click Next. Ensure to select a datastore large enough to accommodate the virtual machine and all of its virtual disk files.
  9. Select the disk format to store the virtual machine virtual disks, and click Next.

    • Select Thin Provisioned if the storage is allocated on demand as data is written to the virtual disks.
    • Select Thick Provisioned if all storage is immediately allocated.
  10. For each network specified in the OVF template, select a network by right-clicking the Destination Network column in your infrastructure to set up the network mapping and click Next.
  11. The IP Allocation page does not require any configuration changes. Leave the default settings in the IP Allocation page and click Next.
  12. Set the user-configurable properties and click Next. The properties to enter depend on the selected IP allocation scheme. For example, you are prompted for IP related information for the deployed virtual machines only in the case of a fixed IP allocation scheme.
  13. Review your settings and click Finish.

The progress of the import task appears in the vSphere Client Status panel.

Chapter 2. Configuring CloudForms

Although the CloudForms Management Engine Appliance comes configured to be integrated immediately into your environment, you can make some changes to its configuration.

Note

The CloudForms Management Engine 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 CloudForms Management Engine 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 CloudForms Management Engine 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 CloudForms Management Engine 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 CloudForms Management Engine 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 CloudForms Management Engine Appliance.
  • Use Test Network Configuration to check that name resolution is working correctly.
  • Use Set Hostname to specify a hostname for the CloudForms Management Engine Appliance.

    Important

    A valid fully qualified hostname for the CloudForms Management Engine 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 CloudForms Management Engine 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 CloudForms Management Engine 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 CloudForms Management Engine Appliance.
  • Use Quit to leave the CloudForms Management Engine Appliance console.

2.3. Configuring a Database for CloudForms Management Engine

Before using CloudForms Management Engine, configure the database options for it. CloudForms Management Engine provides two options for database configuration:

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

See CPU Sizing Assistant for a Dedicated VMDB Host in the Deployment Planning Guide for guidelines on CPU requirements.

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 CloudForms Management Engine 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 CFME appliance, choose 1) Create key.
    • If this is not the first CFME appliance, choose 2) Fetch key from remote machine to fetch the key from the first CFME appliance. All CFME 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.

CloudForms Management Engine configures the internal database.

2.5. Configuring an External Database

The postgresql.conf file used with CloudForms Management Engine 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 CloudForms Management Engine databases use a postgresql.conf file based on the standard file used by the CloudForms Management Engine 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 CloudForms Management Engine databases with other types of databases in a single PostgreSQL instance.

Note

CloudForms Management Engine 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 CloudForms Management Engine 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 CFME appliance, select the option to create a key.
    • If this is not the first CFME appliance, select the option to fetch the key from the first CFME appliance. All CFME 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.

CloudForms Management Engine will then configure the external database.

2.6. Configuring a Worker Appliance for CloudForms Management Engine

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 CloudForms Management Engine 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 CFME appliance. All CFME 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.

Chapter 3. Additional Requirements

3.1. Installing VMware VDDK on CloudForms Management Engine

Execution of SmartState Analysis on virtual machines within a VMware environment requires the Virtual Disk Development Kit (VDDK). CloudForms Management Engine supports VDDK 5.5.

  1. Download VDDK 5.5 (VMware-vix-disklib-5.5.0-1284542.x86_64.tar.gz at the time of this writing) from the VMware website.

    Note

    If you do not already have a login ID to VMware, then you will need to create one. At the time of this writing, the file can be found by navigating to DownloadsAll DownloadsDrivers & Tools. Select VMware vSphereDrivers & Tools. Expand Automation Tools and SDKs, and select vSphere Virtual Disk Development Kit 5.5. Alternatively, find the file by searching for it using the Search on the VMware site.

  2. Download and copy the VMware-vix-disklib-5.5.0-1284542.x86_64.tar.gz file to the /root directory of the appliance.
  3. Start an SSH session into the appliance.
  4. Extract and install VDDK 5.5 using the following commands:

    # cd /root
    # tar -xvf VMware-vix-disklib-5.5.0-1284542.x86_64.tar.gz
    # cd vmware-vix-disklib-distrib
    # /vmware-install.pl
  5. Accept the defaults during the installation:

    Installing VMware VIX DiskLib API. You must read and accept the VMware VIX DiskLib API End User License Agreement to continue. Press enter to display it. Do you accept? (yes/no) yes
    
    Thank you. What prefix do you want to use to install VMware VIX DiskLib API? The prefix is the root directory where the other folders such as man, bin, doc, lib, etc. will be placed. [/usr] (Press Enter)
    
    The installation of VMware VIX DiskLib API 5.5.0 build-1284542 for Linux completed successfully. You can decide to remove this software from your system at any time by invoking the following command:
    "/usr/bin/vmware-uninstall-vix-disklib.pl". Enjoy, --the VMware team
  6. Run ldconfig to instruct CloudForms Management Engine to find the newly installed VDDK library.

    Note

    Use the following command to verify the VDDK files are listed and accessible to the appliance:

    # ldconfig -p | grep vix
  7. Restart the CloudForms Management Engine appliance.

The VDDK is now installed on the CloudForms Management Engine appliance. This enables use of the SmartState Analysis Server Role on the appliance.