feat: initial release (#2)

Author: Aayush-Abhyarthi

README.md

@@ -1,7 +1,7 @@
 # More info about this file at https://github.com/terraform-ibm-modules/common-pipeline-assets/blob/main/.github/workflows/terraform-test-pipeline.md#cra-config-yaml
 version: "v1"
 CRA_TARGETS:
-  - CRA_TARGET: "examples/basic" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
+  - CRA_TARGET: "examples/complete" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
     CRA_IGNORE_RULES_FILE: "cra-tf-validate-ignore-rules.json" # CRA Ignore file to use. If not provided, it checks the repo root directory for `cra-tf-validate-ignore-rules.json`
     # CRA_ENVIRONMENT_VARIABLES:  # An optional map of environment variables for CRA, where the key is the variable name and value is the value. Useful for providing TF_VARs.
     #   TF_VAR_sample: "sample value"

cra-config.yaml

@@ -1,3 +1,10 @@
 {
-    "scc_rules": []
-}
+    "scc_rules": [
+      {
+        "scc_rule_id": "rule-216e2449-27d7-4afc-929a-b66e196a9cf9",
+        "description": "Check whether Flow Logs for VPC are enabled",
+        "ignore_reason": "This rule is not relevant to the module itself, just the VPC resource is used in the example that is scanned",
+        "is_valid": false
+      }
+    ]
+  }

cra-tf-validate-ignore-rules.json

@@ -1,8 +1,5 @@
 # Basic example
 
-<!-- There is a pre-commit hook that will take the title of each example add include it in the repos main README.md  -->
-<!-- The text below should describe exactly what resources are provisioned / configured by the example  -->
-
-An end-to-end basic example that will provision the following:
-- A new resource group if one is not passed in.
-- A new Cloud Object Storage instance.
+This example uses the IBM Cloud terraform provider to:
+ - Create a new resource group if one is not passed in.
+ - Create a new RabbitMQ instance in the resource group and region provided.

examples/basic/README.md

@@ -1,5 +1,5 @@
 ##############################################################################
-# Resource group
+# Resource Group
 ##############################################################################
 
 module "resource_group" {
@@ -11,14 +11,13 @@ module "resource_group" {
 }
 
 ##############################################################################
-# COS instance
+# RabbitMQ
 ##############################################################################
 
-resource "ibm_resource_instance" "cos_instance" {
-  name              = "${var.prefix}-cos"
+module "icd_rabbitmq" {
+  source            = "../.."
   resource_group_id = module.resource_group.resource_group_id
-  service           = "cloud-object-storage"
-  plan              = "standard"
-  location          = "global"
+  instance_name     = "${var.prefix}-rabbitmq"
+  region            = var.region
   tags              = var.resource_tags
 }

examples/basic/main.tf

@@ -2,17 +2,12 @@
 # Outputs
 ##############################################################################
 
-output "cos_instance_id" {
-  description = "COS instance id"
-  value       = ibm_resource_instance.cos_instance.id
+output "id" {
+  description = "rabbitmq instance id"
+  value       = module.icd_rabbitmq.id
 }
 
-output "resource_group_name" {
-  description = "Resource group name"
-  value       = module.resource_group.resource_group_name
-}
-
-output "resource_group_id" {
-  description = "Resource group ID"
-  value       = module.resource_group.resource_group_id
+output "version" {
+  description = "rabbitmq instance version"
+  value       = module.icd_rabbitmq.version
 }

examples/basic/outputs.tf

@@ -1,7 +1,3 @@
-##############################################################################
-# Provider config
-##############################################################################
-
 provider "ibm" {
   ibmcloud_api_key = var.ibmcloud_api_key
   region           = var.region

examples/basic/provider.tf

@@ -1,7 +1,3 @@
-##############################################################################
-# Input variables
-##############################################################################
-
 variable "ibmcloud_api_key" {
   type        = string
   description = "The IBM Cloud API Key"
@@ -17,12 +13,12 @@ variable "region" {
 variable "prefix" {
   type        = string
   description = "Prefix to append to all resources created by this example"
-  default     = "basic"
+  default     = "rabbitmq"
 }
 
 variable "resource_group" {
   type        = string
-  description = "The name of an existing resource group to provision resources in to. If not set a new resource group will be created using the prefix variable"
+  description = "An existing resource group name to use for this example, if unset a new resource group will be created"
   default     = null
 }
 

examples/basic/variables.tf

@@ -1,12 +1,10 @@
 terraform {
   required_version = ">= 1.3.0"
-
-  # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
-  # module's version.tf (usually a basic example), and 1 example that will always use the latest provider version.
   required_providers {
+    # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = "1.49.0"
+      version = "1.54.0"
     }
   }
 }

examples/basic/version.tf

@@ -1,4 +1,10 @@
-# Complete example
+# Complete example with BYOK encryption, CBR rules, autoscaling, and service credentials creation
 
-<!-- There is a pre-commit hook that will take the title of each example add include it in the repos main README.md  -->
-<!-- Add text below should describe exactly what resources are provisioned / configured by the example  -->
+An end-to-end example that does the following:
+
+- Create a new resource group if one is not passed in.
+- Create Key Protect instance with root key.
+- Create a new Messages for RabbitMQ instance with BYOK encryption and autoscaling enabled.
+- Create service credentials for the instance.
+- Create a Virtual Private Cloud (VPC).
+- Create Context Based Restriction (CBR) to only allow RabbitMQ to be accessible from the VPC.