Red Hat Ansible Lightspeed with IBM watsonx Code Assistant User Guide

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 PII anonymization 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 the anonymization by specifying the value as false if you want to retain all original information as entered by users and improve the quality of the answers. If you set the value to false and the Ansible administrator is using Ansible Lightspeed in hybrid mode (where the model is in IBM watsonx Code Assistant in IBM Cloud) then their users' PII is 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.>

   Copy to Clipboard Toggle word wrap
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.

   • Optional: If you want to use a custom model instead of the default model, in the Model ID Override field, enter the custom model ID. Your settings are automatically saved in VS Code.

     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.>

   Copy to Clipboard Toggle word wrap
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/

   Copy to Clipboard Toggle word wrap

Procedure

1. Go to the Ansible Lightspeed portal login page.
2. Click Log in → Log in with Red Hat.

3. Enter your Red Hat account username and password.

   On successful authentication, the login screen is displayed along with your username and your assigned user role.

Procedure

1. Open the VS Code application.
2. From the navigation menu, click the Extensions icon.
3. In the Search field, enter Ansible.
4. Select Ansible to choose the Ansible language support extension published by Red Hat.
5. Click Install.

6. After installation is complete, verify your VSCode installation:

   1. Create a new YAML file using the .yml or .yaml file extension.
   2. From the Status toolbar, click the language indicator and select Ansible to associate the Ansible language type with the new YAML file.
   3. Start writing a test playbook. Contextual aids are displayed as you start creating your content.

Procedure

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

5. Select Ansible Lightspeed settings, and specify the following information:

   1. Ensure that the Enable Ansible Lightspeed with watsonx Code Assistant inline suggestions checkbox is selected.
   2. In the URL for Ansible Lightspeed field, verify that you have the following URL: https://c.ai.ansible.redhat.com/.
   3. Select the Enable Ansible Lightspeed with watsonx Code Assistant inline suggestions checkbox.

6. Optional: If you want to use the custom model instead of the default model, in the Model ID Override field, enter the custom model ID. The model-override setting enables you to override the default model and use the custom model, after your organization administrator has created a custom model and has shared the model ID with you separately.

   Your settings are automatically saved in VS Code.

   The following illustration displays the configured settings for the Ansible VS Code extension:

   Figure 4.1. Configured settings for the Ansible VS Code extension

   

   View larger image

   
   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. Open the VS Code application.

2. Sign in using either the Connect button in the Ansible Lightspeed view or the Accounts menu.

   • Sign in using the Connect button:

     1. From the VS Code activity bar, click the Ansible icon.
     2. In the Ansible Lightspeed view, click Connect.
     3. Follow the on-screen prompts to sign in to Ansible Lightspeed.

   • Sign in using the Accounts menu:

     1. From the VS Code activity bar, click the Accounts menu.

     2. Sign in with Ansible Lightspeed to use Ansible or sign in with Red Hat to use Ansible, depending on the sign-in option you are presented with.

        Note
        • The sign-in options are displayed when the VS Code extension is in an active state. The extension is activated after you open the Ansible side panel or after you open an Ansible file in the VS Code editor. If you do not see this option, use the Connect button to link to the Ansible Lightspeed service.
        • If you are using a cloud development environment at a domain unknown by Ansible Lightspeed, such as on-premise Red Hat OpenShift Dev Spaces, your Accounts sign-in menu provides the option Sign-in with Red Hat to use Ansible. This option uses a device code flow to successfully complete the sign-in process and requires the Red Hat Authentication extension v0.2.0 or later. If you require this authentication flow but don’t see the Sign-in with Red Hat to use Ansible option, ensure you are using the Ansible VS Code extension v24.5.2 or later.
     3. Follow the on-screen prompts to sign in to Ansible Lightspeed.

   On successful authentication, the login screen is displayed along with your username and your assigned user role.

Procedure

1. Log in to VS Code with your Red Hat account.

