Chapter 1. Installing Red Hat CloudForms

Red Hat CloudForms can be installed on OpenShift Container Platform in a few quick steps.

This procedure uses a template to deploy a multi-pod Red Hat CloudForms appliance with the database stored in a persistent volume on OpenShift Container Platform. It provides a step-by-step setup, including cluster administrative tasks as well as regular user information and commands.

The ultimate goal of the deployment is to be able to deconstruct the Red Hat CloudForms appliance into several containers running on a pod or a series of pods.

Note

Running Red Hat CloudForms on OpenShift Container Platform is available as a technology preview in this release of Red Hat CloudForms. For more information on the support scope for features marked as technology preview, see Technology Preview Features Support Scope. Additionally, at this time only one Red Hat CloudForms instance can be run at one time, and upgrading is unavailable.

1.1. Prerequisites

To successfully deploy a Red Hat CloudForms appliance on OpenShift Container Platform, you need a functioning OpenShift Container Platform 3.5 or newer install with the following configured:

  • NFS or other compatible volume provider
  • A cluster-admin user
  • A regular user (such as an application developer)
Important

OpenShift Container Platform 3.5 is required for this installation. Red Hat has not tested this procedure with earlier versions of OpenShift Container Platform.

The CloudForms deployment uses .yaml template files to create the appliance, including cfme-template.yaml, which is the CloudForms template used for the deployment, and cfme-pv-example.yaml and cfme-pv-app-example.yaml, two pod volume files.

These templates are available in RPMs from Red Hat-provided image streams. To obtain the templates:

  1. Configure image streams as described in OpenShift Container Platform Installation and Configuration.
  2. After loading the image streams and templates, the templates will be available on your OpenShift system in /usr/share/openshift/examples/cfme-templates.

The CloudForms template points to several image files to create the OpenShift pods that comprise the appliance. These image files are obtained from the Red Hat Container Catalog during deployment.

1.1.1. Cluster Sizing

To avoid deployment failures due to resource starvation, Red Hat recommends the following minimum cluster size for a test environment:

  • 1 master node with at least 8 vCPUs and 12GB of RAM
  • 2 nodes with at least 4 vCPUs and 8GB of RAM
  • 25GB of storage for CloudForms physical volume use

These recommendations assume CloudForms is the only application running on this cluster. Alternatively, you can provision an infrastructure node to run registry, metrics, router, and logging pods.

Each CloudForms application pod will consume at least 3GB of RAM on initial deployment (without providers added). RAM consumption increases depending on the appliance use. For example, after adding providers, expect higher resource consumption.

1.2. Preparing to Deploy CloudForms

