Skip to content

Latest commit

 

History

History
129 lines (71 loc) · 6.21 KB

cloud-setup-a.md

File metadata and controls

129 lines (71 loc) · 6.21 KB
Raw
copyright lastupdated keywords subcollection
years
2023, 2024
2024-11-01
watsonx-code-assistant

{{site.data.keyword.attribute-definition-list}}

Setting up your {{site.data.keyword.wcaal_short}} service in {{site.data.keyword.cloud_notm}}

{: #cloud-setup-a}

[Red Hat Ansible Lightspeed]{: tag-red}

Set up your {{site.data.keyword.cloud_notm}} service instance of {{site.data.keyword.wcaal_short}} so you can use it with your full installation of Red Hat Ansible Lightspeed. {: shortdesc}

Before you begin

{: #prereqs-a}

When you finish provisioning your instance, click Setup to open an onboarding checklist page to help you configure the instance. Or, you can select Administration and then Setup to access this onboarding checklist.

Items in that checklist correspond to each of the following steps. Click the action arrows on the checklist page that are associated with each item to complete the steps.

Create a service ID and API key

{: #sid_apikey}

You use this API key later to enable Visual Studio Code to communicate with {{site.data.keyword.wca_short}}.

  1. On the Service IDs{: external} page, click Create.

  2. Enter {{site.data.keyword.wca_full_notm}} user as the name for your service ID. Optionally, enter a description.

  3. Click Create.

    You are redirected to the dashboard for your service ID, which includes tabs for Access and API keys.

  4. Click the API keys tab.

  5. Click Create.

  6. Enter {{site.data.keyword.wca_full_notm}} API key as the name for your API key. Optionally, enter a description.

  7. Click Create.

  8. Click Download or Copy and store the API key in a safe location.

    The key is only available for 296 seconds. Make sure to store it somewhere you can find it later. {: important}

Create a deployment space and model ID

{: #deploy_space-a}

The deployment space is the serving environment for {{site.data.keyword.wca_short}}. The model ID determines which model generates code recommendations in the Ansible extension for Visual Studio Code.

  1. In your {{site.data.keyword.wca_short}} instance, click the Navigation Menu icon Navigation Menu, then select Deployments.

  2. Click New deployment space.

  3. Enter Code Assistant Models as the name for your deployment space. Optionally, enter a description.

  4. In Code assistant service, select your instance name.

  5. Click Create.

  6. A status window appears. After the space is created, click Close.

  7. Copy your model ID. After you create the deployment space, your model ID is provided in a field after the Create a deployment space checklist item. Copy this ID and store it in a safe location as you need to add it to the Red Hat Ansible Lightspeed Admin portal in a later step.

Add the service ID to the deployment space

{: #space_collab}

Enable the API to connect to your deployment space.

  1. On the Manage tab of your deployment space, click Access control.

  2. Click Add collaborators and select Add service IDs from the menu.

    A list of service IDs that are associated with your account appears.

  3. Click the checkbox for the {{site.data.keyword.wca_full_notm}} user service ID that you created, and select Editor for the role.

  4. Click Add.

    The service ID is added to the list of collaborators.

Configure Red Hat Ansible Lightspeed to connect with {{site.data.keyword.wca_short}}

{: #rh-admin}

Add the API key and the model ID to the Red Hat Ansible Lightspeed Admin Portal to connect {{site.data.keyword.wca_short}} with the Ansible extension for Visual Studio Code. Follow the onboarding checklist and the instructions from Red Hat.

To add the API key and model ID to the Red Hat Ansible Lightspeed Admin Portal, see Configuring Red Hat Ansible Lightspeed cloud service{: external} in the Red Hat documentation.

Add the instance to a project

{: #create-project}

[Standard plan]{: tag-purple}

If you purchased a Standard plan, you can tune the IBM base code model with your own data so that it generates code suggestions that are customized for your organizational context. All your assets are stored in a project, including your uploaded data and tuned models. After you create a project, you can work with data and other resources to tune models.

  1. In your {{site.data.keyword.wca_short}} instance, click the Navigation Menu icon Navigation Menu, then select Projects.

  2. Click New project.

  3. Enter a meaningful name and description for your project so you can easily identify it.

  4. Click Create.

  5. In the new project, click the Manage tab, then select Services & integrations.

  6. Click Associate service.

  7. Select your instance, then click Associate.

You're now ready to create a tuning experiment to tune the IBM base code model with your own data. For more information, see Tuning the IBM base code model for {{site.data.keyword.wcaal_short}}.

Next steps

{: #next_steps}

See Installing and configuring the Ansible VS Code extension{: external} to install and configure the Ansible extension for Visual Studio Code and start generating code recommendations.