Chapter 4. Setting up Red Hat Ansible Lightspeed for your organization

Procedure

1. Log in to the Ansible Lightspeed portal as an organization administrator.
2. Click Log in Log in with Red Hat.

3. Enter your Red Hat account username and password. The Ansible Lightspeed Service uses Red Hat Single Sign-On (RH-SSO) for authentication.

   As part of the authentication process, the Ansible Lightspeed Service checks whether your organization has an active Ansible Automation Platform subscription. On successful authentication, the login screen is displayed along with your username and your assigned user role.

4. From the login screen, click Admin Portal.

   You are redirected to the Red Hat Ansible Lightspeed with IBM watsonx Code Assistant administrator portal where you can connect Red Hat Ansible Lightspeed to your IBM watsonx Code Assistant instance.

Procedure

1. Log in to the Ansible Lightspeed portal as an organization administrator.
2. From the login screen, click Admin Portal.

3. Specify the API key of your IBM watsonx Code Assistant instance:

   1. Under IBM Cloud API Key, click Add API key. A screen to enter the API Key is displayed.
   2. Enter the API Key.
   3. Optional: Click Test to validate the API key.
   4. Click Save.

4. Specify the model ID of the model that you want to use:

   1. Click Model Settings.
   2. Under Model ID, click Add Model ID. A screen to enter the Model Id is displayed.
   3. Enter the Model ID that you obtained in the previous procedure as the default model for your organization.
   4. Optional: Click Test model ID to validate the model ID.

   5. Click Save.

      When the API key and model ID is successfully validated, Red Hat Ansible Lightspeed is connected to your IBM watsonx Code Assistant instance.

Procedure

1. Log in to the Red Hat OpenShift Container Platform as an administrator.

2. Create a namespace:

   1. Go to Administration Namespaces.
   2. Click Create Namespace.
   3. Enter a unique name for the namespace.
   4. Click Create.

3. Install the operator:

   1. Go to Operators OperatorHub.
   2. Select the namespace where you want to install the Red Hat Ansible Automation Platform operator.
   3. Search for the Ansible Automation Platform operator.
   4. From the search results, select the Ansible Automation Platform (provided by Red Hat) tile.
   5. Select an Update Channel. You can select either stable-2.x or stable-2.x-cluster-scoped as the channel.
   6. Select the destination namespace if you selected “stable-2.x” as the update channel.
   7. Select Install. It takes a few minutes for the operator to be installed.
4. Click View Operator to see the details of your newly installed Red Hat Ansible Automation Platform operator.

Procedure

1. Go to the Red Hat OpenShift Container Platform.
2. Select Workloads Secrets.
3. Click Create Key/value secret.
4. From the Projects list, select the namespace that you created when you installed the Red Hat Ansible Automation Platform operator.
5. Click Create Key/value secret.
6. In Secret name, enter a unique name for the secret. For example, model-aiconnect.

7. Add the following keys and their associated values individually:

   Expand

   Key	Value
   username	For on-premise deployment only Enter the username you use to connect to an IBM Cloud Pak for Data deployment.
   model_type	Enter one of the following values per your IBM watsonx Code Assistant model: For on-premise deployment (IBM Cloud Pak for Data): wca-onprem For cloud deployment (IBM Cloud): wca
   model_url	Enter the URL of the IBM watsonx Code Assistant model. For cloud deployment, the model URL could be https://api.dataplatform.cloud.ibm.com.
   model_api_key	Enter the API key of your IBM watsonx Code Assistant model that was generated during the model installation.
   model_id	Enter the ID of your IBM watsonx Code Assistant model.
   model_verify_ssl	Optional, and supported on Ansible Automation Platform 2.5 and later This key controls whether the SSL certificate of the IBM watsonx Code Assistant model is verified. Default = true
   model_enable_anonymization	Optional and supported on Ansible Automation Platform 2.5.250730 and later This key controls whether the anonymization of Personally Identifiable Information (PII) is enabled. PII information includes passwords, IP addresses, email addresses, and other sensitive data. When is enabled, users' personal information is modified to some generic values to protect their data and reduce the risk of data leaks. You can turn off anonymization by setting the value to false to retain all original information entered by users and improve the quality of the answers. Disabling anonymization for Ansible Lightspeed hybrid deployments (the model is in IBM watsonx Code Assistant on IBM Cloud) results in users' PII being sent to IBM Cloud. Default = true

   Show more
   Important

   Ensure that you do not accidentally add any whitespace characters (extra line, space, and so on) to the value fields. If there are any extra or erroneous characters in the secret, the connection to IBM watsonx Code Assistant fails.

8. Click Create.

   After you create the model configuration secret, you must update the YAML file of the Ansible Automation Platform operator.

Procedure

1. Go to the Red Hat OpenShift Container Platform.
2. Select Operators Installed Operators.
3. From the list of installed operators, select the Ansible Automation Platform operator.
4. Locate and select the Ansible Automation Platform custom resource, and then click the required app.
5. Select the YAML tab.

6. Scroll the text to find the Lightspeed category, and add the following details under the spec: section:

   spec:
     lightspeed:
       disabled: false
       model_config_secret_name: <Name of the model configuration secret that you recently created.>

7. Click Save. The Ansible Lightspeed service takes a few minutes to set up.

Procedure

