Terraform IBM Watsonx Orchestrate

The IBM watsonx Orchestrate Terraform module is designed to automate the deployment and configuration of the IBM watsonx Orchestrate, a multi-tenant and cloud-native solution that is deployed as a managed software as a service (SaaS) or that you can install on premises.For more information visit here

Overview

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

terraform-ibm-watsonx-orchestrate

Usage

provider "ibm" {
  ibmcloud_api_key = "XXXXXXXXXXXXXX" # pragma: allowlist secret
  region           = "us-south"
}

module "watsonx_orchestrate" {
  source = "terraform-ibm-modules/watsonx-orchestrate/ibm"
  version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific
  region                = "us-south"
  watsonx_orchestrate_name = "example-wx-orchestrate"
  watsonx_orchestrate_plan     = "standard"
  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 Orchestrate 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_orchestrate_instance	resource
ibm_resource_tag.watsonx_orchestrate_tag	resource
ibm_resource_instance.existing_orchestrate_instance	data source

Inputs

Name	Description	Type	Default	Required
access_tags	A list of access tags to apply to the watsonx Orchestrate instance. For more information, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial.	list(string)	[]	no
existing_watsonx_orchestrate_instance_crn	The CRN of an existing watsonx Orchestrate instance.If not provided, a new instance will be provisioned.	string	null	no
plan	The plan that is required to provision the watsonx Orchestrate instance. Possible values are: lite, essentials, standard.	string	"lite"	no
region	Region where the watsonx Orchestrate instance will be provisioned. Required if creating a new instance.	string	"us-south"	no
resource_group_id	The resource group ID where the watsonx Orchestrate instance will be grouped. Required when creating a new instance.	string	null	no
resource_tags	Optional list of tags to describe the watsonx Orchestrate instance created by the module.	list(string)	[]	no
watsonx_orchestrate_name	The name of the watsonx Orchestrate instance. Required if creating a new instance.	string	null	no

Outputs

Name	Description
account_id	Account ID of the watsonx Orchestrate instance.
crn	The CRN of the watsonx Orchestrate instance.
dashboard_url	The dashboard URL of the watsonx Orchestrate instance.
guid	The GUID of the watsonx Orchestrate instance.
id	ID of the watsonx Orchestrate instance.
name	The name of the watsonx Orchestrate instance.
plan_id	The plan ID of the watsonx Orchestrate 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.