Pre-commit fixes (#44)

* Pre-commit fixes

* Restrict terraform version to < 1.3.0

* fixup! Restrict terraform version to < 1.3.0

* fixup! Restrict terraform version to < 1.3.0

* Pinned min version to 1.1.0, support for nullable

* Update README.md

Author: bonclay7

.github/workflows/pre-commit.yaml

@@ -41,6 +41,13 @@ jobs:
       matrix:
         directory: ${{ fromJson(needs.collectInputs.outputs.directories) }}
     steps:
+      - name: Remove default Terraform
+        run: rm -rf $(which terraform)
+
+      - name: Should fail
+        continue-on-error: true
+        run: terraform version
+
       - name: Checkout
         uses: actions/checkout@v3
 
@@ -73,27 +80,37 @@ jobs:
         with:
           directory: ${{ matrix.directory }}
 
-      - name: Pre-commit Terraform ${{ steps.minMax.outputs.minVersion }}
+      - name: Pre-commit Terraform 1.1.0 #${{ steps.minMax.outputs.minVersion }}
         uses: clowdhaus/terraform-composite-actions/[email protected]
         # Run only validate pre-commit check on min version supported
         if: ${{ matrix.directory !=  '.' && steps.changes.outputs.src== 'true' }}
         with:
-          terraform-version: ${{ steps.minMax.outputs.minVersion }}
+          terraform-version: 1.1.0 # ${{ steps.minMax.outputs.minVersion }}
           args: 'terraform_validate --color=always --show-diff-on-failure --files ${{ matrix.directory }}/*'
 
-      - name: Pre-commit Terraform ${{ steps.minMax.outputs.minVersion }}
+      - name: Pre-commit Terraform 1.1.0 #${{ steps.minMax.outputs.minVersion }}
         uses: clowdhaus/terraform-composite-actions/[email protected]
         # Run only validate pre-commit check on min version supported
         if: ${{ matrix.directory ==  '.' && steps.changes.outputs.src== 'true' }}
         with:
-          terraform-version: ${{ steps.minMax.outputs.minVersion }}
+          terraform-version: 1.1.0 #${{ steps.minMax.outputs.minVersion }}
           args: 'terraform_validate --color=always --show-diff-on-failure --files $(ls *.tf)'
 
+      - if: steps.changes.outputs.src== 'true'
+        run: terraform version
+
   preCommitMaxVersion:
     name: Max TF pre-commit
     runs-on: ubuntu-latest
     needs: collectInputs
     steps:
+      - name: Remove default Terraform
+        run: rm -rf $(which terraform)
+
+      - name: Should fail
+        continue-on-error: true
+        run: terraform version
+
       - name: Checkout
         uses: actions/checkout@v3
 
@@ -125,10 +142,14 @@ jobs:
         uses: clowdhaus/[email protected]
         if: steps.changes.outputs.src== 'true'
 
-      - name: Pre-commit Terraform ${{ steps.minMax.outputs.maxVersion }}
+      # TODO - remove hardcoded version once optional attributes are resolved/removed
+      - name: Pre-commit Terraform 1.2.9  # ${{ steps.minMax.outputs.maxVersion }}
         uses: clowdhaus/terraform-composite-actions/[email protected]
         if: steps.changes.outputs.src== 'true'
         with:
-          terraform-version: ${{ steps.minMax.outputs.maxVersion }}
+          terraform-version: 1.2.9 # ${{ steps.minMax.outputs.maxVersion }}
           terraform-docs-version: ${{ env.TERRAFORM_DOCS_VERSION }}
           tflint-version: ${{ env.TFLINT_VERSION }}
+
+      - if: steps.changes.outputs.src== 'true'
+        run: terraform version

README.md

@@ -1,7 +1,7 @@
 # AWS Observability Accelerator for Terraform
 
-<!-- [![pre-commit](https://github.com/aws-observability/terraform-aws-observability-accelerator/actions/workflows/pre-commit.yaml/badge.svg)](https://github.com/aws-observability/terraform-aws-observability-accelerator/actions/workflows/pre-commit.yaml)
- -->
+[![pre-commit](https://github.com/aws-observability/terraform-aws-observability-accelerator/actions/workflows/pre-commit.yaml/badge.svg)](https://github.com/aws-observability/terraform-aws-observability-accelerator/actions/workflows/pre-commit.yaml)
+
 Welcome to the AWS Observability Accelerator for Terraform!
 
 The AWS Observability accelerator for Terraform is a set of modules to help you
@@ -114,7 +114,7 @@ If you are interested in contributing to EKS Blueprints, see the [Contribution g
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.14.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.1.0, < 1.3.0 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0.0 |
 | <a name="requirement_awscc"></a> [awscc](#requirement\_awscc) | >= 0.24.0 |
 | <a name="requirement_grafana"></a> [grafana](#requirement\_grafana) | 1.25.0 |

examples/eks-cluster-with-vpc/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.0.0"
+  required_version = ">= 1.1.0, < 1.3.0"
 
   required_providers {
     aws = {

examples/existing-cluster-nginx/README.md

@@ -191,10 +191,9 @@ add this `managed_prometheus_region=xxx` and `managed_prometheus_workspace_id=ws
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.1.0, < 1.3.0 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0.0 |
 | <a name="requirement_grafana"></a> [grafana](#requirement\_grafana) | >= 1.25.0 |
-| <a name="requirement_grafana"></a> [grafana](#requirement\_grafana) | >= 1.25.0 |
 | <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.4.1 |
 | <a name="requirement_kubectl"></a> [kubectl](#requirement\_kubectl) | >= 1.14 |
 | <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.10 |
@@ -224,10 +223,10 @@ add this `managed_prometheus_region=xxx` and `managed_prometheus_workspace_id=ws
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | AWS Region | `string` | n/a | yes |
-| <a name="input_eks_cluster_id"></a> [eks\_cluster\_id](#input\_eks\_cluster\_id) | Name of the EKS cluster | `string` | n/a | yes |
+| <a name="input_eks_cluster_id"></a> [eks\_cluster\_id](#input\_eks\_cluster\_id) | EKS Cluster Id | `string` | n/a | yes |
 | <a name="input_grafana_api_key"></a> [grafana\_api\_key](#input\_grafana\_api\_key) | API key for authorizing the Grafana provider to make changes to Amazon Managed Grafana | `string` | `""` | no |
-| <a name="input_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#input\_managed\_grafana\_workspace\_id) | Amazon Managed Grafana Workspace ID | `string` | `""` | no |
-| <a name="input_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#input\_managed\_prometheus\_workspace\_id) | Amazon Managed Service for Prometheus Workspace ID | `string` | `""` | no |
+| <a name="input_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#input\_managed\_grafana\_workspace\_id) | Amazon Managed Grafana (AMG) workspace ID | `string` | `""` | no |
+| <a name="input_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#input\_managed\_prometheus\_workspace\_id) | Amazon Managed Service for Prometheus (AMP) workspace ID | `string` | `""` | no |
 
 ## Outputs
 

examples/existing-cluster-nginx/main.tf

@@ -24,23 +24,10 @@ provider "helm" {
   }
 }
 
-terraform {
-  required_providers {
-    grafana = {
-      source  = "grafana/grafana"
-      version = ">= 1.25.0"
-    }
-  }
-}
-
 locals {
-  name   = basename(path.cwd)
   region = var.aws_region
 
-  eks_oidc_issuer_url  = replace(data.aws_eks_cluster.this.identity[0].oidc[0].issuer, "https://", "")
   eks_cluster_endpoint = data.aws_eks_cluster.this.endpoint
-  eks_cluster_version  = data.aws_eks_cluster.this.version
-
   create_new_workspace = var.managed_prometheus_workspace_id == "" ? true : false
 
   tags = {
@@ -84,7 +71,6 @@ provider "grafana" {
   auth = var.grafana_api_key
 }
 
-//*
 module "workloads_nginx" {
   source = "../../modules/workloads/nginx"
 
@@ -102,4 +88,3 @@ module "workloads_nginx" {
     module.eks_observability_accelerator
   ]
 }
-//*/

examples/existing-cluster-nginx/outputs.tf

@@ -21,4 +21,4 @@ output "managed_prometheus_workspace_endpoint" {
 output "managed_prometheus_workspace_id" {
   description = "Amazon Managed Prometheus workspace ID"
   value       = module.eks_observability_accelerator.managed_prometheus_workspace_id
-}
+}

examples/existing-cluster-nginx/variables.tf

@@ -11,29 +11,14 @@ variable "managed_prometheus_workspace_id" {
   type        = string
   default     = ""
 }
-variable "managed_prometheus_endpoint" {
-  description = "AMP workspace ID"
-  type        = string
-  default     = ""
-}
-variable "managed_prometheus_region" {
-  description = "Region where AMP is deployed"
-  type        = string
-  default     = ""
-}
 variable "managed_grafana_workspace_id" {
   description = "Amazon Managed Grafana (AMG) workspace ID"
   type        = string
   default     = ""
 }
-variable "grafana_endpoint" {
-  description = "AMG endpoint"
-  type        = string
-  default     = null
-}
 variable "grafana_api_key" {
   description = "API key for authorizing the Grafana provider to make changes to Amazon Managed Grafana"
   type        = string
   default     = ""
   sensitive   = true
-}
+}

examples/existing-cluster-nginx/versions.tf

@@ -0,0 +1,34 @@
+terraform {
+  required_version = ">= 1.1.0, < 1.3.0"
+
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 4.0.0"
+    }
+    kubernetes = {
+      source  = "hashicorp/kubernetes"
+      version = ">= 2.10"
+    }
+    kubectl = {
+      source  = "gavinbunney/kubectl"
+      version = ">= 1.14"
+    }
+    helm = {
+      source  = "hashicorp/helm"
+      version = ">= 2.4.1"
+    }
+    grafana = {
+      source  = "grafana/grafana"
+      version = ">= 1.25.0"
+    }
+  }
+
+  # ##  Used for end-to-end testing on project; update to suit your needs
+  # backend "s3" {
+  #   bucket = "observability-accelerator-terraform-states"
+  #   region = "us-west-2"
+  #   key    = "e2e/existing-cluster-with-base-and-infra/terraform.tfstate"
+  # }
+
+}

examples/existing-cluster-with-base-and-infra/README.md

@@ -136,7 +136,7 @@ terraform destroy -var-file=terraform.tfvars
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.1.0, < 1.3.0 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0.0 |
 | <a name="requirement_grafana"></a> [grafana](#requirement\_grafana) | >= 1.25.0 |
 | <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.4.1 |

examples/existing-cluster-with-base-and-infra/main.tf

@@ -86,7 +86,7 @@ module "workloads_infra" {
   managed_prometheus_workspace_region   = module.eks_observability_accelerator.managed_prometheus_workspace_region
 
   tags = local.tags
-  
+
   depends_on = [
     module.eks_observability_accelerator
   ]