feat: modular folder structure to install infra-helm-chart dependency

.github/workflows/tf-helm-validate.yml

@@ -17,6 +17,10 @@ jobs:
       - name: Setup `Terraform`
         uses: hashicorp/setup-terraform@v2
 
+      - name: Enter root tf directory
+        run: |
+          cd root
+
       - name: Terraform fmt
         id: fmt
         run: terraform fmt -check

README.md

@@ -1,3 +1,17 @@
 # Terraform Helm Provider
 
-This terraform code is to deploy Helm charts on GKE(GCP) cluster using terraform [`Terraform Helm Provider`](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release)
+This terraform code is to deploy Helm charts on GKE(GCP) cluster in prod OR minikube cluster locally using terraform [`Terraform Helm Provider`](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release)
+
+The helm chart installation cluster depends on the `kubernetes` `config_path` in the `helm` provider.
+
+```tf
+provider "helm" {
+  kubernetes {
+    config_path = "~/.kube/config"
+  }
+}
+```
+
+Based on the `KUBECONFIG` value, the helm chart will be installed on that particular cluster.
+
+> Due to an on-going issue with Terraform Helm Provider [[reference](https://github.com/hashicorp/terraform-provider-helm/issues/932)] which prevents the Terraform resource to pull a chart from a private GitHub repository (even after providing a GitHub PAT), we are forced to install the Helm chart locally.

modules/infra_helm/main.tf

@@ -0,0 +1,12 @@
+# https://github.com/hashicorp/terraform-provider-helm/issues/467#issuecomment-617856419
+resource "helm_release" "infra_dependencies" {
+  name             = var.release_name
+  namespace        = var.namespace
+  create_namespace = true
+  repository       = "https://github.com/csye7125-fall2023-group05/infra-helm-chart.git"
+  chart            = "${var.chart_path}/infra-helm-chart-1.1.0.tar.gz"
+  wait             = false # prevents "pending-install" helm install state
+  version          = "1.1.0"
+  values           = ["${file(var.values_file)}"]
+  timeout          = var.timeout
+}

modules/infra_helm/variables.tf

@@ -0,0 +1,5 @@
+variable "namespace" {}
+variable "timeout" {}
+variable "values_file" {}
+variable "chart_path" {}
+variable "release_name" {}

.gitignore → root/.gitignore

@@ -33,4 +33,5 @@ override.tf.json
 
 # variables
 dev.tfvars
-prod.tfvars
+prod.tfvars
+values.yaml

root/backend.tf

@@ -0,0 +1,8 @@
+# terraform {
+#   backend "s3" {
+#     bucket         = "tfstate-sid"
+#     key            = "backend/infra-jenkins.tfstate"
+#     region         = "us-east-1"
+#     dynamodb_table = "infra-state"
+#   }
+# }

root/example.tfvars

@@ -0,0 +1,5 @@
+namespace    = "webapp"
+timeout      = 600
+values_file  = "./values.yaml"
+chart_path   = "../modules/infra_helm/charts"
+release_name = "infra-helm-release"

root/main.tf

@@ -0,0 +1,8 @@
+module "infra_dependencies" {
+  source       = "../modules/infra_helm"
+  namespace    = var.namespace
+  timeout      = var.timeout
+  values_file  = var.values_file
+  chart_path   = var.chart_path
+  release_name = var.release_name
+}

provider.tf → root/provider.tf

@@ -1,8 +1,8 @@
 terraform {
   required_providers {
-    google = {
-      source  = "hashicorp/google"
-      version = "4.63.1"
+    helm = {
+      source  = "hashicorp/helm"
+      version = "2.11.0"
     }
   }
 }

root/variables.tf

@@ -0,0 +1,29 @@
+variable "namespace" {
+  default     = "default"
+  type        = string
+  description = "Namespace in which to deploy the chart"
+}
+
+variable "timeout" {
+  type        = number
+  description = "The max time to run the helm release"
+  default     = 30
+}
+
+variable "values_file" {
+  type        = string
+  description = "The path to the values.yaml file for the helm chart"
+  default     = "./values.yaml"
+}
+
+variable "chart_path" {
+  type        = string
+  description = "The path to the charts/ directory to install local charts"
+  default     = "../modules/infra_helm/charts"
+}
+
+variable "release_name" {
+  type        = string
+  description = "The name of the helm chart release"
+  default     = "infra-helm-release"
+}