1. Obtain the URL of your Ansible Lightspeed instance:

   1. In Red Hat OpenShift Container Platform, select Networking Routes and locate the Red Hat Ansible Lightspeed instance that was created.

   2. From the Location column, copy the URL of your Ansible Lightspeed instance.

      The URL will be in the following format: https://<lightspeed_route>/complete/aap/

2. Open the VS Code application.
3. From the Activity bar, click the Extensions icon.
4. From the Installed Extensions list, select Ansible.
5. From the Ansible extension page, click the Settings icon ( ) and select Extension Settings.

6. Select Ansible Lightspeed settings and specify the following information:

   • In the URL for Ansible Lightspeed field, enter the Route URL of the Red Hat Ansible Lightspeed on-premise deployment. Ansible users must have Ansible Automation Platform controller credentials.

     After configuring Ansible VS Code extension to connect to Red Hat Ansible Lightspeed on-premise deployment, you must log in to Ansible Lightspeed through the Ansible VS Code extension.

     Note

     If your organization recently subscribed to the Red Hat Ansible Automation Platform, it might take a few hours for Red Hat Ansible Lightspeed to detect the new subscription. In VS Code, use the Refresh button in the Ansible extension from the Activity bar to check again.

Procedure

1. Go to the Red Hat OpenShift Container Platform.
2. Select Operators Installed Operators.
3. From the list of installed operators, select the Ansible Automation Platform operator.
4. Locate and select the Ansible Automation Platform custom resource, and then click the required app.
5. Select the YAML tab.

6. Scroll the text to find the spec section under Lightspeed category. For example:

   spec:
     lightspeed:
       disabled: false
       model_config_secret_name: <Name of the model configuration secret that you recently created.>

7. Replace the model_config_secret_name value with the name of the IBM watsonx Code Assistant that you want to connect to.

8. Click Save.

   The new Ansible Lightspeed pods are created. After the new pods are running successfully, the old Ansible Lightspeed pods are terminated.

Procedure

1. Create a system auditor user:

   1. Create a user with a system auditor role in the Red Hat Ansible Automation Platform. For the procedure, see the Creating a user section of Getting started with Ansible Automation Platform.
   2. Verify that you can log in to the Ansible Lightspeed portal for on-premise deployment (https://<lightspeed_route>/) as the newly-created system auditor user, and then log out.

2. Create a token for the system auditor user:

   1. Log in to the Ansible Lightspeed portal for on-premise deployment (https://<lightspeed_route>/admin) as an administrator by using the following credentials:

      • Username: admin
      • Password: The secret that is named as <lightspeed-custom-resource-name>-admin-password in the Red Hat OpenShift Container Platform cluster namespace where Red Hat Ansible Lightspeed is deployed.
   2. On the Django administration window, select Users from the Users area. A list of users is displayed.
   3. Verify that the user with the system auditor role is listed in the Users list.
   4. From the Django Oauth toolkit area, select Access tokens Add.

   5. Provide the following information and click Save:

      • User: Use the magnifying glass icon to search and select the user with the system auditor role.
      • Token: Specify a token for the user. Copy this token for later use.
      • Id token: Select the token ID.
      • Application: Select Ansible Lightspeed for VS Code.
      • Expires: Select the date and time when you want the token to expire.

      • Scope: Specify the scope as read write.

        An access token is created for the user with a system auditor role.

   6. Log out from the Ansible Lightspeed portal for on-premise deployment.
3. Monitor your Red Hat Ansible Lightspeed on-premise deployment, by using the authorization token of the user with the system auditor role, to access the metrics endpoint https://<lightspeed_route>/metrics.

Procedure

1. Select the platform user for whom you want to grant REST API access.

   You can select an existing user or create a platform user in the Red Hat Ansible Automation Platform. For the procedure, see the Creating a user section of Getting started with Ansible Automation Platform.

2. Verify that you can log in to the Ansible Lightspeed portal for on-premise deployment (https://<lightspeed_route>/) as the platform user you selected or created, and then log out.

3. Create a token for the platform user:

   1. Log in to the Ansible Lightspeed portal for on-premise deployment (https://<lightspeed_route>/admin) as an administrator by using the following credentials:

      • Username: admin
      • Password: The secret that is named as <lightspeed-custom-resource-name>-admin-password in the Red Hat OpenShift Container Platform cluster namespace where Red Hat Ansible Lightspeed is deployed.
   2. On the Django administration window, select Users from the Users area. A list of users is displayed.
   3. Verify that the platform user is listed in the Users list.
   4. From the Django Oauth toolkit area, select Access tokens Add.

   5. Provide the following information and click Save:

      • User: Use the magnifying glass icon to search and select the newly-created or existing user for whom you want to grant API access.
      • Token: Specify a token for the user. Copy this token for later use.
      • Id token: Select the token ID.
      • Application: Select Ansible Lightspeed for VS Code.
      • Expires: Select the date and time when you want the token to expire.

      • Scope: Specify the scope as read write.

        An access token is created for the user.

   6. Log out from the Ansible Lightspeed portal for on-premise deployment.

4. Make a direct call to the Ansible Lightspeed REST API by specifying the newly-created token in the authorization header:

   curl -H "Authorization: Bearer <token>"
   https://<lightspeed_route>/api/v1/me/