To prepare for deploying the CloudForms appliance to OpenShift Container Platform, create a project, configure security contexts, and create pod volumes.

  1. As a regular user, log in to OpenShift:

    $ oc login -u <user> -p <password>
  2. Create a project with your desired parameters. The <project_name> is mandatory, but <description> and <display_name> are optional:

    $ oc new-project <project_name> \
    --description="<description>" \
    --display-name="<display_name>"
  3. Add the cfme-anyuid service account to the anyuid security context constraint (SCC).

    Because the CloudForms image requires the root user, the cfme-anyuid service account for your namespace (project) must be added to the anyuid SCC before pods using the service account can run as root.

    1. As the admin user, add the cfme-anyuid service account by running:

      $ oc adm policy add-scc-to-user anyuid system:serviceaccount:<your-namespace>:cfme-anyuid
    2. Verify that the cfme-anyuid service account is now included in the anyuid SCC:

      $ oc describe scc anyuid | grep Users
      Users:					system:serviceaccount:<your-namespace>:cfme-anyuid
  4. Add your default service account to the privileged security context. The default service account for your namespace (project) must be added to the privileged security context constraints (SCCs) before they can run privileged pods.

    1. As the admin user, add the default service account by running:

      $ oc adm policy add-scc-to-user privileged system:serviceaccount:<your-namespace>:default
    2. Verify that your default service account is now included in the privileged security context constraints (SCCs):

      $ oc describe scc privileged | grep Users
      Users:                  system:serviceaccount:openshift-infra:build-controller,system:serviceaccount:management-infra:management-admin,system:serviceaccount:management-infra:inspector-admin,system:serviceaccount:default:router,system:serviceaccount:default:registry,system:serviceaccount:<your-namespace>:default
  5. Prepare persistent storage for the deployment. (Skip this step if you have already configured persistent storage.)

    A regular CloudForms deployment needs at least two persistent volumes (PVs) to store CloudForms data. As the admin user, create two persistent volumes: one to host the CloudForms PostgreSQL database, and one to host the application data.

    Example NFS-backed volume templates are provided by cfme-pv-db-example.yaml and cfme-pv-server-example.yaml, available from GitHub.

    Note

    For NFS-backed volumes, ensure your NFS server firewall is configured to allow traffic on port 2049 (TCP) from the OpenShift cluster.

    Red Hat recommends setting permissions for the pv-app (privileged pod volume) as 777, uid/gid 0 (owned by root). For more information on configuring persistent storage in OpenShift Container Platform, see the OpenShift Container Platform Installation and Configuration guide.

    1. Configure your NFS server host details within these files, and edit any other settings needed to match your environment.
    2. Run the following commands to create the two persistent volumes:

      $ oc create -f cfme-pv-db-example.yaml
      $ oc create -f cfme-pv-server-example.yaml
    3. Verify the pod volumes were created successfully:

      $ oc get pv
      NAME       CAPACITY   ACCESSMODES   RECLAIMPOLICY   STATUS      CLAIM  REASON   AGE
      cfme-pv01   15Gi        RWO           Recycle         Available                   30s
      cfme-pv02   5Gi         RWO           Recycle         Available                   19s
      Note

      Red Hat recommends validating NFS share connectivity from an OpenShift node before attempting a deployment.

  6. Increase the maximum number of imported images on ImageStream.

    By default, OpenShift Container Platform can import five tags per image stream, but the CloudForms repositories contain more than five images for deployments.

    You can modify this setting on the master node at /etc/origin/master/master-config.yaml so OpenShift can import additional images.

    1. Add the following at the end of the /etc/origin/master/master-config.yaml file:

      ...
      imagePolicyConfig:
        maxImagesBulkImportedPerRepository: 100
    2. Restart the master service:

      $ systemctl restart atomic-openshift-master

1.3. Deploying the CloudForms Appliance

To deploy the appliance on OpenShift Container Platform, create the Red Hat CloudForms template and verify it is available in your project.

  1. As a regular user, create the Red Hat CloudForms template:

    $ oc create -f templates/cfme-template.yaml
    template "cloudforms" created
  2. Verify the template is available with your project:

    $ oc get templates
    NAME         DESCRIPTION                                    PARAMETERS        OBJECTS
    cloudforms   CloudForms appliance with persistent storage   18 (1 blank)      12
  3. (Optional) Customize the template’s deployment parameters. Use the following command to see the available parameters and descriptions:

    $ oc process --parameters -n <your-project> cloudforms

    To customize the deployment configuration parameters, run:

    $ oc edit dc/<deployconfig_name>
  4. To deploy Red Hat CloudForms from template using default settings, run:

    $ oc new-app --template=cloudforms

    Alternatively, to deploy Red Hat CloudForms from a template using customized settings, add the -p option and the desired parameters to the command. For example:

    $ oc new-app --template=cloudforms -p DATABASE_VOLUME_CAPACITY=2Gi,POSTGRESQL_MEM_LIMIT=4Gi,APPLICATION_DOMAIN=hostname
    Important

    The APPLICATION_DOMAIN parameter specifies the hostname used to reach the CloudForms application, which eventually constructs the route to the CloudForms pod. If you do not specify the APPLICATION_DOMAIN parameter, the CloudForms application will not be accessible after the deployment; however, this can be fixed by changing the route. For more information on OpenShift template parameters, see the OpenShift Container Platform Developer Guide.

1.4. Verifying the Configuration

Verify the deployment was successful by running the following commands as a regular user under the Red Hat CloudForms project:

