Clean up docs, remove hardcoded tags (#1)

Author: cdaniluk

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+---
+repos:
+- repo: git://github.com/antonbabenko/pre-commit-terraform
+  rev: v1.19.0
+  hooks:
+    - id: terraform_fmt
+    - id: terraform_docs
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.3.0
+  hooks:
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+    - id: no-commit-to-branch

README.md

@@ -1,13 +1,29 @@
 # terraform-aws-backend
-Creates a backend S3 bucket and DynamoDB table for managing Terraform state
-
-## Required Variables
-* `region`
-* `namespace`
-* `owner`
-* `bucket`
-* `table`
-
-## Optional Variables
-* `extra_tags` = `{}`
-* `env` = `global`
+
+[![](https://github.com/rhythmictech/terraform-aws-backend/workflows/check/badge.svg)](https://github.com/rhythmictech/terraform-aws-backend/actions)
+
+Creates a backend S3 bucket and DynamoDB table for managing Terraform state. Useful for bootstrapping a new
+environment.
+
+## Usage
+```
+module "backend" {
+  source    = "git::ssh://git@github.com/rhythmictech/terraform-aws-backend"
+  bucket    = "project-tfstate"
+  region    = "us-east-1"
+  table     = "tf-locktable"
+}
+
+```
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| bucket | Name of bucket to create | string | n/a | yes |
+| region |  | string | n/a | yes |
+| table | Name of Dynamo Table to create | string | n/a | yes |
+| tags | Mapping of any extra tags you want added to resources | map(string) | `{}` | no |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

main.tf

@@ -3,8 +3,7 @@ resource "aws_s3_bucket" "config_bucket" {
   acl    = "log-delivery-write"
 
   tags = merge(
-    local.common_tags,
-    var.extra_tags,
+    var.tags,
     {
       "Name" = "tf-state"
     },
@@ -56,11 +55,9 @@ resource "aws_dynamodb_table" "terraform_statelock" {
   }
 
   tags = merge(
-    local.common_tags,
-    var.extra_tags,
+    var.tags,
     {
       "Name" = "tf-locktable"
     },
   )
 }
-

variables.tf

@@ -1,45 +1,23 @@
 data "aws_caller_identity" "current" {
 }
 
-locals {
-  common_tags = {
-    namespace = var.namespace
-    owner     = var.owner
-    env       = var.env
-  }
+variable "bucket" {
+  description = "Name of bucket to create"
+  type        = string
 }
 
 variable "region" {
   type = string
 }
 
-variable "namespace" {
-  type = string
-}
-
-variable "owner" {
-  type = string
-}
-
-variable "env" {
-  type    = string
-  default = "global"
+variable "table" {
+  description = "Name of Dynamo Table to create"
+  type        = string
 }
 
-variable "extra_tags" {
+variable "tags" {
   description = "Mapping of any extra tags you want added to resources"
   type        = map(string)
   default = {
   }
 }
-
-variable "bucket" {
-  description = "Name of bucket to create"
-  type        = string
-}
-
-variable "table" {
-  description = "Name of Dynamo Table to create"
-  type        = string
-}
-