IBM Watsonx.data

IBM® watsonx.data is a new open architecture lakehouse that combines the elements of the data warehouse and data lakes. For more information visit here

Overview

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

terraform-ibm-watsonx-data

This module supports provisioning the following:

• Provisioning watsonx.data instance with a selectable service plan

⚠️ Note: The module does not support the lite plan in the au-syd and ca-tor regions currently due to a known limitation with the Terraform provider.

Usage

module "watsonx_data" {
    source                = "terraform-ibm-modules/watsonx-data/ibm"
    version               = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
    watsonx_data_name     = "watsonx-data"
    region                = "us-south"
    watsonx_data_plan     = "lite"
    resource_group_id     = "xxXXxxXXxXxxXXXXX" # replace with ID of resource group
}

Required access policies

You need the following permissions to run this module.

• Account Management
  • Resource Group - Viewer role
• IAM Services
  • watsonx.data 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.79.0, < 2.0.0
time	>= 0.12.1

Modules

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

Resources

Name	Type
ibm_iam_authorization_policy.kms_policy	resource
ibm_resource_instance.data_instance	resource
ibm_resource_tag.watsonx_data_tag	resource
time_sleep.wait_for_kms_authorization_policy	resource
ibm_resource_instance.existing_data_instance	data source

Inputs

Name	Description	Type	Default	Required
access_tags	A list of access tags to apply to the watsonx.data instance created by the module. Learn more.	list(string)	[]	no
enable_kms_encryption	Flag to enable key management service encryption when the configured plan is 'Enterprise (lakehouse-enterprise)' and the deployment region is not 'au-syd' and 'cat-tor'.	bool	false	no
existing_watsonx_data_instance_crn	The CRN of an existing watsonx.data instance. If not provided, a new instance is provisioned.	string	null	no
plan	The plan required to provision the watsonx.data instance. Possible values are: Lite and Enterprise. The Lite plan is available in the eu-de, jp-tok, and eu-gb regions. The Enterprise plan is available in the eu-de, us-east, us-south, jp-tok, eu-gb, au-syd, and ca-tor regions. Learn more	string	"lite"	no
region	Region where the watsonx.data instance is provisioned.	string	"eu-de"	no
resource_group_id	The ID of the resource group that contains the watsonx.data instance. Required to create an instance of watsonx.data.	string	null	no
resource_tags	Optional list of tags to describe the watsonx.data instance created by the module.	list(string)	[]	no
skip_iam_authorization_policy	Whether to create an IAM authorization policy that permits the watsonx.data instance to read the encryption key from the key management service instance. Set to true to avoid creating the policy.	bool	false	no
use_case	The Lite plan instance can be provisioned based on the three use cases - Generative AI, Data Engineering and High Performance BI. Allowed values are ai, workloads, and performance. Learn more.	string	"workloads"	no
watsonx_data_kms_key_crn	The CRN of the key management service key used to encrypt the watsonx.data instance.	string	null	no
watsonx_data_name	The name of your watsonx.data instance. Required to create an instance of watsonx.data.	string	null	no

Outputs

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