IBM Cloud Docs
Setting up your watsonx Code Assistant for Z service in IBM Cloud

Setting up your watsonx Code Assistant for Z service in IBM Cloud

watsonx Code Assistant for Z

Set up your IBM Cloud service instance of watsonx Code Assistant for Z so you can use it with your full installation of the product.

Before you begin

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

Create a service ID that will be used to connect the deployment space to the watsonx Code Assistant service.

  1. On the Service IDs page, click Create.

  2. Enter IBM watsonx Code Assistant 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.

Create a deployment space

The deployment space is the serving environment for watsonx Code Assistant.

  1. In your watsonx Code Assistant instance, click the Navigation Menu Navigation Menu icon, then select Deployments.

  2. Click New deployment space.

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

  4. In Code assistant service, select your instance.

  5. Click Create.

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

Add the service ID as a space collaborator

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 IBM watsonx Code Assistant 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.

Generate an API key

You need an API key to get Visual Studio Code to communicate with watsonx Code Assistant.

  1. Navigate to the dashboard for your service ID. Find and click the API keys tab, then click Create.

  2. Enter IBM watsonx Code Assistant API key as the name for your API key. Optionally, enter a description. Click Create.

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

    The key is only available for 296 seconds after creation. Make sure to store it somewhere you can find it later.

For more information on adding users and managing access, see Managing IAM access for watsonx Code Assistant for Z.

Set up your network

To ensure that your developers can connect the IDE extension or plug-in, you need to allow access to IBM Cloud URLs. Make sure your organization's network allows access to:

  • https://iam.cloud.ibm.com/
  • https://api.dataplatform.cloud.ibm.com/

Next steps

You deployed and connected your IBM Cloud components to your provisioned watsonx Code Assistant instance. You're ready to take your next steps and integrate with your IBM Z Open Editor in Visual Studio Code. For information, see Set up a development environment.