Validating prerequisites for RQA operator installation

The OpenShift® administrator must complete the validation check before the RQA operator is installed on the OpenShift cluster.

Procedure

  1. Validating RQA client registration with Jazz® Authorization Server
  2. Validating RQA license enablement

Validating RQA client registration with Jazz Authorization Server

The OpenShift administrator must complete the following steps to make sure that the OIDC URI, and redirect URIs for CLMNLU and RQA administrator dashboard are correct. The shell script is used to validate the same.

Before you begin

Install Git bash and JQ on your system.

Procedure

  1. Refer to the Validating CouchDB operator installation by running the shell script topic, and complete steps 1 to 4.
  2. Run the chmod 755 rqa_client_register.sh command.
  3. Complete the following steps to validate the OIDC URI:
    1. Run the./ rqa_client_register.sh command.
      The following message is shown:
      Validating RQA as a client registration with Jas authorization server ...
      Please provide OIDC URL:
      Example: https://jas.my.company.com:9643/oidc/endpoint/jazzop/.well-known/openid-configuration
    2. Paste the OIDC URL, and press Enter.
    3. Enter your Jazz Authorization Server JAS client ID, and press Enter.
    4. Enter your admin user ID, and press Enter.
    5. Enter your password, and press Enter.
      The following message is shown:
      Success!
      The validation for the registration client URI is successful.
      Provide the redirect URI for the RQA administrator dashboard:
      Format: https://<your RQA instance name>-admindash-route-<OpenShift project name where RQA will be deployed>.<domain name>
      Example: https://rqa-admindash-route-projectname.apps.clusteraddress.xyz.com
    Attention:

    Make sure that you provide correct OIDC URI. If you provide an incorrect URI, the following message is shown, and the script exits. Also, you need to complete steps 3.a to 3.e again to validate the OIDC URI.

    The registration client URI validation is not successful.
    Try again by providing the correct registration client URI, user ID, and password.

  4. Complete the following steps to validate the RQA administrator dashboard service redirect URI:
    1. Paste the RQA administrator dashboard service redirect URI, and press Enter. See the format and example of the URI that is provided in the earlier step.
      The following message is shown:
      Success!
      Validation successful for RQA administrator dashboard service redirect URI.
      Provide the redirect URI for the RQA CLMNLU:
      Format: https://<your RQA instance name>-clmnlu-route-<OpenShift project name where RQA will be deployed>.<domain name>
      Example: https://rqa-clmnlu-route-projectname.apps.clusteraddress.xyz.com
    Attention:

    Make sure that you provide the correct OIDC URI. If you provide an incorrect URI, the following message is shown, and the script exits. Also, you need to complete steps 3.a to 3.e again to validate the RQA administrator dashboard service redirect URI.

    The registration client URI validation is not successful.
    Try again by providing the correct registration client URI, user ID, and password.

  5. Complete the following step to validate the RQA CLMNLU service redirect URI:
    1. Paste the CLMNLU redirect URI and press Enter. See the format and example of the URI that is provided in the earlier step.

Results

The following message is shown:Success!
Validation successful for RQA CLMNLU service redirect URI.
Attention:

Make sure that you provide correct CLMNLU redirect URI. If you provide an incorrect URI, the following message is shown, and the script exits. Also, you need to complete steps 3.a to 5 again to validate the CLMNLU redirect URI.

The registration client URI validation is not successful.
Try again by providing the correct registration client URI, user ID, and password.

Validating RQA license enablement

About this task

The IBM Common Licensing Server configuration is done as part of RQA installation prerequisites. Also, the license file for RQA is imported as one of the prerequisite steps. The OpenShift administrator must verify that RQA is shown in the list of products that are supported by IBM Common Licensing. Also, the OpenShift administrator must make sure that the IBM Rational® License Key Server service is running.

Procedure

  1. Open the IBM Common Licensing application.
  2. Verify that RQA is shown in the list of products that are supported by IBM Common Licensing.
  3. Go to Services and verify that the status of the IBM Common Licensing is shown as Running.

What to do next

Register RQA as a client in Jazz Authorization Server.