Creating RQA instance

The OpenShift® administrator can create the RQA instance from the OpenShift Container Platform (OCP) OperatorHub.

About this task

When you create the RQA instance, the IBM Redis operator gets installed along with it, and the Redis instance also gets created. RQA uses Redis as in-memory data store and cache. RQA operator declares a dependency on the IBM Redis operator. As part of RQA instance Custom Resource (CR) creation, the RQA operator creates a Redis cluster and configures RQA to use it.
Note: For RQA customer-manged version 3.1.0, the IBM Redis operator version 1.0.0 is supported.

Procedure

Complete the following steps to create the RQA instance in a project. The project is alternatively called namespace. You can follow the same steps to create multiple RQA instances in multiple namespaces.

Important: You must ensure that only one RQA instance is created per namespace.

  1. Log in to the OpenShift Container Platform (OCP) by using the OpenShift administrator credentials.
  2. In the left panel, go to Operators > Installed Operators.
  3. Select the project where you installed the RQA operator.
  4. On the Installed Operators page, select RQA from the Name column, and click the Create Instance link.
  5. On the Create RQA page, use one of the following options to edit the custom resource to create a new RQA instance:
    • YAML View: You are provided with full control of object creation.
    • Form View: You can enter the details in a form.
    Table 1. Creating RQA instance
    Property Description Default
    metadata.name Name of RQA deployment. RQA
    oidc_url Enter the OIDC URL.

    Example:
    https://jas.my.company.com:9643/oidc/endpoint/jazzop/.well-known/openid-configuration

     
    sessiontimeout Session timeout configured for the authorization server. The value is specified in hours. 8
    isliberty When you use the liberty-based authentication, such as Jazz® Authorization Server authentication, enter the value of the isliberty flag as true.
    When you use the non-liberty-based authorization, such as cloud identity, enter the value of the isliberty flag as false.
     
    license.accept Enter the value as true.
    Review and accept the license before you create the RQA instance. If the license is not accepted, RQA instance creation fails.
    false
    license server.host Host details of your IBM Common Licensing server.  
    license server.port Port number of your IBM Common Licensing server. 27001
    license server.lmgrdport LMGRD Port number of your IBM Common Licensing server. 27000
    rqa.admin Jazz ID of the user that is added as the RQA administrator.  
    rqa.redis.storageclass Storage class that is used to create Persistent Volume (PV) for Redis database.  
    rqa.domain Provide the domain name of your OpenShift cluster.
    For example, if your OpenShift Cluster URL is https://console-openshift-console.apps.clusteraddress.xyz.com, then provide the domain name as apps.clusteraddress.xyz.com.
     
    rqa.hostname_admindashboard_tls (Optional) Transport Layer Security (TLS) secret name for the administrator dashboard route.  
    rqa.hostname_dngwidget_tls (Optional) Transport Layer Security (TLS) secret name for the widget route  
    rqa.hostname_admindashboard
    (Optional)
    By default, RQA generates a route for the administrator dashboard in the <your-RQA-instance-name>-admindash-route-<project-name>.<rqa.domain> format.

    If you want to use the custom route name, provide the Fully Qualified Domain Name (FQDN) in the <custom-route-name>.<rqa.domain> format.

    Example:
    my-admindash.apps.clusteraddress.xyz.com.

    If you want to use the custom hostname, provide the FQDN in the <hostname>.<custom-domain-name> format.

    Example: admindash.mycompany.com

    Format:

    https://<meta.name> -admindash-route-< meta.namespace>.<rqa.domain>

    Example:

    https://rqa-admindash-route-projectname.apps.clusteraddress.xyz.com

    rqa.hostname_dngwidget
    (Optional)
    By default, RQA generates a route for the RQA widget in the <your-RQA-instance-name>-dngwidget-route-<project-name>.<rqa.domain> format.

    If you want to use the custom route name, provide the FQDN in the <custom-route-name>.<rqa.domain> format.

    Example:
    my-dngwidget.apps.clusteraddress.xyz.com.

    If you want to use the custom hostname, provide the FQDN in the <hostanme>.<custom-domain-name> format.

    Example: dngwidget.mycompany.com

    Format:

    https://<meta.name>-dngwidget-route-<meta.namespace>.<rqa.domain>

    Example:

    https://rqa-dngwidget-route-projectname.apps.clusteraddress.xyz.com

    version RQA version that you want to install. Example:3.0.0
  6. Click Create. The RQA instance is created. The pods are created in approximately 15 - 30 minutes.
    Attention: If you selected the Manual approval strategy when you installed the RQA operator, the following error is shown in the logs at the time of RQA instance creation. The error is shown because the approval to install the Redis operator is not provided.
    [1;30mtask path: /opt/ansible/roles/pre-req/tasks/main.yml:85[0m
    [0;31mfatal: [localhost]: FAILED! => {"changed": true, "cmd": ["oc", "patch", "serviceaccount", "ibm-cloud-databases-redis-operator-serviceaccount", "-p",
     "{\"imagePullSecrets\":[{\"name\":\"ibm-entitlement-key\"}]}"], "delta": "0:00:03.789958", "end": "2021-
    08-11 14:15:52.709545", "msg": "non-zero return code", "rc": 1, "start": "2021-08-11 14:15:48.919587", "stderr": "Error from server
    (NotFound): serviceaccounts \"ibm-cloud-databases-redis-operator-serviceaccount\" not found", "stderr_lines": ["Error from server (NotFound): serviceaccounts \"ibm-cloud-databases-redis-operator-serviceaccount\" not found"], "stdout": "", "stdout_lines": []}[0m

    To approve the Redis operator installation, go to the Operators > Installed Operators page, and approve the Redis installation. The Redis operator is installed successfully then.

    You will still see the error that is mentioned earlier. RQA installation is continued when it runs reconciliation. When the reconciliation is completed, RQA is installed successfully.

What to do next

Verify the resources that are created.