2. Create a new YAML file or use an existing YAML file:

   • Create a YAML file:

     1. Select File → New Text File.
     2. From the lower right of the screen, click Plain Text, and in the language mode, select Ansible.
     3. Save the file as a YAML file format extension (.yml or .yaml).

   • Use an existing YAML file:

     1. On the bottom right of the screen, click the existing language mode, and in the language mode settings, select Ansible.

        Note

        If you do not see the language mode section in your VS Code editor, from the Command Palette, select Configure Language Mode → Ansible.

3. Verify that you see an entry for Lightspeed on the status bar at the lower right of VS Code.

   If Ansible is already selected as the desired language but the Lightspeed entry is not displayed, re-select Ansible as the language mode. The following illustration shows Lightspeed and Ansible entries on the VS Code status bar.

   Figure 4.2. Ansible and Lightspeed set as selected language mode

   

   View larger image

   

4. Optional: If you see an error message about missing Ansible lint, you can install the missing module or disable it. Perform any one of the following tasks:

   • Install Ansible lint: For installation information, see the Installing section of the Ansible Lint documentation.

   • Disable Ansible lint:

     1. From the Activity bar, click the Extensions icon .
     2. From the Installed extensions list, select Ansible.
     3. From the Ansible extension page, click the Settings icon and select Extension Settings.
     4. Clear the Ansible › Validation › Lint: Enabled checkbox.

5. Create a playbook or use an existing playbook.

   For more information, see the Getting started with playbooks guide.

6. In the playbook, provide the following information to request code recommendations for a single task:

   1. Add a new Ansible task by starting a new line with - name: at the correct indentation.
   2. Add a detailed natural language prompt in the task description after - name: on the same line. For example, you can specify the following single task prompt: - name: Install postgresql-server

   3. Press Enter directly after the task description. Keep the cursor at the same location in your file, and wait for the code recommendation results to populate.

      The Ansible Lightspeed service is engaged, and it starts generating code recommendations for a single task.

      Important

      Ansible Lightspeed service takes around 5 seconds per task to populate the code recommendations. If you are using a multitask prompt, the Ansible Lightspeed service takes a bit longer (number of tasks times 5 seconds) to populate the results. Do not move your cursor or press any key while the code recommendation is being generated. If you change the cursor location or press any key, Ansible VS Code extension cancels the request and the Ansible Lightspeed service does not process your request.

      When the Ansible Lightspeed service is engaged, a Lightspeed processing status indicator is displayed in the lower right of the screen to denote that your code recommendation is being generated.

      

7. View your code recommendations and ensure that the recommendations match your task intent.

   The following illustration shows the code recommendations generated by the Ansible Lightspeed service for the single task Install postgresql-server:

   

8. Accept or reject the code recommendations:

   • To accept a code recommendation, press Tab.

   • To reject a code recommendation, press Esc.

     Note

     If you reject a recommendation, you can modify the prompt and review the generated code recommendations once again to match your task intent.

9. On the ANSIBLE: LIGHTSPEED TRAINING MATCHES tab, view the content source matching results.

   The following illustration shows the training matches found in existing Ansible Galaxy content for the task prompt Install postgresql-server:

   

   View larger image

   
10. Click Save to save the code recommendation changes in your Ansible YAML file.

Procedure

1. Log in to VS Code with your Red Hat account.

2. Create a new YAML file or use an existing YAML file.

   • Create a YAML file:

     1. Select File → New Text File.
     2. From the lower right of the screen, click Plain Text, and in the language mode, select Ansible.
     3. Save the file as a YAML file format extension (.yml or .yaml).

   • Use an existing YAML file:

     1. On the bottom right of the screen, click the existing language mode, and in the language mode settings, select Ansible.

        Note

        If you do not see the language mode section in your VS Code editor, from the Command Palette, select Configure Language Mode → Ansible.

