Setting up your watsonx Code Assistant service in IBM Cloud

watsonx Code Assistant

Set up your service instance of watsonx Code Assistant.

Provision the service instance

To get started, you need to create your own service instance of watsonx Code Assistant for you or your organization.

To provision a service instance:

Open the IBM Cloud catalog
Use the catalog to provision a service instance of watsonx Code Assistant.
When you finish provisioning your instance, click Setup to open an onboarding checklist page to help you with configuration. Or, you can select Administration, and then Setup to access this onboarding checklist.

Items in the onboarding 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.

The setup steps are different depending on how you're going to use the service instance.

Installation types
Type	Description
Organizational users	Multiple developers
Single user	One developer

Create an access group

Organizational users

Create an access group where you can add your developers.

Open the Access groups page in Cloud Identity and Access Management.
Click Create.
Enter a name for your access group, for example wca-instance-access, and then click Create.
In your new access group, click the Access tab.
Click Assign access to start a policy.
For Service, select IBM watsonx Code Assistant, then click Next.
For Resources, select Specific resources.
Select the resource group where you created your instance, then click Next.
For Resource Group Access, select Viewer, then click Next.
For Roles and actions, select Viewer.
Conditions aren't required, so click Add.
In the Access summary, click Assign.

Create a deployment space

Single user Organizational users

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

Open your watsonx Code Assistant service instance.
Click the Navigation Menu icon , then select Deployments.
Click New deployment space.
Enter Code Assistant as the name for your deployment space. Optionally, enter a description.
In Code assistant service, select your instance name.

The following example displays the Select services page. For the Code assistant service option on the page, Select a code assistant service is expanded and the user is selecting the IBM watsonx Code Assistant-9h instance from the expanded list.

Code assistant service
Click Create.
A status window appears. After the space is created, click Close.

Add the access group to the deployment space

Organizational users

Add your new access group to the deployment space.

In your watsonx Code Assistant instance, click the Navigation Menu icon , then select Deployments.
Open the deployment space for your service instance.
On the Manage tab of your deployment space, click Access control.
Click Add collaborators and select Add access groups from the menu.
Select your new access group.
For Role, select Editor, then click Add.

Select your license preferences for code suggestions

Single user Organizational users

Watsonx Code Assistant checks whether a generated code suggestion is similar to other code sources. By default, the code suggestion includes a reference to the similar code source and its license.

You can set how code suggestions are displayed in the IDE. For more information, see Configuring how code suggestions are displayed.

Add developers to your access group

Organizational users

Use Cloud Identity and Access Management to add developers to your access group.

Open the Access groups page in Cloud Identity and Access Management.
Select the access group that you created.
On the Users tab, click Add.
Select the members of your IBM Cloud account who should get access to watsonx Code Assistant.
Click Add.

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/

Instruct developers to add an IDE extension or plug-in

Organizational users

Developers need to add the watsonx Code Assistant Microsoft Visual Studio Code extension or the Eclipse IDE plug-in.

For the instructions, see Installing the IDE extension or plug-in.

Copy this link to send the instructions to your developers:

https://cloud.ibm.com/docs/watsonx-code-assistant?topic=watsonx-code-assistant-cloud-setup-wca-extensions