upgrading to 1.0.1

Author: tomarv2

.github/workflows/onrelease.yml

@@ -0,0 +1,28 @@
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+name: release
+
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          body: |
+            Release for version ${{ github.ref }}. Please check CHANGELOG.md for more information.
+          draft: false
+          prerelease: false

.github/workflows/security_scans.yml renamed to .github/workflows/pre-commit.yml

@@ -80,4 +80,4 @@ _testmain.go
 /test/times.out
 
 # ignore test file(s)
-**test**
+**test**

.gitignore

@@ -0,0 +1,36 @@
+repos:
+  - repo: git://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.48.0
+    hooks:
+      - id: terraform_fmt
+      - id: terraform_validate
+      - id: terraform_tflint
+        args:
+          - '--args=--only=terraform_deprecated_interpolation'
+          - '--args=--only=terraform_deprecated_index'
+          - '--args=--only=terraform_unused_declarations' #
+          - '--args=--only=terraform_comment_syntax'
+          - '--args=--only=terraform_documented_outputs'
+          - '--args=--only=terraform_documented_variables'
+          - '--args=--only=terraform_typed_variables'
+          - '--args=--only=terraform_module_pinned_source'
+          - '--args=--only=terraform_naming_convention'
+          #- '--args=--only=terraform_required_providers'
+          - '--args=--only=terraform_standard_module_structure' #
+          - '--args=--only=terraform_workspace_remote'
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: check-yaml
+
+  - repo: https://github.com/bridgecrewio/checkov.git
+    rev: '1.0.864' # change to tag or sha
+    hooks:
+    - id: checkov
+      verbose: true
+      args:
+      - -d . --framework terraform -o output_format json

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 <p align="center">
-    <a href="https://github.com/tomarv2/terraform-aws-target-group/actions/workflows/security_scans.yml" alt="Security Scans">
-        <img src="https://github.com/tomarv2/terraform-aws-target-group/actions/workflows/security_scans.yml/badge.svg?branch=main" /></a>
+    <a href="https://github.com/tomarv2/terraform-aws-target-group/actions/workflows/pre-commit.yml" alt="Pre commit">
+        <img src="https://github.com/tomarv2/terraform-aws-target-group/actions/workflows/pre-commit.yml/badge.svg?branch=main" /></a>
     <a href="https://www.apache.org/licenses/LICENSE-2.0" alt="license">
         <img src="https://img.shields.io/github/license/tomarv2/terraform-aws-target-group" /></a>
     <a href="https://github.com/tomarv2/terraform-aws-target-group/tags" alt="GitHub tag">
@@ -19,66 +19,79 @@
 
 ## Versions
 