Note

The first deployment can take several minutes to complete while OpenShift downloads the necessary images.

  1. Confirm the Red Hat CloudForms pod is bound to the correct security context constraints.

    1. List and obtain the name of the cfme-app pod:

      $ oc get pod
      NAME                 READY     STATUS    RESTARTS   AGE
      cloudforms-1-fzwzm   1/1       Running   0          4m
      memcached-1-6iuxu    1/1       Running   0          4m
      postgresql-1-2kxc3   1/1       Running   0          4m
    2. Export the configuration of the pod:

      $ oc export pod <cfme_pod_name>
    3. Examine the output to verify that openshift.io/scc has the value anyuid:

      ...
      metadata:
        annotations:
          openshift.io/scc: anyuid
      ...
  2. Verify the persistent volumes are attached to the postgresql and cfme-app pods:

    $ oc volume pods --all
    pods/postgresql-1-437jg
      pvc/cfme-pgdb-claim (allocated 2GiB) as cfme-pgdb-volume
        mounted at /var/lib/pgsql/data
      secret/default-token-2se06 as default-token-2se06
        mounted at /var/run/secrets/kubernetes.io/serviceaccount
    pods/cfme-1-s3bnp
      pvc/cfme (allocated 2GiB) as cfme-app-volume
        mounted at /persistent
      secret/default-token-9q4ge as default-token-9q4ge
        mounted at /var/run/secrets/kubernetes.io/serviceaccount
  3. Check the readiness of the CloudForms pod:

    Note

    Allow approximately five minutes once pods are in running state for Red Hat CloudForms to start responding on HTTPS.

    $ oc describe pods <cfme_pod_name>
    ...
    Conditions:
      Type      Status
      Ready     True
    Volumes:
    ...
  4. After you have successfully validated your CloudForms deployment, disable automatic image change triggers to prevent unintended upgrades.

    By default, on initial deployments the automatic image change trigger is enabled. This could potentially start an unintended upgrade on a deployment if a newer image is found in the ImageStream.

    Disable the automatic image change triggers for CloudForms deployment configurations (DCs) on each project with the following commands:

    $ oc set triggers dc --manual -l app=cloudforms
    deploymentconfig "memcached" updated
    deploymentconfig "postgresql" updated
    
    $ oc set triggers dc --from-config --auto -l app=cloudforms
    deploymentconfig "memcached" updated
    deploymentconfig "postgresql" updated
    Note

    The configuration change trigger is kept enabled; to have full control of your deployments, you can alternatively turn it off. See the OpenShift Container Platform Developer Guide for more information on deployment triggers.

1.5. Scaling CloudForms Appliances

StatefulSets in OpenShift allow scaling of CloudForms appliances. See the OpenShift Container Platform 3.5 Release Notes for information on StatefulSets.

Important

Each new replica (server) consumes a physical volume. Before scaling, ensure you have enough physical volumes available to scale.

The following example shows scaling using StatefulSets:

Example: Scaling to two replicas

$ oc scale statefulset cloudforms --replicas=2
statefulset "cloudforms" scaled
$ oc get pods
NAME                 READY     STATUS    RESTARTS   AGE
cloudforms-0           1/1       Running   0          34m
cloudforms-1           1/1       Running   0          5m
memcached-1-mzeer    1/1       Running   0          1h
postgresql-1-dufgp   1/1       Running   0          1h

The newly created replicas will join the existing CloudForms region. For a StatefulSet with N replicas, when pods are being deployed, they are created sequentially, in order from {0..N-1}.

1.6. Obtaining Pod Access and Routes

To open a shell on the CloudForms pod, run:

$ oc rsh <pod_name> bash -l

To obtain host information from the route:

$ oc get routes
NAME         HOST/PORT                   PATH                SERVICE      TERMINATION   LABELS
cloudforms   cfme.apps.e2e.example.com  cloudforms:443-tcp   passthrough                app=cloudforms

A route should have been deployed via template for HTTPS access on the CloudForms pod. Examine the output and point your web browser to the reported URL/host (in this example, cfme.apps.e2e.example.com).