Clean up docs (#1)

rhythmictech · Jan 14, 2020 · 053ca09 · 053ca09
1 parent 1b64857
commit 053ca09
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 19 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,7 +4,6 @@ repos:
   rev: v1.19.0
   hooks:
     - id: terraform_fmt
-    - id: terraform_tflint
     - id: terraform_docs
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v2.3.0

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Rhythmic Technologies, Inc.
+Copyright (c) 2020 Rhythmic Technologies, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -10,10 +10,9 @@ Enable VPC Flowlogs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-
-## Outputs
-
-| Name | Description |
-|------|-------------|
+| logging\_bucket | S3 bucket to send request logs to the VPC flow log bucket to | string | n/a | yes |
+| region | Region VPC flow logs will be sent to | string | n/a | yes |
+| tags | Tags to include on resources that support it | map(string) | `{}` | no |
+| vpc\_ids | List of VPCs to enable flow logging for | list(string) | n/a | yes |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/bucket.tf b/bucket.tf
@@ -1,9 +1,9 @@
 
 
 resource "aws_s3_bucket" "vpcflowlog_bucket" {
-  bucket    = "${local.account_id}-${var.region}-vpcflowlog"
-  acl       = "private"
-  tags      = var.tags
+  bucket = "${local.account_id}-${var.region}-vpcflowlog"
+  acl    = "private"
+  tags   = var.tags
 
   versioning {
     enabled = true
@@ -75,4 +75,4 @@ resource "aws_s3_bucket_policy" "vpcflowlog_bucket_policy" {
 }
 EOF
 
-}
+}
diff --git a/variables.tf b/variables.tf
@@ -5,20 +5,23 @@ locals {
   account_id = data.aws_caller_identity.current.account_id
 }
 
-variable "tags" {
-  default = {}
-  type    = map(string)
+variable "logging_bucket" {
+  description = "S3 bucket to send request logs to the VPC flow log bucket to"
+  type        = string
 }
 
 variable "region" {
-  type = string
+  description = "Region VPC flow logs will be sent to"
+  type        = string
 }
 
-variable "logging_bucket" {
-  type = string
+variable "tags" {
+  default     = {}
+  description = "Tags to include on resources that support it"
+  type        = map(string)
 }
 
 variable "vpc_ids" {
-  type = list(string)
+  description = "List of VPCs to enable flow logging for"
+  type        = list(string)
 }
-