🚚 move github acctions example to new dir

💚 update github actions example module source

.github/workflows/terraform.yaml

@@ -46,7 +46,7 @@ jobs:
     needs: terraform-fmt
     runs-on: ubuntu-latest
     env:
-      WORKING_DIR: "examples/default_deployment"
+      WORKING_DIR: "examples/github_actions"
     steps:
       - name: Checkout
         uses: actions/[email protected]

examples/default_deployment/README.md

@@ -12,7 +12,9 @@ This example illustrates how to use the `terraform-digitalocean-ha-k3s` module.
 
 ## Outputs
 
-TBC
+| Name | Description |
+|------|-------------|
+| cluster_summary | A summary of the cluster's provisioned resources. |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 

examples/default_deployment/main.tf

@@ -1,13 +1,4 @@
 terraform {
-  # Reconfigure the backend block to suit your needs
-  backend "remote" {
-    hostname     = "app.terraform.io"
-    organization = "AIGISUK"
-
-    workspaces {
-      name = "gh-actions-terraform-digitalocean-ha-k3s"
-    }
-  }
   required_providers {
     digitalocean = {
       source = "digitalocean/digitalocean"

examples/github_actions/README.md

@@ -0,0 +1,17 @@
+# GitHub Actions Deployment Example
+
+This example is specifically for module tests.
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| do_token | DigitalOcean Personal Access Token | string | N/A | yes |
+| ssh_key_fingerprints | List of SSH Key fingerprints | list(string) | N/A | yes |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| cluster_summary | A summary of the cluster's provisioned resources. |

examples/github_actions/main.tf

@@ -0,0 +1,26 @@
+terraform {
+  # Reconfigure the backend block to suit your needs
+  backend "remote" {
+    hostname     = "app.terraform.io"
+    organization = "AIGISUK"
+
+    workspaces {
+      name = "gh-actions-terraform-digitalocean-ha-k3s"
+    }
+  }
+  required_providers {
+    digitalocean = {
+      source = "digitalocean/digitalocean"
+    }
+  }
+  required_version = ">= 0.13"
+}
+
+provider "digitalocean" {}
+
+module "ha-k3s" {
+  source = "git::https://github.com/aigisuk/terraform-digitalocean-ha-k3s.git?ref=develop"
+
+  do_token             = var.do_token
+  ssh_key_fingerprints = var.ssh_key_fingerprints
+}

examples/github_actions/outputs.tf

@@ -0,0 +1,3 @@
+output "cluster_summary" {
+  value = module.ha-k3s.cluster_summary
+}

examples/github_actions/variables.tf

@@ -0,0 +1,2 @@
+variable "ssh_key_fingerprints" {}
+variable "do_token" {}