Merge instance and key to one module

Author: kavya498

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: "test-scheduler"
+
+on:
+  workflow_dispatch:
+
+
+  schedule:
+    - cron:  '*/30 5 * * *'    # triggers the workflow every day at 5:30 UTC
+
+# ┌───────────── minute (0 - 59)
+# │ ┌───────────── hour (0 - 23)
+# │ │ ┌───────────── day of the month (1 - 31)
+# │ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+# │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+# │ │ │ │ │
+# │ │ │ │ │
+# │ │ │ │ │
+# * * * * *
+
+jobs:
+  continuous-tests:
+    name: Run Test cases
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: checkout                      # action checks-out your repository under $GITHUB_WORKSPACE, so your workflow can access it.
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.15
+
+      - name: Install dependencies
+        run: |
+         go get -u "github.com/gruntwork-io/terratest/modules/random"
+         go get -u "github.com/gruntwork-io/terratest/modules/terraform"
+
+      -
+        name: setup terraform
+        uses: hashicorp/setup-terraform@v1  # sets up Terraform CLI in your GitHub Actions workflow
+        with:
+          terraform_version: 0.13.0
+
+      - name: Run Test
+        working-directory: test
+        run: go test -v ./...
+        env:
+          IC_API_KEY: ${{ secrets.ACCESS_KEY }}

.github/workflows/validate_terraform.yml

@@ -0,0 +1,39 @@
+name: ci
+
+on: [ push, pull_request ]
+
+jobs:
+  terraform_validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: prepare
+        # tfswitch command line tool lets you switch between different versions of terraform.
+        # If you do not have a particular version of terraform installed, tfswitch will download the version you desire.
+        run: |
+          echo "$HOME/.bin" >> $GITHUB_PATH
+          curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh > /tmp/tfswitch-install.sh
+          chmod +x /tmp/tfswitch-install.sh
+          /tmp/tfswitch-install.sh -b $HOME/.bin
+      -
+        name: checkout                      # action checks-out your repository under $GITHUB_WORKSPACE, so your workflow can access it.
+        uses: actions/checkout@v2
+      -
+        name: setup terraform
+        uses: hashicorp/setup-terraform@v1  # sets up Terraform CLI in your GitHub Actions workflow
+        with:
+          terraform_version: 0.13.0
+      -
+        name: Install pre-commit
+        run: pip install pre-commit
+      -
+        name: Run pre-commit command
+        run: pre-commit run -a
+      -
+        name: terraform init                # initialize a working directory containing Terraform configuration files.
+        run: find . -type f -name "*.tf" -exec dirname {} \;|sort -u | while read m; do (cd "$m" && echo "$m - init" && terraform init -input=false -backend=false) || exit 1; done
+      -
+        name: terraform validate            # validates the configuration files in a directory
+        run: find . -name ".terraform" -prune -o -type f -name "*.tf" -exec dirname {} \;|sort -u | while read m; do (cd "$m" && echo "$m - validate" && terraform validate && echo "√ $m") || exit 1 ; done
+      -
+        name: terraform fmt check           # perform format checks
+        run: terraform fmt -list=true -write=false -check -recursive

.gitignore

