Merge pull request #4 from seanturner026/terraform-module

Modularised repo for terraform
seanturner026 · May 22, 2021 · 162831a · 162831a
2 parents a2dffdb + 6479b1e
commit 162831a
Show file tree

Hide file tree

Showing 27 changed files with 56 additions and 104 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,31 @@ This solution utilises the following services:
   - S3 + Cloudfront (frontend)
   - SSM Parameter Store (secrets management)
 
+#### Installation
+
+```hcl
+module "moot" {
+  source = "github.com/seanturner026/moot.git?ref=v1.0.0"
+
+  name                           = "moot"
+  admin_user_email               = var.admin_user_email
+  enable_delete_admin_user       = false
+  github_token                   = var.github_token
+  gitlab_token                   = var.gitlab_token
+  slack_webhook_url              = var.slack_webhook_url
+  fqdn_alias                     = "moot.link"
+  hosted_zone_name               = "moot.link"
+  enable_api_gateway_access_logs = true
+  tags                           = var.tags
+}
+```
+
+#### Workflows
+
+- Standard Deploy: Merges the HEAD branch into the BASE (e.g. main) branch, creates release based on BASE branch
+- Hotfix Deploy: Creates release based on the BASE branch
+
+
 #### Repositories View
 
 ![alt text](https://github.com/seanturner026/moot/blob/main/assets/repositories.png?raw=true)
@@ -27,3 +52,33 @@ This solution utilises the following services:
 #### Users View
 
 ![alt text](https://github.com/seanturner026/moot/blob/main/assets/users.png?raw=true)
+
+## Terraform Providers
+
+| Name | Version |
+|------|---------|
+| archive | n/a |
+| aws | n/a |
+| external | n/a |
+| null | n/a |
+
+## Terraform Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| admin\_user\_email | Controls the creation of an admin user that is required to initially gain access to the<br>dashboard.<br><br>If access to the dashboard is completely lost, do the following<br>• `var.enable_delete_admin_user = true`<br>• `terraform apply`<br>• `var.enable_delete_admin_user = false`<br>• `terraform apply`<br><br>If the initial admin user should no longer be able to access the dashboard, revoke access by<br>setting `var.enable_delete_admin_user = true` and running `terraform apply` | `string` | `""` | no |
+| enable\_api\_gateway\_access\_logs | Enables API Gateway access logging to cloudwatch for the default stage. | `bool` | `false` | no |
+| enable\_delete\_admin\_user | Destroys the admin user.<br><br>Set this value to true to destroy the user, and to false to recreate the user. | `bool` | `false` | no |
+| fqdn\_alias | ALIAS for the Cloudfront distribution, S3, Cognito and API Gateway. Must be in the form of<br>`example.com`. | `string` | `""` | no |
+| github\_token | Token for Github. | `string` | `""` | no |
+| gitlab\_token | Token for Gitlab. | `string` | `""` | no |
+| hosted\_zone\_name | Name of AWS Route53 Hosted Zone for DNS. | `string` | `""` | no |
+| name | Name to be applied to all resources. | `string` | `"release_dashboard"` | no |
+| slack\_webhook\_url | URL to send slack message payloads to. | `string` | `""` | no |
+| tags | Map of tags to be applied to resources. | `map(string)` | `{}` | no |
+
+## Terraform Outputs
+
+| Name | Description |
+|------|-------------|
+| cloudfront\_domain\_name | FQDN of Cloudfront Distribution that can be used for DNS. |
diff --git a/deployments/terraform/data.tf → data.tf b/deployments/terraform/data.tf → data.tf
diff --git a/deployments/terraform/.terraform.lock.hcl b/deployments/terraform/.terraform.lock.hcl
diff --git a/deployments/terraform/README.md b/deployments/terraform/README.md
diff --git a/deployments/terraform/locals.tf → locals.tf b/deployments/terraform/locals.tf → locals.tf
diff --git a/deployments/terraform/modules.tf → modules.tf b/deployments/terraform/modules.tf → modules.tf
diff --git a/deployments/terraform/outputs.tf → outputs.tf b/deployments/terraform/outputs.tf → outputs.tf
diff --git a/deployments/terraform/r_acm.tf → r_acm.tf b/deployments/terraform/r_acm.tf → r_acm.tf
diff --git a/deployments/terraform/r_api_gateway.tf → r_api_gateway.tf b/deployments/terraform/r_api_gateway.tf → r_api_gateway.tf
diff --git a/deployments/terraform/r_cloudwatch.tf → r_cloudwatch.tf b/deployments/terraform/r_cloudwatch.tf → r_cloudwatch.tf
diff --git a/deployments/terraform/r_cognito.tf → r_cognito.tf b/deployments/terraform/r_cognito.tf → r_cognito.tf
diff --git a/deployments/terraform/r_dynamodb.tf → r_dynamodb.tf b/deployments/terraform/r_dynamodb.tf → r_dynamodb.tf
diff --git a/deployments/terraform/r_iam.tf → r_iam.tf b/deployments/terraform/r_iam.tf → r_iam.tf
diff --git a/deployments/terraform/r_lambda.tf → r_lambda.tf b/deployments/terraform/r_lambda.tf → r_lambda.tf
diff --git a/deployments/terraform/r_null.tf → r_null.tf b/deployments/terraform/r_null.tf → r_null.tf
diff --git a/deployments/terraform/r_route53.tf → r_route53.tf b/deployments/terraform/r_route53.tf → r_route53.tf
diff --git a/deployments/terraform/r_s3.tf → r_s3.tf b/deployments/terraform/r_s3.tf → r_s3.tf
diff --git a/deployments/terraform/r_ssm.tf → r_ssm.tf b/deployments/terraform/r_ssm.tf → r_ssm.tf
diff --git a/deployments/terraform/assets/cognito.go → terraform_assets/assets/cognito.go b/deployments/terraform/assets/cognito.go → terraform_assets/assets/cognito.go
diff --git a/...aform/assets/cognito_invite_template.html → ...ssets/assets/cognito_invite_template.html b/...aform/assets/cognito_invite_template.html → ...ssets/assets/cognito_invite_template.html
diff --git a/...aform/assets/dynamodb_put_item_input.json → ...ssets/assets/dynamodb_put_item_input.json b/...aform/assets/dynamodb_put_item_input.json → ...ssets/assets/dynamodb_put_item_input.json
diff --git a/...orm/examples/complete/.terraform.lock.hcl → ...orm_examples/complete/.terraform.lock.hcl b/...orm/examples/complete/.terraform.lock.hcl → ...orm_examples/complete/.terraform.lock.hcl
diff --git a/...ments/terraform/examples/complete/main.tf → terraform_examples/complete/main.tf b/...ments/terraform/examples/complete/main.tf → terraform_examples/complete/main.tf
@@ -1,4 +1,4 @@
-module "dashboard" {
+module "moot" {
   source = "../../"
 
   name                           = "moot"

diff --git a/...s/terraform/examples/complete/provider.tf → terraform_examples/complete/provider.tf b/...s/terraform/examples/complete/provider.tf → terraform_examples/complete/provider.tf
diff --git a/...raform/examples/complete/terraform.tfvars → terraform_examples/complete/terraform.tfvars b/...raform/examples/complete/terraform.tfvars → terraform_examples/complete/terraform.tfvars
diff --git a/.../terraform/examples/complete/variables.tf → terraform_examples/complete/variables.tf b/.../terraform/examples/complete/variables.tf → terraform_examples/complete/variables.tf
diff --git a/deployments/terraform/variables.tf → variables.tf b/deployments/terraform/variables.tf → variables.tf