Installing RQA customer-managed

Learn more about installing IBM Engineering Requirements Quality Assistant (RQA) in your private network.

About this task

The OpenShift® administrator can install RQA in the OpenShift cluster by using one of the following approaches.
Important: If you use the non-liberty-based authentication, such as Cloud Identity, you cannot install RQA customer-managed by running the rqa-oc-setup script, and you must install RQA customer-managed from the OpenShift Container Platform (OCP) web console.

Installing RQA customer-managed by running the rqa-oc-setup

If you use a liberty-based authentication that is Jazz Authorization Server authentication, then you can install RQA customer-managed by running the rqa-oc-setup script.

Before you begin

About this task

rqa-oc-setup is a collection of ansible scripts and templates that automate the installation of RQA customer-managed on the OpenShift cluster.

Procedure

  1. Go to the Jazz wiki and download the RQA-Simplified-Installation.zip file.
  2. Extract the archive on your system. The archive includes rqa-oc-setup and validation_check folders.
  3. Copy the rqa-oc-setup folder on the infrastructure node of your OpenShift cluster.
  4. Edit the defaults.yml file from the rqa-oc-setup folder, and complete the following steps to enter your configuration settings:
    1. Provide the SSO details under the # SSO Config section:
      oidc:
        oidc_url: <Enter the OIDC URL>
        isliberty: <Enter the value as ‘true’ or ‘false’>
        timeout: <Enter the timeout value>
        admin_id: <Enter your admin ID>
        admin_pwd: <Enter your admin password>
      
      Note:
      • Example of the IODC IRL: https://jas.my.company.com:9643/oidc/endpoint/jazzop/.well-known/openid-configuration
      • For liberty-based authentication, such as Jazz Authorization Server authentication, enter the value of the isliberty flag as true. For non-liberty-based authentication, such as Cloud Identity, enter the value of the isliberty flag as false.
    2. Provide the configuration details under the # RQA config section:
      # RQA config
      rqa:
        namespace: <Enter project name where you want to install the RQA operator>
        entitlement_key: <Enter the entitlement key>
        rqa_catalog:
          name: rqa-manifests
          display_name: 'RQA Catalog Source'
          publisher: IBM
          image: 'icr.io/cpopen/ibm-rqa-operator-catalog:latest'
        redis_catalog:
          name: ibm-cloud-databases-redis-operator-catalog
          display_name: 'IBM Redis Catalog Source'
          publisher: IBM
          image: 'icr.io/cpopen/ibm-cloud-databases-redis-catalog@sha256:9d4eec7ba489efefa6e8be937a79173a4c0cfad5ca5ad2f648f0eed10261a165'
        operator_group: rqa-operator-group
        operator_name: rqa-operator
        storage_class: <your.storage_class>
        domain: <Enter the domain name>
        instance_name: <Enter the name for the RQA instance>
      
      Note: If you are on the Red Hat OpenShift Container Platform (OCP) version 4.9, you must use channel 2.2 for installing could operator.
    3. Provide the configuration details under the # IBM License Key Server config section:
      # IBM License Key Server config
      rlks:
        host: <Enter the host details of the IBM Common Licensing server> 
        port: <Enter the port details of the IBM Common Licensing server>
        lmgrdport: <Enter the LMGRD Port number of your IBM Common Licensing server>
      Note: Don’t prefix the hostname with http:// or https://.
  5. Save the defaults.yml file.
  6. Open the command prompt, and log in to the OpenShift environment by running the oc login command.
  7. Go to the directory where you extracted the rqa-oc-setup as mentioned in step 3.
  8. Run the chmod 755 install-rqa.yml command.
  9. Run the ~/ansible/bin/ansible-playbook install-rqa.yml command. The RQA customer-managed installation proceeds, and the following message is shown:
    Make sure that the RQA operator is up and running and then press Enter:
  10. Complete the following steps to verify that the RQA operator is successfully installed and the status is shown as Succeeded:
    1. Log in to the OpenShift Container Platform (OCP) web console.
    2. In the left panel, go to Operators > Operators > Installed Operators, and select the project where you installed the RQA operator.
    3. Verify that in the Installed Operators page, you can see the Status of the RQA operator as Succeeded.
  11. Switch back to the command prompt and press Enter to proceed with the installation.

Results

The following message is shown:
RQA instance creation is in progress. The pods will be created in approximately 15-30 min. After that, you can verify the resources that are created.

What to do next

Installing RQA customer-managed from the OpenShift Container Platform (OCP) web console

Before you begin

Before you begin with the installation, verify that your hardware and software meet the minimum requirements. See Hardware and software requirements.

About this task

The OpenShift administrator can install RQA in the OpenShift cluster by using the OpenShift Container Platform (OCP) web console.

Procedure

Complete the following steps sequentially to install RQA on the OpenShift cluster:

  1. Creating projects
  2. Validating prerequisites for RQA operator installation
  3. Registering RQA as a client
  4. Creating catalog sources
  5. Creating RQA application secret
  6. Installing RQA operator
  7. Obtaining the entitlement key
  8. Creating the image pull secret
  9. Creating RQA instance
  10. Verifying the resources created after RQA installation
  11. Configuring custom certificates for RQA administrator dashboard and RQA widget
  12. Validating RQA installation