Install and configure the Ansible VS Code extension

Red Hat Ansible Lightspeed with IBM watsonx Code Assistant integrates with the Ansible Visual Studio (VS) Code extension. When enabled, the extension automatically collects recommendations, usage telemetry, and Ansible YAML file state through automated events.

To access Red Hat Ansible Lightspeed, all Ansible users must install and configure the Ansible VS Code extension in their VS Code. The Ansible VS Code extension uses the Ansible-specific IBM watsonx Granite model configured in the Red Hat Ansible Lightspeed administrator portal as the default mode for all users in your organization.

Connectivity requirements
Copy link

To generate code recommendations, the Ansible Lightspeed service in Visual Studio (VS) Code editor requires access to the following outbound domain:

  • Red Hat Ansible Lightspeed with IBM watsonx Code Assistant, this is linked below.

The outbound connections are encrypted on TCP protocol port 443.

Install and configure the Ansible VS Code extension
Copy link

Red Hat Ansible Lightspeed with IBM watsonx Code Assistant integrates with the Ansible Visual Studio (VS) Code extension. When enabled, the extension automatically collects recommendations, usage telemetry, and Ansible YAML file state through automated events.

To access Red Hat Ansible Lightspeed, all Ansible users must install and configure the Ansible VS Code extension in their VS Code. The Ansible VS Code extension uses the Ansible-specific IBM watsonx Granite model configured in the Red Hat Ansible Lightspeed administrator portal as the default mode for all users in your organization.

Connectivity requirements
Copy link

To generate code recommendations, the Ansible Lightspeed service in Visual Studio (VS) Code editor requires access to the following outbound domain:

  • Red Hat Ansible Lightspeed with IBM watsonx Code Assistant, this is linked below.

The outbound connections are encrypted on TCP protocol port 443.

Install the Ansible VS Code extension
Copy link

Use the following procedure to install the Ansible Lightspeed extension in VS Code.

Before you begin
Copy link

  • VS Code version 1.70.1 or later.
Note

You can also install VScode derivatives, such as VScode Insider or VS Codium.

Procedure
Copy link

  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.

Configure the Ansible VS Code extension
Copy link

Configure third-party LLM providers, such as IBM watsonx Code Assistant or Google Gemini, within the Ansible VS Code extension.

Before you begin
Copy link

  • You have installed the Ansible VS Code extension v25.12.3.
  • You have obtained a valid API key for your chosen third-party LLM provider.

Procedure
Copy link

  1. Open the VS Code application.
  2. From the Activity bar, click the Extensions icon Extensions.
  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:
    Expand
    UI field Description

    Ansible Lightspeed: Enabled

    Select this checkbox to enable the Red Hat Ansible Lightspeed service.

    Ansible Lightspeed: Provider

    Select the active AI service for code generation.

    Choose the AI provider from the following options:

    • wca: (Default setting) Uses IBM watsonx Code Assistant as the AI provider.
    • google: Uses Google Gemini as the AI provider.

    Ansible Lightspeed: Model Name

    Specify the specific AI model version to use for code generation:

    • For IBM watsonx Code Assistant: (Required) The IBM watsonx Code Assistant model name or ID that you want to use for code generation.
    • For Google Gemini: (Optional) The system applies a recommended default model if left blank.

    Ansible Lightspeed: Api Key

    Specify the secret credential required to authenticate requests with third-party model providers.

    • For IBM watsonx Code Assistant: (Optional) This field is not used for the IBM WCA provider. IBM watsonx Code Assistant relies on a separate OAuth2 login flow via the Red Hat portal.
    • For Google Gemini: (Required) Paste your active Google Gemini API key into this field. This token authorizes the extension to send prompts to Google’s servers.

    Ansible Lightspeed: Api Endpoint

    Specify the destination URL for network requests sent by the Ansible VS Code extension.

    • For IBM watsonx Code Assistant: (Required) This field allows modification of the service URL for IBM watsonx Code Assistant connections. The default URL is https://c.ai.ansible.redhat.com.
    • For Google Gemini: (Not configurable) This setting is not configurable when using the Google provider. The extension automatically manages the correct endpoint URL for Google services internally.

    Ansible Lightspeed Suggestions: Enabled

    Toggle the automatic display of inline code completions within the Ansible VS Code editor. Inline suggestions are currently available for the IBM watsonx Code Assistant provider only.

    Ansible Lightspeed: Timeout

    Define the maximum duration the Ansible VS Code extension waits for a server response. The default timeout for API calls is 3000 milliseconds.

Results
Copy link

Your settings are automatically saved in VS Code.

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.

Log in to Ansible Lightspeed through the Ansible VS Code extension
Copy link

After installing and configuring the VS Code extension, you can log in to the Ansible Lightspeed service.

About this task
Copy link

Red Hat Ansible Lightspeed provides different sign-in methods depending on whether you are using the cloud service or the on-premise deployment.

  • Ansible Lightspeed on-premise deployments

    Users are authenticated using your Red Hat Ansible Automation Platform login.

    To sign in, you can use the Connect button in the Ansible Lightspeed view, or the Sign in with Ansible Lightspeed to use Ansible option in the Accounts menu. Once prompted in the browser, select Log in with Ansible Automation Platform, and log in with the authorization mechanism that your automation controller is configured with.

  • Ansible Lightspeed cloud service

    Users are authenticated using Red Hat Single Sign-On (RH-SSO).

    To sign in from VS Code, you can use the Connect button in the Ansible Lightspeed view, or the Sign in with Ansible Lightspeed to use Ansible option in the Accounts menu. Follow the on-screen prompts to log in and access the Ansible Lightspeed service using your RH-SSO.

    Note

    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.

Procedure
Copy link

  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 Red Hat Ansible Lightspeed.

Results
Copy link

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