Initial Terraform Project

* Completes the badge URLs * Adds a short discription to the Readme * Updates the module usage * Bumps the reqiured Terraform version to 1.6.2 * Removes unwanted files
dxw · Nov 1, 2023 · dc21399 · dc21399
1 parent 4093379
commit dc21399
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,17 @@
-# <REPLACE WITH USEFUL TERRAFORM DESCRIPTION>
+# Terraform dxw Dalmatian infrastructure
 
-[![Terraform CI](./actions/workflows/continuous-integration-terraform.yml/badge.svg?branch=main)](./actions/workflows/continuous-integration-terraform.yml?branch=main)
-[![GitHub release](./releases)](./releases)
+[![Terraform CI](https://github.com/dxw/terraform-dxw-dalmatian-infrastructure/actions/workflows/continuous-integration-terraform.yml/badge.svg?branch=main)](https://github.com/dxw/terraform-dxw-dalmatian-infrastructure/actions/workflows/continuous-integration-terraform.yml?branch=main)
+[![GitHub release](https://github.com/dxw/terraform-dxw-dalmatian-infrastructure/releases)](https://github.com/dxw/terraform-dxw-dalmatian-infrastructure/releases)
 
-This <module/project> creates and manages <REPLACE WITH MAIN RESOURCE NAMES/URLS>.
+This project creates and manages resources within an AWS account for infrastructures on dxw's Dalmatian hosting platform.
 
 ## Usage
 
 Example module usage:
 
 ```hcl
 module "<MODULE NAME>" {
-  source  = "github.com/<ORG>/<MODULE NAME>?ref=v<VERSION>"
-
-  environment = "dev/staging/test/pre-prod/prod/post-prod"
+  source  = "github.com/dxw/terraform-dxw-dalmatian-infrastructure?ref=v<VERSION>"
 }
 ```
 
@@ -22,7 +20,7 @@ module "<MODULE NAME>" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.3 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.6.2 |
 
 ## Providers
 
@@ -34,13 +32,9 @@ No resources.
 
 ## Inputs
 
-| Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:--------:|
-| <a name="input_environment"></a> [environment](#input\_environment) | Environment name | `string` | n/a | yes |
+No inputs.
 
 ## Outputs
 
-| Name | Description |
-|------|-------------|
-| <a name="output_environment"></a> [environment](#output\_environment) | n/a |
+No outputs.
 <!-- END_TF_DOCS -->
diff --git a/backend.tf.aws-s3.example b/backend.tf.aws-s3.example
diff --git a/backend.tf.azure-storage.example b/backend.tf.azure-storage.example
diff --git a/backend.vars.azure-storeage.example b/backend.vars.azure-storeage.example
diff --git a/locals.tf b/locals.tf
@@ -1,3 +1,2 @@
 locals {
-  environment = var.environment
 }
diff --git a/moved.tf b/moved.tf
diff --git a/outputs.tf b/outputs.tf
@@ -1,3 +0,0 @@
-output "environment" {
-  value = local.environment
-}

diff --git a/variables.tf b/variables.tf
@@ -1,4 +0,0 @@
-variable "environment" {
-  description = "Environment name"
-  type        = string
-}

diff --git a/versions.tf b/versions.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.5.3"
+  required_version = ">= 1.6.2"
   required_providers {
   }
 }