Terraform IBM Watsonx Assistant

The IBM watsonx Assistant Terraform module is designed to automate the deployment and configuration of the IBM watsonx Assistant, a next-generation conversational AI solution.

For further information on IBM watsonx Assistant, including supported features, plans, and regions, please refer the official watsonx Assistant documentation

Overview

• terraform-ibm-watsonx-assistant
• Examples
  • Basic example
  • Existing instance example
• Contributing

terraform-ibm-watsonx-assistant

This module supports provisioning the watsonx Assistant instance with a selectable service plan.

Usage

module "watsonx_assistant" {
  source                    = "terraform-ibm-modules/watsonx-assistant/ibm"
  region                    = "us-south"
  watsonx_assistant_name    = "example-wx-assistant-basic"
  plan                      = "plus-trial"
  resource_group_id         = "a8c...8230a" # replace with ID of resource group
}

Required IAM access policies

You need the following permissions to run this module:

• Account Management
  • Resource Group - Viewer role
• IAM Services
  • watsonx Assistant service - Editor platform access

To attach access management tags to resources in this module, you need the following permissions.

• IAM Services
  • Tagging service
    • Administrator platform access

Requirements

Name	Version
terraform	>= 1.9.0
ibm	>= 1.70.1, < 2.0.0

Modules

Name	Source	Version
crn_parser	terraform-ibm-modules/common-utilities/ibm//modules/crn-parser	1.1.0

Resources

Name	Type
ibm_resource_instance.watsonx_assistant_instance	resource
ibm_resource_tag.watsonx_assistant_tag	resource
ibm_resource_instance.existing_assistant_instance	data source

Inputs

Name	Description	Type	Default	Required
access_tags	A list of access tags to apply to the watsonx Assistant instance. For more information, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial.	list(string)	[]	no
existing_watsonx_assistant_instance_crn	The CRN of an existing watsonx Assistant instance.If not provided, a new instance will be provisioned.	string	null	no
plan	The plan that is required to provision the watsonx Assistant instance. Possible values are: plus-trial, free, plus, enterprise. For 'plus-trial' and 'free' plans, the service_endpoints value is ignored and the default service configuration is applied.	string	"plus-trial"	no
region	Region where the watsonx Assistant instance will be provisioned. Required if creating a new instance.	string	"us-south"	no
resource_group_id	The resource group ID where the watsonx Assistant instance will be grouped. Required when creating a new instance.	string	null	no
resource_tags	Optional list of tags to describe the watsonx Assistant instance created by the module.	list(string)	[]	no
service_endpoints	Types of the service endpoints that can be set to a watsonx Assistant instance. Possible values are : public, private or public-and-private. For 'plus-trial' and 'free plans', the value is ignored and the default service configuration is applied.	string	"public-and-private"	no
watsonx_assistant_name	The name of the watsonx Assistant instance. Required if creating a new instance.	string	null	no

Outputs

Name	Description
account_id	Account ID of the watsonx Assistant instance.
crn	The CRN of the watsonx Assistant instance.
dashboard_url	The dashboard URL of the watsonx Assistant instance.
guid	The GUID of the watsonx Assistant instance.
id	ID of the watsonx Assistant instance.
name	The name of the watsonx Assistant instance.
plan_id	The plan ID of the watsonx Assistant instance.

Contributing

You can report issues and request features for this module in GitHub issues in the module repo. See Report an issue or request a feature.

To set up your local development environment, see Local development setup in the project documentation.