Add the Github workflow for the Terraform checks

Signed-off-by: gatici <[email protected]>

.github/workflows/terraform.yaml

@@ -0,0 +1,30 @@
+name: Check the Terraform Module
+
+on:
+  pull_request:
+    paths:
+      - '**.tf'
+
+jobs:
+  build:
+    name: Terraform Checks and Plans
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository to the runner
+        uses: actions/checkout@v3
+
+      - name: HashiCorp - Setup Terraform
+        uses: hashicorp/setup-terraform@v3
+
+      - name: Terraform Format
+        id: fmt
+        run: terraform fmt -recursive -check
+        continue-on-error: true
+
+      - name: Terraform Init
+        id: init
+        run: terraform init
+
+      - name: Terraform Validate
+        id: validate
+        run: terraform validate -no-color

terraform/README.md

@@ -6,7 +6,7 @@ This Grafana-agent-k8s Terraform module aims to deploy the [grafana-agent-k8s ch
 
 ### Prerequisites
 
-The following software and tools needs to be installed and should be running in the local environment.
+The following software and tools needs to be installed and should be running in the local environment. Please [set up your environment](https://discourse.charmhub.io/t/set-up-your-development-environment-with-microk8s-for-juju-terraform-provider/13109) before deployment.
 
 - `microk8s`
 - `juju 3.x`
@@ -23,7 +23,7 @@ sudo microk8s enable hostpath-storage
 Add a Juju model:
 
 ```console
-juju add model <model-name>
+juju add-model <model-name>
 ```
 
 Initialise the provider:
@@ -32,22 +32,20 @@ Initialise the provider:
 terraform init
 ```
 
-Customize the configuration inputs under `terraform.tfvars` file according to requirement.
-
-Replace the values in the `terraform.tfvars` file:
+Fill the mandatory config options in the `terraform.tfvars` file:
 
 ```yaml
 # Mandatory Config Options
 model_name = "put your model-name here"
 ```
 
-Run Terraform Plan by providing var-file:
+Create the Terraform Plan:
 
 ```console
 terraform plan -var-file="terraform.tfvars" 
 ```
 
-Deploy the resources, skip the approval:
+Deploy the resources:
 
 ```console
 terraform apply -auto-approve 
@@ -63,7 +61,7 @@ juju status --relations
 
 ### Clean Up
 
-Remove the application:
+Destroy the deployment:
 
 ```console
 terraform destroy -auto-approve

terraform/terraform.tf

@@ -1,4 +1,4 @@
-# Copyright 2023 Canonical Ltd.
+# Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 terraform {

terraform/terraform.tfvars

@@ -1,10 +1,10 @@
 # Mandatory Config Options
 model_name = "put your model-name here"
 
-# Optional Configuration
-channel                        = "put the charm channel here"
-metrics_remote_write_offer_url = "Put the URL here"
-logging_offer_url              = "Put the URL here"
-grafana-config = {
-  tls_insecure_skip_verify = "put True not to skip the TLS verification"
-}
+# Optional Configuration.
+# channel                        = "put the Charm channel here"
+# metrics_remote_write_offer_url = "Put the URL here"
+# logging_offer_url              = "Put the URL here"
+# grafana-config = {
+#   tls_insecure_skip_verify = "put True not to skip the TLS verification"
+# }