README.md

Terraform modules template project

TODO: Replace this with a description of the modules in this repo.

Overview

• terraform-ibm-module-template
• Examples
  • Advanced example
  • Basic example
• Contributing

terraform-ibm-module-template

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
    }
  }
}

locals {
    region = "us-south"
}

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

module "module_template" {
  source            = "terraform-ibm-modules/<replace>/ibm"
  version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
  region            = local.region
  name              = "instance-name"
  resource_group_id = "xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX" # Replace with the actual ID of resource group to use
}

Required access policies

Requirements

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

Modules

No modules.

Resources

Name	Type
ibm_resource_instance.cos_instance	resource

Inputs

Name	Description	Type	Default	Required
name	A descriptive name used to identify the resource instance.	string	n/a	yes
plan	The name of the plan type supported by service.	string	"standard"	no
resource_group_id	The ID of the resource group where you want to create the service.	string	n/a	yes
resource_tags	List of resource tag to associate with the instance.	list(string)	[]	no

Outputs

Name	Description
account_id	An alpha-numeric value identifying the account ID.
crn	The CRN of the resource instance.
guid	The GUID of the resource instance.
id	The unique identifier of the resource 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.