-- Module tested for Terraform 0.14.
-- AWS provider version [3.29.0](https://registry.terraform.io/providers/hashicorp/aws/latest)
-- `main` branch: Provider versions not pinned to keep up with Terraform releases
+- Module tested for Terraform 1.0.1.
+- AWS provider version [3.47.0](https://registry.terraform.io/providers/hashicorp/aws/latest)
+- `main` branch: Provider versions not pinned to keep up with Terraform releases.
 - `tags` releases: Tags are pinned with versions (use <a href="https://github.com/tomarv2/terraform-aws-target-group/tags" alt="GitHub tag">
-        <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-aws-target-group" /></a> in your releases)
+        <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-aws-target-group" /></a> ).
 
-**NOTE:** 
+---
+## Usage
 
-- Read more on [tfremote](https://github.com/tomarv2/tfremote)
+### Option 1:
 
-## Usage
+```
+terrafrom init
+terraform plan -var='teamid=tryme' -var='prjid=project1'
+terraform apply -var='teamid=tryme' -var='prjid=project1'
+terraform destroy -var='teamid=tryme' -var='prjid=project1'
+```
+**Note:** With this option please take care of remote state storage
 
-Recommended method:
+### Option 2:
 
-- Create python 3.6+ virtual environment 
+#### Recommended method (store remote state in S3 using prjid and teamid to create directory structure):
+
+- Create python 3.6+ virtual environment
 ```
 python3 -m venv <venv name>
 ```
 
 - Install package:
 ```
-pip install tfremote
+pip install tfremote --upgrade
+```
+
+- Set below environment variables:
+```
+export TF_AWS_BUCKET=<remote state bucket name>
+export TF_AWS_BUCKET_REGION=us-west-2
+export TF_AWS_PROFILE=<profile from ~/.ws/credentials>
 ```
 
+or
+
 - Set below environment variables:
 ```
 export TF_AWS_BUCKET=<remote state bucket name>
-export TF_AWS_PROFILE=default
 export TF_AWS_BUCKET_REGION=us-west-2
-```  
+export AWS_ACCESS_KEY_ID=<aws_access_key_id>
+export AWS_SECRET_ACCESS_KEY=<aws_secret_access_key>
+```
 
-- Updated `examples` directory with required values. 
+- Updated `examples` directory with required values.
 
 - Run and verify the output before deploying:
 ```
-tf -cloud aws plan -var='teamid=foo' -var='prjid=bar'
+tf -c=aws plan -var='teamid=foo' -var='prjid=bar'
 ```
 
 - Run below to deploy:
 ```
-tf -cloud aws apply -var='teamid=foo' -var='prjid=bar'
+tf -c=aws apply -var='teamid=foo' -var='prjid=bar'
 ```
 
 - Run below to destroy:
 ```
-tf -cloud aws destroy -var='teamid=foo' -var='prjid=bar'
+tf -c=aws destroy -var='teamid=foo' -var='prjid=bar'
 ```
 
-> ❗️ **Important** - Two variables are required for using `tf` package:
->
-> - teamid
-> - prjid
->
-> These variables are required to set backend path in the remote storage.
-> Variables can be defined using:
->
-> - As `inline variables` e.g.: `-var='teamid=demo-team' -var='prjid=demo-project'`
-> - Inside `.tfvars` file e.g.: `-var-file=<tfvars file location> `
->
-> For more information refer to [Terraform documentation](https://www.terraform.io/docs/language/values/variables.html)
+**NOTE:**
+
+- Read more on [tfremote](https://github.com/tomarv2/tfremote)
+---
+
+Please refer to examples directory [link](examples) for references.
 
 ##### Target Group
 ```
@@ -99,50 +112,6 @@ module "target_group" {
   teamid = var.teamid
   prjid  = var.prjid
 }
-
 ```
 
 Please refer to examples directory [link](examples) for references.
-
-## Requirements
-
-| Name | Version |
-|------|---------|
-| terraform | >= 0.14 |
-| aws | ~> 3.29 |
-
-## Providers
-
-| Name | Version |
-|------|---------|
-| aws | ~> 3.29 |
-
-## Inputs
-
-| Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:--------:|
-| account\_id | (Required) AWS account id (used to pull values from shared base module like vpc info, subnet ids) | `any` | n/a | yes |
-| alb\_action\_type | n/a | `string` | `"forward"` | no |
-| alb\_cert\_arn | alb cert arn | `string` | `""` | no |
-| alb\_ssl\_policy | alb ssl policy | `string` | `""` | no |
-| aws\_region | The AWS region to create resources | `string` | `"us-west-2"` | no |
-| deregistration\_delay | n/a | `string` | `"300"` | no |
-| healthcheck\_interval | n/a | `string` | `""` | no |
-| healthcheck\_matcher | healthcheck matcher (e.g. 200) | `string` | `""` | no |
-| healthcheck\_path | target group healthcheck path | `string` | `""` | no |
-| healthcheck\_timeout | n/a | `string` | `""` | no |
-| healthy\_threshold | target group healthcheck threshold | `string` | `""` | no |
-| lb\_port | n/a | `list` | <pre>[<br>  80<br>]</pre> | no |
-| lb\_protocol | n/a | `string` | `"HTTP"` | no |
-| prjid | (Required) Name of the project/stack e.g: mystack, nifieks, demoaci. Should not be changed after running 'tf apply' | `any` | n/a | yes |
-| profile\_to\_use | Getting values from ~/.aws/credentials | `string` | `"default"` | no |
-| stickiness | Target group sticky configuration | <pre>object({<br>    cookie_duration = number<br>    enabled         = bool<br>  })</pre> | `null` | no |
-| target\_type | n/a | `string` | `"instance"` | no |
-| teamid | (Required) Name of the team/group e.g. devops, dataengineering. Should not be changed after running 'tf apply' | `any` | n/a | yes |
-| unhealthy\_threshold | target group unheathy healthcheck threshold | `string` | `""` | no |
-
-## Outputs
-
-| Name | Description |
-|------|-------------|
-| target\_group\_arn | n/a |

README.md

@@ -1,5 +1,10 @@
+provider "aws" {
+  region  = "us-west-2"
+  profile = "default"
+}
+
 module "target_group" {
-  source = "../"
+  source = "../../"
 
   account_id           = "12345679012"
   lb_protocol          = "HTTP"

examples/main.tf renamed to examples/sample/main.tf

@@ -1,7 +1,9 @@
 variable "teamid" {
   description = "(Required) Name of the team/group e.g. devops, dataengineering. Should not be changed after running 'tf apply'"
+  type        = string
 }
 
 variable "prjid" {
   description = "(Required) Name of the project/stack e.g: mystack, nifieks, demoaci. Should not be changed after running 'tf apply'"
+  type        = string
 }

examples/output.tf renamed to examples/sample/outputs.tf

@@ -3,9 +3,11 @@ module "global" {
 }
 
 locals {
-  shared_tags = map(
-    "name", "${var.teamid}-${var.prjid}",
-    "team", var.teamid,
-    "project", var.prjid
+  shared_tags = tomap(
+    {
+      "Name"    = "${var.teamid}-${var.prjid}",
+      "team"    = var.teamid,
+      "project" = var.prjid
+    }
   )
 }