3. Verify that you see an entry for Lightspeed on the status bar at the lower right of VS Code.

   If Ansible is already selected as the desired language but the Lightspeed entry is not displayed, re-select Ansible as the language mode. The following illustration shows Lightspeed entry on the VS Code status bar.

   Figure 4.3. Ansible and Lightspeed set as selected language mode

   

   View larger image

   

4. Optional: If you see an error message about missing Ansible lint, you can install the missing module or disable it. Perform any one of the following tasks:

   • Install Ansible lint: For installation information, see the Installing section of the Ansible Lint documentation.

   • Disable Ansible lint:

     1. From the Activity bar, click the Extensions icon .
     2. From the Installed extensions list, select Ansible.
     3. From the Ansible extension page, click the Settings icon and select Extension Settings.
     4. Clear the Ansible › Validation › Lint: Enabled checkbox.

5. Create a playbook or use an existing playbook.

   For more information, see the Getting started with playbooks guide.

6. In the playbook, provide the following information to request multitask code recommendations:

   1. Start a new YAML file comment by entering a pound symbol (#) at the correct indentation.

   2. Add a detailed natural language prompt in a sequence, separating each task by using the ampersand symbol (&).

      Example of a multitask prompt

      # Install postgresql-server & run postgresql-setup command

      Copy to Clipboard Toggle word wrap

      For better readability, split your multitask inline prompts over multiple lines. To achieve this, end your current line with an ampersand symbol (&) and start the next line with the hash symbol (#).

      Example of a multitask prompt split over multiple lines

      # Create a keypair called lightspeed-keypair & create a vpc & create vpc_id var &
      # create a security group that allows SSH & create subnet with 10.0.1.0/24 cidr &
      # create an internet gateway & create a route table

      Copy to Clipboard Toggle word wrap

   3. Press Enter directly after the task description. Keep the cursor at the same location in your file, and wait for the code recommendation results to populate.

      The Ansible Lightspeed service is engaged, and it starts generating code recommendations for multiple tasks.

      Important

      Ansible Lightspeed service takes around 5 seconds per task to populate the code recommendations. If you are using a multitask prompt, the Ansible Lightspeed service takes a bit longer (number of tasks times 5 seconds) to populate the results. Do not move your cursor or press any key while the code recommendation is being generated. If you change the cursor location or press any key, Ansible VS Code extension cancels the request and the Ansible Lightspeed service does not process your request.

      When the Ansible Lightspeed service is engaged, a Lightspeed processing status indicator is displayed in the lower right of the screen to denote that your code recommendation is being generated.

      

7. Optional: If multitask code recommendations are not being generated, log out of VS Code and log in again using your Red Hat account.

8. View your code recommendations and ensure that the recommendations match your task intent.

   The following illustration shows the code recommendations generated by the Ansible Lightspeed service for the multitask prompt Install postgresql-server & run postgresql-setup command: :

   

9. Accept or reject the code recommendations:

   • To accept a code recommendation, press Tab.

   • To reject a code recommendation, press Esc.

     Note

     If you reject a recommendation, you can modify the prompt and review the generated code recommendations once again to match your task intent.

10. On the ANSIBLE: LIGHTSPEED TRAINING MATCHES tab, view the content source matching results.

    The following illustration shows the training matches found in existing Ansible Galaxy content for the task prompt multitask prompt Install postgresql-server & run postgresql-setup command:

    

    View larger image

    
11. Click Save to save the code recommendation changes in your Ansible YAML file.

Procedure

1. Log in to VS Code with your Red Hat account.
2. From the Activity bar, click the Ansible icon.

3. Under Ansible Creator, click Get started. The Ansible Content Creator page is displayed.

   The following illustration displays the Ansible Content Creator page:

   Figure 4.5. Settings to create Ansible playbooks

   

   View larger image

   
4. Select the Playbook with Ansible Lightspeed tile. The Create a playbook page is displayed.

5. In the What do you want the playbook to accomplish? field, enter the prompts to create a playbook and click Analyze.

   After a few seconds, the recommended steps for your playbook intent are displayed in the Review the suggested steps for your playbook and modify as needed field.

6. Perform one of the following tasks:

   • If the steps match your intent: Click Generate Playbook.
   • If any modifications are required: Click the editor and update the tasks or steps to suit your intent.
   • If the task suggestions do not match your intent: Click Back to change the original prompt and start over.
   • If you want to restore the original task suggestions: Click Reset and proceed to the next step.

7. After you verify the steps, click Generate playbook.

   It takes a few seconds for the playbook to generate, and The following playbook was generated for you field displays the newly generated playbook.

8. Click Open editor. The generated playbook opens as an untitled YAML file in the VS Code editor.
9. Save the untitled YAML file.

Procedure

1. Log in to VS Code with your Red Hat account.
2. Open an Ansible playbook YAML file in VS Code.

3. Use one of the following methods to view the playbook explanation:

   • From an active playbook YAML file:

     1. Place your cursor anywhere within the playbook file.
     2. Right-click and select Explain the playbook with Ansible Lightspeed.

   • From the Ansible panel:

     1. From the navigation menu, click the Ansible icon.

     2. Select Explain the current playbook.

        The playbook explanation is displayed on the right panel of the VS Code screen.

        The following illustration shows an example of a playbook explanation:

        Figure 4.6. Example of a playbook explanation

        

        View larger image

        

Procedure

1. Log in to VS Code with your Red Hat account.
2. From the Activity bar, click the Ansible icon.

3. Use one of the following methods to create a role:

   • From the Ansible panel:

     1. From the navigation menu, click the Ansible icon.
     2. Click Generate a role.
   • From the Command Palette:

   • From the Command Palette of the VS Code editor, click View → Command Palette, and then enter > Ansible Lightspeed: Role generation.

     The Create a role with Ansible Lightspeed page is displayed on the right panel of the VS Code screen.

4. From the Select the collection to create role in list, choose the collection where you want to create the role. You must have a collection inside your workspace to create a role.

   If you do not have a collection, you must create it by using one of the following methods:

   • By using the following command:

     ansible-creator init collection myns.mycollection my_directory

     After you run the command, open the new directory with VS Code.

   • By using the Ansible VS Code extension

     For more information, see the topic About content collections in the Getting started with Ansible Automation Platform guide.

5. In the Describe what you want to achieve in natural language field, enter the prompts to create a role and then click Analyze.

   After a few seconds, the recommended steps for your role intent are displayed in the Review the suggested steps for your role and modify as needed field.

6. Perform the following tasks:

   1. Review and optionally change the role name.
   2. Review the collection where the role will be created.

   3. Verify that the suggested steps match your intent and then click Continue.

      It takes a few seconds for the role to generate, and the newly generated role is displayed along with the list of files where the role was generated.

      Note
      • If you want to modify the steps: Click the editor field, update the prompts or steps to suit your intent, and then click Continue.
      • If the role suggestions do not match your intent: Click Back to change the original prompt and start over.
      • If you want to restore to the original suggested steps: Click Reset and then click Continue to proceed to the next step.
7. Click Save files. A list of files is displayed that includes the new role.
8. Click the files to open them in the VS Code editor directly.

Procedure

1. Log in to VS Code with your Red Hat account.
2. Open an Ansible role YAML file within the roles directory in VS Code.

3. Use one of the following methods to view the playbook explanation:

   • From an active role YAML file:

     1. Place your cursor anywhere within the playbook file.
     2. Right-click and select Explain the role with Ansible Lightspeed.

   • From the Ansible panel:

     1. From the navigation menu, click the Ansible icon.
     2. Select Explain the current playbook.

   • From the Command Palette:

     • From the Command Palette of the VS Code editor, enter Explain the role with Ansible Lightspeed.

       The role explanation is displayed on the right panel of the VS Code screen.

       The following illustration shows an example of a role explanation:

       Figure 4.7. Example of a role explanation

       

       View larger image

       

Procedure

1. Log in to the Ansible Lightspeed with IBM watsonx Code Assistant Hybrid Cloud Console as an organization administrator.

2. From the navigation panel, select Ansible Lightspeed > Admin Dashboard.

   The Admin dashboard displays a graphical representation of analytics telemetry data for the last 30 days by default.

3. Use the following filters to refine your telemetry data:

   • To view the telemetry data for a specific time period or for a custom date range, select the date range from the Quick Date Range list.
   • To view the telemetry data for a specific IBM watsonx Code Assistant model only, select the model ID from the Model Name list. By default, the Admin dashboard displays telemetry data for all models.

Procedure

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

4. To disable the Admin dashboard telemetry, select Operational telemetry data only.

   Note

   To re-enable the Admin dashboard telemetry, select Admin dashboard telemetry data.

5. Click Save.

1. Create a training data set by using the content parser tool
2. Create and deploy a custom model by using IBM watsonx Code Assistant
3. Configure Red Hat Ansible Lightspeed to use the custom model

Procedure

1. In GitHub, navigate to the repository that you want to scan.
2. Create a .yml configuration file named ansible-code-bot.yml in your repository .github folder. For example, .github/ansible-code-bot.yml.

3. In the configuration file, specify the scan schedule in the interval parameter. You can specify the interval parameter as daily, weekly, or monthly. For example:

   schedule:
     interval: daily

   Copy to Clipboard Toggle word wrap

4. Commit your changes.

   The Ansible code bot starts scanning your repository per the schedule you configured at 9 AM UTC time.

Procedure

1. Log in to the Ansible code bot dashboard.

   The Ansible code bot dashboard displays a list of your repositories where the code bot is installed, and indicates if the scan schedule is not set, or is set to manual or scheduled scan.

2. To view the history of your repository’s scans, click the Ellipsis icon ( ) beside the repository and select View scan history.

   The repository’s scan history is displayed along with the scan start time, scan status, type of scan (scheduled or manual), link to the pull request if it was created, and the log message if the scan failed.

3. To view your repository on GitHub, click the Ellipsis icon ( ) beside the repository and select View repository.

Procedure

1. Log in to the Ansible code bot dashboard.
2. Click Manage Code Bot on GitHub.
3. In GitHub, click your profile photo > Settings.
4. Under Integrations, click Applications.

5. From the Repository access area, perform one of the following tasks:

   • Add a new repository: From the Select repositories list, select the repository that you want to add. The newly-added repository is displayed on the Ansible code bot dashboard.
   • Remove an existing repository: From the Select repositories list, click the Cross icon beside the repository that you want to delete. The deleted repository details are no longer visible on the Ansible code bot dashboard.
6. Click Save.

1. Click Save.

2. Restart the automation controller pods to apply the revised YAML.

   Perform the following steps: .. From the Red Hat OpenShift Container Platform, select Workloads → Pods. .. Locate and select the Ansible Lightspeed pod that you updated. .. Click the Edit icon beside the pod and select Delete Pod.

   + The select pod gets deleted and a new pod gets created.

1. Open Visual Studio Code.
2. Navigate to File > Preferences > Settings.
3. Select Application → Proxy in the sidebar.

4. In the Http: Proxy field, add the following URLs to the proxy:

   • https://c.ai.ansible.redhat.com/
   • https://sso.redhat.com, if you are using RH-SSO to authenticate users.
5. In the http: Proxy Support drop down list, select Override.

6. Search for and select the following configuration keys:

   • Electron Fetch
   • System Certificates V2 if you are using your own Certificate Authority (CA).

1. Install the VS code extension Network Proxy Test.

2. Use the Network Proxy Test: Test Connection action to target the server and the endpoint using the parameter /check/status end-point.

   For example:

   https://c.ai.ansible.redhat.com/check/status/ to test the connection to Red Hat Ansible Lightspeed cloud service.