feat: renamed module to terraform-ibm-key-protect-key-ring as official support added for HPCS (#394)

Author: maheshwarishikha

.github/settings.yml

@@ -15,12 +15,12 @@ repository:
   # By changing this field, you rename the repository.
 
   # Uncomment this name property and set the name to the current repo name.
-  name: "terraform-ibm-key-protect-key-ring"
+  name: "terraform-ibm-kms-key-ring"
 
   # The description is displayed under the repository name on the
   # organization page and in the 'About' section of the repository.
 
   # Uncomment this description property
   # and update the description to the current repo description.
-  description: "Module to create Key Rings in a Key Protect instance"
-  topics: core-team, terraform, ibm-cloud, terraform-module, key-protect, kms, key-ring
+  description: "Module to create Key Rings in a KMS instance"
+  topics: core-team, terraform, ibm-cloud, terraform-module, key-protect, kms, key-ring, hpcs

README.md

@@ -1,24 +1,24 @@
-# Key Protect key ring module
+# KMS key ring module
 
 [![Stable (With Quality Checks)](https://img.shields.io/badge/Status-Stable%20(With%20quality%20checks)-green?style=plastic)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
-[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-key-protect-key-ring?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-key-protect-key-ring/releases/latest)
+[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-kms-key-ring?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-kms-key-ring/releases/latest)
 [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
 
-This module creates a key ring to help organize keys in a Key Protect instance.
-For more information, about key management rings, see [creating key rings](https://cloud.ibm.com/docs/key-protect?topic=key-protect-grouping-keys#create-key-ring-api).
+This module creates a key ring to help organize keys in a KMS instance. KMS can be Key Protect or Hyper Protect Crypto Services(HPCS) instance.
+For more information, about key management rings, see [creating key rings in Key Protect](https://cloud.ibm.com/docs/key-protect?topic=key-protect-grouping-keys#create-key-ring-api) and [managing key rings in HPCS](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-managing-key-rings&interface=ui).
 
 ## Usage
 ```hcl
 provider "ibm" {
   ibmcloud_api_key = "XXXXXXXXXX"
-  # Must be the same region the Key Protect instance is in
+  # Must be the same region the KMS instance is in
   region           = "us-south"
 }
 
-module "key_protect_key_ring" {
-  source  = "terraform-ibm-modules/key-protect-key-ring/ibm"
+module "kms_key_ring" {
+  source  = "terraform-ibm-modules/kms-key-ring/ibm"
   version = "latest" # Replace "latest" with a release version to lock into a specific release
   instance_id   = "XXxxXXxx-xxxx-XXXX-xxxx-XXxxXXxx"
   key_ring_id   = "my-key-ring"
@@ -32,7 +32,7 @@ You need the following permissions to run this module.
     - **Resource Group** service
         - `Viewer` platform access
 - IAM Services
-    - **Key Protect** service
+    - **KMS** service
         - `Viewer` platform access
         - `Manager` service access
 
@@ -67,8 +67,8 @@ No modules.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_endpoint_type"></a> [endpoint\_type](#input\_endpoint\_type) | The type of endpoint to be used for creating keys. Accepts 'public' or 'private' | `string` | `"public"` | no |
-| <a name="input_instance_id"></a> [instance\_id](#input\_instance\_id) | The Key Protect instance GUID | `string` | n/a | yes |
-| <a name="input_key_ring_id"></a> [key\_ring\_id](#input\_key\_ring\_id) | The ID that identifies the Key Ring. Each ID is unique within the given Key Protect instance but is not reserved across the Key Protect service | `string` | n/a | yes |
+| <a name="input_instance_id"></a> [instance\_id](#input\_instance\_id) | The KMS instance GUID | `string` | n/a | yes |
+| <a name="input_key_ring_id"></a> [key\_ring\_id](#input\_key\_ring\_id) | The ID that identifies the Key Ring. Each ID is unique within the given KMS instance but is not reserved across the KMS service | `string` | n/a | yes |
 
 ## Outputs
 

examples/default/README.md

@@ -3,5 +3,5 @@
 An end-to-end example that uses the module's default variable values.
 This example will:
  - Create a new resource group (if existing one is not passed in).
- - Create a new Key Protect instance in the region and resource group provided.
- - Create a Key Ring within the Key Protect Instance.
+ - Create a new KMS (Key Protect) instance in the region and resource group provided.
+ - Create a Key Ring within the KMS Instance.

examples/default/main.tf

@@ -11,7 +11,7 @@ module "resource_group" {
 }
 
 ##############################################################################
-# Key Protect instance
+# KMS(Key Protect) instance
 ##############################################################################
 
 resource "ibm_resource_instance" "key_protect_instance" {
@@ -27,7 +27,7 @@ resource "ibm_resource_instance" "key_protect_instance" {
 # Key Ring module
 ##############################################################################
 
-module "key_protect_key_ring" {
+module "kms_key_ring" {
   source      = "../.."
   instance_id = ibm_resource_instance.key_protect_instance.guid
   key_ring_id = "${var.prefix}-key-ring"

examples/default/outputs.tf

@@ -12,17 +12,17 @@ output "resource_group_id" {
   value       = module.resource_group.resource_group_id
 }
 
-output "key_protect_id" {
-  description = "Key Protect Instance ID"
+output "kms_id" {
+  description = "KMS Instance ID"
   value       = ibm_resource_instance.key_protect_instance.id
 }
 
-output "key_protect_guid" {
-  description = "Key Protect Instance GUID"
+output "kms_guid" {
+  description = "KMS Instance GUID"
   value       = ibm_resource_instance.key_protect_instance.guid
 }
 
-output "key_protect_key_ring_id" {
-  description = "Key Protect Key Ring ID"
-  value       = module.key_protect_key_ring.key_ring_id
+output "kms_key_ring_id" {
+  description = "KMS Key Ring ID"
+  value       = module.kms_key_ring.key_ring_id
 }

examples/default/variables.tf

@@ -13,7 +13,7 @@ variable "region" {
 variable "prefix" {
   type        = string
   description = "Prefix to append to all resources created by this example"
-  default     = "example-kpkr"
+  default     = "example-kmskr"
 }
 
 variable "resource_group" {

main.tf

@@ -1,5 +1,5 @@
 ##############################################################################
-# Key Protect Key Ring module
+# KMS Key Ring module
 ##############################################################################
 
 resource "ibm_kms_key_rings" "key_ring" {

module-metadata.json

@@ -19,7 +19,7 @@
     "instance_id": {
       "name": "instance_id",
       "type": "string",
-      "description": "The Key Protect instance GUID",
+      "description": "The KMS instance GUID",
       "required": true,
       "source": [
         "ibm_kms_key_rings.key_ring.instance_id"
@@ -37,7 +37,7 @@
     "key_ring_id": {
       "name": "key_ring_id",
       "type": "string",
-      "description": "The ID that identifies the Key Ring. Each ID is unique within the given Key Protect instance but is not reserved across the Key Protect service",
+      "description": "The ID that identifies the Key Ring. Each ID is unique within the given KMS instance but is not reserved across the KMS service",
       "required": true,
       "source": [
         "ibm_kms_key_rings.key_ring.key_ring_id"

tests/pr_test.go

@@ -2,20 +2,41 @@
 package test
 
 import (
+	"log"
+	"os"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/common"
 	"github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/testhelper"
 )
 
 // Use existing resource group for tests
 const resourceGroup = "geretain-test-key-protect-key-ring"
-const terraformDir = "examples/default"
+const defaultExampleTerraformDir = "examples/default"
+const existingKmsExampleTerraformDir = "examples/existing-kms"
+
+// Define a struct with fields that match the structure of the YAML data
+const yamlLocation = "../common-dev-assets/common-go-assets/common-permanent-resources.yaml"
+
+var permanentResources map[string]interface{}
+
+// TestMain will be run before any parallel tests, used to read data from yaml for use with tests
+func TestMain(m *testing.M) {
+
+	var err error
+	permanentResources, err = common.LoadMapFromYaml(yamlLocation)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	os.Exit(m.Run())
+}
 
 func setupOptions(t *testing.T, prefix string) *testhelper.TestOptions {
 	options := testhelper.TestOptionsDefaultWithVars(&testhelper.TestOptions{
 		Testing:       t,
-		TerraformDir:  terraformDir,
+		TerraformDir:  defaultExampleTerraformDir,
 		Prefix:        prefix,
 		ResourceGroup: resourceGroup,
 	})
@@ -26,7 +47,24 @@ func setupOptions(t *testing.T, prefix string) *testhelper.TestOptions {
 func TestRunDefaultExample(t *testing.T) {
 	t.Parallel()
 
-	options := setupOptions(t, "kp-key-ring")
+	options := setupOptions(t, "kms-key-ring")
+	output, err := options.RunTestConsistency()
+	assert.Nil(t, err, "This should not have errored")
+	assert.NotNil(t, output, "Expected some output")
+}
+
+func TestRunExistingKMSExample(t *testing.T) {
+	t.Parallel()
+
+	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{
+		Testing:      t,
+		TerraformDir: existingKmsExampleTerraformDir,
+		Prefix:       "hpcs",
+		TerraformVars: map[string]interface{}{
+			"existing_kms_instance_guid": permanentResources["hpcs_south"],
+		},
+	})
+
 	output, err := options.RunTestConsistency()
 	assert.Nil(t, err, "This should not have errored")
 	assert.NotNil(t, output, "Expected some output")
@@ -35,7 +73,7 @@ func TestRunDefaultExample(t *testing.T) {
 func TestRunUpgrade(t *testing.T) {
 	t.Parallel()
 
-	options := setupOptions(t, "kp-key-ring-upg")
+	options := setupOptions(t, "kms-key-ring-upg")
 	output, err := options.RunTestUpgrade()
 	if !options.UpgradeTestSkipped {
 		assert.Nil(t, err, "This should not have errored")

variables.tf

@@ -14,12 +14,12 @@ variable "endpoint_type" {
 
 variable "instance_id" {
   type        = string
-  description = "The Key Protect instance GUID"
+  description = "The KMS instance GUID"
 }
 
 variable "key_ring_id" {
   type        = string
-  description = "The ID that identifies the Key Ring. Each ID is unique within the given Key Protect instance but is not reserved across the Key Protect service"
+  description = "The ID that identifies the Key Ring. Each ID is unique within the given KMS instance but is not reserved across the KMS service"
 
   validation {
     condition     = can(regex("^[a-zA-Z0-9-]{2,100}$", var.key_ring_id))