first commit

Author: cdaniluk

.github/workflows/pre-commit-check.yaml

@@ -0,0 +1,22 @@
+---
+name: pre-commit-check
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: macOS-latest
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Install prerequisites
+      run: |
+        brew install tfenv tflint terraform-docs pre-commit
+        pre-commit install
+        tfenv install
+    - name: pre-commit run all
+      run: |
+        pre-commit run -a

.gitignore

@@ -0,0 +1,9 @@
+#  Local .terraform directories
+**/.terraform/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# .tfvars files
+*.tfvars

.pre-commit-config.yaml

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

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,43 @@
+# terraform-anycloud-template [![](https://github.com/rhythmictech/terraform-anycloud-template/workflows/pre-commit-check/badge.svg)](https://github.com/rhythmictech/terraform-anycloud-template/actions) <a href="https://twitter.com/intent/follow?screen_name=RhythmicTech"><img src="https://img.shields.io/twitter/follow/RhythmicTech?style=social&logo=RhythmicTech" alt="follow on Twitter"></a>
+Template repository for terraform modules. Good for any cloud and any provider.
+
+## Example
+Here's what using the module will look like
+```
+module "example" {
+  source = "rhythmictech/terraform-mycloud-mymodule
+}
+```
+
+## About
+A bit about this module
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+No requirements.
+
+## Providers
+
+No provider.
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| name | Moniker to apply to all resources in the module | `string` | n/a | yes |
+| tags | User-Defined tags | `map(string)` | `{}` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| tags\_module | Tags Module in it's entirety |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+## The Giants underneath this module
+- pre-commit.com/
+- terraform.io/
+- github.com/tfutils/tfenv
+- github.com/segmentio/terraform-docs

bin/install-macos.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+echo 'installing brew packages'
+brew install tfenv tflint terraform-docs pre-commit
+
+echo 'installing pre-commit hooks'
+pre-commit install
+
+echo 'installing terraform with tfenv'
+tfenv install

examples/basic/README.md

@@ -0,0 +1,59 @@
+# basic example
+A basic example for this repository
+
+## Code
+Look to [main.tf](./main.tf), or be helpful and copy/paste that code here.
+
+## Applying
+```
+>  alias tf="terraform"
+>  tf apply
+
+Apply complete! Resources: 0 added, 0 changed, 0 destroyed.
+
+Outputs:
+
+example = {
+  "tags_module" = {
+    "name" = "TEST"
+    "name32" = "TEST"
+    "name6" = "TEST"
+    "namenosymbols" = "TEST"
+    "tags" = {
+      "Name" = "TEST"
+      "terraform_managed" = true
+      "terraform_module" = "terraform-terraform-tags-1.0.0"
+      "terraform_root_module" = "."
+      "terraform_workspace" = "default"
+    }
+    "tags_as_list_of_maps" = [
+      {
+        "key" = "Name"
+        "value" = "TEST"
+      },
+      {
+        "key" = "terraform_managed"
+        "value" = true
+      },
+      {
+        "key" = "terraform_module"
+        "value" = "terraform-terraform-tags-1.0.0"
+      },
+      {
+        "key" = "terraform_root_module"
+        "value" = "."
+      },
+      {
+        "key" = "terraform_workspace"
+        "value" = "default"
+      },
+    ]
+    "tags_no_name" = {
+      "terraform_managed" = true
+      "terraform_module" = "terraform-terraform-tags-1.0.0"
+      "terraform_root_module" = "."
+      "terraform_workspace" = "default"
+    }
+  }
+}
+```

examples/basic/main.tf

@@ -0,0 +1,10 @@
+
+module "example" {
+  source = "../.."
+
+  name = "test"
+}
+
+output "example" {
+  value = module.example
+}

main.tf

@@ -0,0 +1,9 @@
+
+module "tags" {
+  source  = "rhythmictech/tags/terraform"
+  version = "1.0.0"
+
+  enforce_case = "UPPER"
+  names        = [var.name]
+  tags         = var.tags
+}

outputs.tf

@@ -0,0 +1,5 @@
+
+output "tags_module" {
+  description = "Tags Module in it's entirety"
+  value       = module.tags
+}