Catalog management module

Automation to manage an IBM Cloud catalog.

Overview

• terraform-ibm-catalog-management
• Submodules
  • vpe-catalog-object
• Examples
  • Offering catalog example
  • VPE object example
• Contributing

terraform-ibm-catalog-management

Usage

terraform {
  required_version = ">= 1.9.0"
  required_providers {
    ibm = {
      source  = "IBM-Cloud/ibm"
      version = "X.Y.Z"  # Lock into a provider version that satisfies the module constraints
    }
  }
}

provider "ibm" {
  ibmcloud_api_key = "XXXXXXXXXX"  # replace with apikey value
}

module "catalog" {
  source            = "terraform-ibm-modules/catalog-management/ibm"
  version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
  label             = "My catalog"
  kind              = "offering"
  resource_group_id = "xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX" # Replace with the actual ID of resource group to use
}

Required access policies

You need the following permissions to run this module:

• Service
  • Resource group only
    • Viewer access on the specific resource group
  • Catalog Management service
    • Editor platform access

Requirements

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

Modules

No modules.

Resources

Name	Type
ibm_cm_catalog.cm_catalog	resource

Inputs

Name	Description	Type	Default	Required
catalog_banner_url	URL for a banner image for this catalog.	string	null	no
catalog_icon_url	URL for an icon associated with this catalog.	string	null	no
disabled	Denotes whether a catalog is disabled.	bool	false	no
kind	Kind of catalog. Supported kinds are 'offering' and 'vpe'.	string	"offering"	no
label	Display name for the catalog.	string	n/a	yes
resource_group_id	Resource group id the catalog is owned by.	string	n/a	yes
short_description	A description of the catalog.	string	null	no
tags	List of tags associated with this catalog.	list(string)	[]	no
target_accounts	List of target accounts to add to this catalog. Can only be configured on an update, not on a create.	list(object({ api_key = optional(string) name = string label = string project_id = optional(string) trusted_profile_id = optional(string) target_service_id = optional(string) }))	[]	no

Outputs

Name	Description
catalog_banner_url	The url of the catalog banner.
catalog_icon_url	The url of the catalog icon.
crn	CRN associated with the catalog.
id	The unique identifier of the catalog.
label	Display Name.
resource_group_id	Resource group id the catalog is owned by.

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.