@@ -1,5 +1,13 @@
-terraform.tfstate
-terraform.tfstate.backup
-terraform.tfplan
-.terraform.tfstate.lock.info
-.terraform
+# Local .terraform directories
+**/.terraform/*
+# .tfstate files
+*.tfstate
+*.tfstate.*
+*.terraform.lock.hcl
+# Crash log files
+crash.log
+# Exclude all .tfvars files, which are likely to contain sentitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+default_stages: [commit]
+# TFLint             : Checks for possible errors, best practices, etc. It will also help identify provider-specific issues before errors occur during a Terraform run.
+# TFSec              : Uses static analysis of your Terraform templates to spot potential security issues. TFSec checks for sensitive data inclusion
+# Terraform Docs     : Utility to automatically generate documentation from Terraform modules and base repositories in various output formats.
+# Terraform Fmt      : Used to rewrite Terraform configuration files to a canonical format and style.
+# Terraform Validate : Validates the configuration files in a directory, referring only to the configuration and not accessing any remote services such as remote state, provider APIs, etc
+repos:
+- repo: git://github.com/antonbabenko/pre-commit-terraform
+  rev: v1.45.0
+  hooks:
+    - id: terraform_fmt
+- repo: git://github.com/pre-commit/pre-commit-hooks
+  rev: v3.4.0
+  hooks:
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: detect-private-key

README.md

@@ -1,39 +1,33 @@
 # terraform-ibm-kms
+
 Terraform modules to create and work with IBM Key Management Service
 
-The supported modules are 
-* [Provisioning Key protect Instance](./modules/instance)
-* [Creating or Importing Key Protect Key](./modules/key)
+The supported modules are
+
+* [Provision and manage Key protect Instance and its keys](./modules/key-protect)
 
 ## Example Usage
-```
-data "ibm_resource_group" "resource_group" {
-  name = var.resource_group
-}
 
-module "kms_instance" {
-  source                 = "terraform-ibm-modules/kms/ibm//modules/instance"
+``` terraform
+module "kms_key" {
+  source                 = "../../modules/key-protect"
+  is_kp_instance_exist   = false
   resource_group_id      = data.ibm_resource_group.resource_group.id
   service_name           = var.service_name
   location               = var.location
   plan                   = "tiered-pricing"
   tags                   = var.tags
   allowed_network_policy = var.allowed_network_policy
-}
-
-module "kms_key" {
-  source                 = "terraform-ibm-modules/kms/ibm//modules/key"
-  kms_instance_guid      = module.kms_instance.kms_instance-guid
-  name                   = var.name
+  key_name               = var.key_name
   standard_key_type      = var.standard_key_type
   force_delete           = var.force_delete
   network_access_allowed = var.network_access_allowed
 }
-
 ```
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
+
 | Name                     | Description                                                    | Type   |Default  |Required |
 |--------------------------|----------------------------------------------------------------|:-------|:--------|:--------|
 | resource\_group          | Name of the resource group                                     |`string`| n/a     | yes     |
@@ -42,26 +36,41 @@ module "kms_key" {
 | tags                     | Tags for the KMS Instance                                      |`set`   | n/a     | no      |
 | allowed_network_policy   | Types of the service endpoints.                                |`string`| n/a     | no      |
 | kms_instance_guid        | GUID of the Instance                                           |`string`| n/a     | yes     |
-| name                     | Name of the Key                                                |`string`| n/a     | yes     |
+| key_name                     | Name of the Key                                                |`string`| n/a     | yes     |
 | standard_key_type        | Determines if it has to be a standard key or root key          |`bool`  | false   | no      |
 | force_delete             | Determines if it has to be force deleted                       |`bool`  | false   | no      |
 | network_access_allowed   | public or private                                              |`string`| `public`| no      |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
-## NOTE: If we want to make use of a particular version of module, then set the argument "version" to respective module version.
+## NOTE: If we want to make use of a particular version of module, then set the argument "version" to respective module version
+
 ## Usage
 
-To run this example you need to execute:
+Initialising Provider
+
+Make sure you declare a required providers ibm block to make use of IBM-Cloud Terraform Provider
+
+```terraform
+terraform {
+  required_providers {
+    ibm = {
+      source = "IBM-Cloud/ibm"
+      version = "<version>"  // Specify the version
+    }
+  }
+}
+```
 
 ```bash
-$ terraform init
-$ terraform plan 
-$ terraform apply
+terraform init
+terraform plan
+terraform apply
 ```
 
 Run `terraform destroy` when you don't need these resources.
 
- ## Note:
+## Note
+
 * All optional fields are given value `null` in varaible.tf file. User can configure the same by overwriting with appropriate values.
- * Provide `version` attribute in terraform block in versions.tf file to use specific version of terraform provider
+* Provide `version` attribute in terraform block in versions.tf file to use specific version of terraform provider.