fix: onboard module to IBM Cloud module registry (#491)

Author: rajatagarwal-ibm

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-06-07T10:48:18Z",
+  "generated_at": "2023-11-22T17:09:56Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -86,6 +86,16 @@
         "type": "Secret Keyword",
         "verified_result": null
       }
+    ],
+    "ibm_catalog.json": [
+      {
+        "hashed_secret": "2a66dd6b2184e0722c4f448eaac79a1897987a30",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 22,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
     ]
   },
   "version": "0.13.1+ibm.61.dss",

README.md

@@ -19,19 +19,19 @@ provider "ibm" {
 
 # KMS root key
 module "kms_root_key" {
-  source  = "terraform-ibm-modules/kms-key/ibm"
-  version = "latest" # Replace "latest" with a release version to lock into a specific release
-  kms_instance_id = ibm_resource_instance.kms_instance.guid
-  key_name                = "my-root-key"
+  source          = "terraform-ibm-modules/kms-key/ibm"
+  version         = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
+  kms_instance_id = "XXxxXXxx-xxxx-XXXX-xxxx-XXxxXXxx"
+  key_name        = "my-root-key"
 }
 
 # KMS standard key
 module "kms_standard_key" {
-  source  = "terraform-ibm-modules/kms-key/ibm"
-  version = "latest" # Replace "latest" with a release version to lock into a specific release
-  kms_instance_id = ibm_resource_instance.kms_instance.guid
-  key_name                = "my-standard-key"
-  standard_key            = true
+  source          = "terraform-ibm-modules/kms-key/ibm"
+  version         = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
+  kms_instance_id = "XXxxXXxx-xxxx-XXXX-xxxx-XXxxXXxx"
+  key_name        = "my-standard-key"
+  standard_key    = true
 }
 ```
 
@@ -49,8 +49,8 @@ You need the following permissions to run this module.
 <!-- BEGIN EXAMPLES HOOK -->
 ## Examples
 
-- [ End to end example with default values](examples/default)
-- [ Example that uses existing KMS instance](examples/existing-kms)
+- [ Basic example](examples/basic)
+- [ Complete example](examples/complete)
 <!-- END EXAMPLES HOOK -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ### Requirements

cra-config.yaml

@@ -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/default" # 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`
     PROFILE_ID: "0e6e7b5a-817d-4344-ab6f-e5d7a9c49520" # SCC profile ID (currently set to the FSCloud 1.4.0 profile).
     # SCC_INSTANCE_ID: "" # The SCC instance ID to use to download profile for CRA scan. If not provided, a default global value will be used.

examples/basic/README.md

@@ -0,0 +1,7 @@
+# Basic example
+
+A simple example that shows how to create a standard and a root key in an existing IBM Key Management Service (KMS) instance.
+
+The following resources are provisioned by this example:
+ - Create a root key in the existing KMS instance.
+ - Create a standard key in the existing KMS instance.

examples/basic/catalogValidationValues.json.template

@@ -0,0 +1,5 @@
+{
+  "ibmcloud_api_key": $VALIDATION_APIKEY,
+  "existing_kms_instance_guid": $HPCS_US_SOUTH_GUID,
+  "prefix": $PREFIX
+}