Initial commit

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: ci
+
+on:
+  push:
+    branches:
+    - '*'
+    - '*/*'
+    - '**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Install Go
+      uses: actions/setup-go@v1
+      with: 
+        go-version: 1.16
+
+    - name: Cache go modules
+      uses: actions/cache@v2
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+
+    - name: Install Terraform
+      uses: hashicorp/setup-terraform@v1 
+      with:
+        terraform_version: 1.0.0
+        terraform_wrapper: false
+
+    - name: Check formatting
+      run: terraform fmt -check -recursive
+
+    - name: Run tests
+      run: make test

.gitignore

@@ -0,0 +1,32 @@
+
+# Local .terraform directories
+**/.terraform/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+*.terraform.lock.hcl
+
+# Crash log files
+crash.log
+
+# Ignore any .tfvars files that are generated automatically for each Terraform run. Most
+# .tfvars files are managed as part of configuration and so should be included in
+# version control.
+#
+# example.tfvars
+*.tfvars
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Credentials Files
+**/credentials.json
+**/*.json
+
+/.idea/
+.DS_Store

CHANGELOG

@@ -0,0 +1,3 @@
+Version 0.1.0 (2024-xx-xx)
+--------------------------
+Initial release

LICENSE

@@ -0,0 +1,57 @@
+# Snowplow Limited Use License Agreement
+
+_Version 1.0, January 2024_
+
+This Snowplow Limited Use License Agreement, Version 1.0 (the “Agreement”) sets forth the terms on which Snowplow Analytics, Ltd. (“Snowplow”) makes available certain software (the “Software”). BY INSTALLING, DOWNLOADING, ACCESSING, OR USING ANY OF THE SOFTWARE, YOU AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO SUCH TERMS AND CONDITIONS, YOU MUST NOT USE THE SOFTWARE. IF YOU ARE RECEIVING THE SOFTWARE ON BEHALF OF A LEGAL ENTITY, YOU REPRESENT AND WARRANT THAT YOU HAVE THE ACTUAL AUTHORITY TO AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT ON BEHALF OF SUCH ENTITY. “Licensee” means you, an individual, or the entity on whose behalf you are receiving the Software.
+
+## LICENSE GRANT AND CONDITIONS
+
+**1.1 License.** Subject to the terms and conditions of this Agreement, Snowplow hereby grants to Licensee a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicensable license during the term of this Agreement to: (a) use the Software; (b) prepare modifications and derivative works of the Software; and (c) reproduce copies of the Software (the “License”). No right to distribute or make available the Software is granted under this License. Licensee is not granted the right to, and Licensee shall not, exercise the License for any Excluded Purpose.
+
+**1.2** For purposes of this Agreement, an “Excluded Purpose” is any use that is either a Competing Use or a Highly-Available Production Use, or both of them.
+
+* **1.2.1** A “Competing Use” is making available any on-premises or distributed software product, or any software-as-a-service, platform-as-a-service, infrastructure-as-a-service, or other similar online service, that competes with any products or services that Snowplow or any of its affiliates provides using the Software.
+
+* **1.2.2** Highly-Available Production Use is any highly-available use, including without limitation any use where multiple instances of any Software component run concurrently to avoid a single point of failure, in a production environment, where production means use on live data.
+
+**1.3 Conditions.** In consideration of the License, Licensee’s use of the Software is subject to the following conditions:
+
+* **a.** Licensee must cause any Software modified by Licensee to carry prominent notices stating that Licensee modified the Software.
+
+* **b.** On each Software copy, Licensee shall reproduce and not remove or alter all Snowplow or third party copyright or other proprietary notices contained in the Software, and Licensee must include the notice below on each copy.
+
+  ```
+  This software is made available by Snowplow Analytics, Ltd.,
+  under the terms of the Snowplow Limited Use License Agreement, Version 1.0
+  located at https://docs.snowplow.io/limited-use-license-1.0
+  BY INSTALLING, DOWNLOADING, ACCESSING, USING OR DISTRIBUTING ANY PORTION
+  OF THE SOFTWARE, YOU AGREE TO THE TERMS OF SUCH LICENSE AGREEMENT.
+  ```
+
+**1.4 Licensee Modifications.** Licensee may add its own copyright notices to modifications made by Licensee.
+
+**1.5 No Sublicensing.** The License does not include the right to sublicense the Software, however, each recipient to which Licensee provides the Software may exercise the Licenses so long as such recipient agrees to the terms and conditions of this Agreement.
+
+## TERM AND TERMINATION
+
+This Agreement will continue unless and until earlier terminated as set forth herein. If Licensee breaches any of its conditions or obligations under this Agreement, this Agreement will terminate automatically and the License will terminate automatically and permanently.
+
+## INTELLECTUAL PROPERTY
+
+As between the parties, Snowplow will retain all right, title, and interest in the Software, and all intellectual property rights therein. Snowplow hereby reserves all rights not expressly granted to Licensee in this Agreement. Snowplow hereby reserves all rights in its trademarks and service marks, and no licenses therein are granted in this Agreement.
+
+## DISCLAIMER
+
+SNOWPLOW HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.
+
+## LIMITATION OF LIABILITY
+
+SNOWPLOW WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING SHALL APPLY TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+
+## GENERAL
+
+**6.1 Governing Law.** This Agreement will be governed by and interpreted in accordance with the laws of the state of Delaware, without reference to its conflict of laws principles. If Licensee is located within the United States, all disputes arising out of this Agreement are subject to the exclusive jurisdiction of courts located in Delaware, USA. If Licensee is located outside of the United States, any dispute, controversy or claim arising out of or relating to this Agreement will be referred to and finally determined by arbitration in accordance with the JAMS International Arbitration Rules. The tribunal will consist of one arbitrator. The place of arbitration will be in the State of Delaware, USA. The language to be used in the arbitral proceedings will be English. Judgment upon the award rendered by the arbitrator may be entered in any court having jurisdiction thereof.
+
+**6.2. Assignment.** Licensee is not authorized to assign its rights under this Agreement to any third party. Snowplow may freely assign its rights under this Agreement to any third party.
+
+**6.3. Other.** This Agreement is the entire agreement between the parties regarding the subject matter hereof. No amendment or modification of this Agreement will be valid or binding upon the parties unless made in writing and signed by the duly authorized representatives of both parties. In the event that any provision, including without limitation any condition, of this Agreement is held to be unenforceable, this Agreement and all licenses and rights granted hereunder will immediately terminate. Waiver by Snowplow of a breach of any provision of this Agreement or the failure by Snowplow to exercise any right hereunder will not be construed as a waiver of any subsequent breach of that right or as a waiver of any other right.

Makefile

@@ -0,0 +1,7 @@
+.PHONY: test tidy
+
+test:
+	GO111MODULE=on go test ./... -v
+
+tidy:
+	GO111MODULE=on go mod tidy

README.md

@@ -0,0 +1,43 @@
+[![Release][release-image]][release] [![CI][ci-image]][ci] [![License][license-image]][license] [![Registry][registry-image]][registry] [![Source][source-image]][source]
+
+# terraform-PROJECT_FULL_NAME
+
+A Terraform module for EXPLAIN YOURSELF.
+
+## Usage
+
+```hcl
+INSERT USAGE EXAMPLE HERE
+```
+
+## Testing
+
+Ensure that `terraform` is installed on your path and matches or exceeds the required version.  Then simply run:
+
+```bash
+make tidy && make test
+```
+
+__REPLACE ME__: `terraform-docs markdown table ./ --sort-by required`
+
+# Copyright and license
+
+Copyright 2024-present Snowplow Analytics Ltd.
+
+Licensed under the [Snowplow Limited Use License Agreement][license]. _(If you are uncertain how it applies to your use case, check our answers to [frequently asked questions][license-faq].)_
+
+[release]: https://github.com/snowplow-devops/terraform-PROJECT_NAME/releases/latest
+[release-image]: https://img.shields.io/github/v/release/snowplow-devops/terraform-PROJECT_NAME
+
+[ci]: https://github.com/snowplow-devops/terraform-PROJECT_NAME/actions?query=workflow%3Aci
+[ci-image]: https://github.com/snowplow-devops/terraform-PROJECT_NAME/workflows/ci/badge.svg
+
+[license]: https://docs.snowplow.io/limited-use-license-1.0/
+[license-image]: https://img.shields.io/badge/license-Snowplow--Limited--Use-blue.svg?style=flat
+[license-faq]: https://docs.snowplow.io/docs/contributing/limited-use-license-faq/
+
+[registry]: https://registry.terraform.io/modules/snowplow-devops/PROJECT_NAME/PROVIDER/latest
+[registry-image]: https://img.shields.io/static/v1?label=Terraform&message=Registry&color=7B42BC&logo=terraform
+
+[source]: https://github.com/snowplow/snowplow
+[source-image]: https://img.shields.io/static/v1?label=Snowplow&message=PROJECT%20NAME&color=0E9BA4&logo=GitHub

examples/complete/README.md

@@ -0,0 +1,11 @@
+## A heading here
+
+A description of this module
+
+```hcl
+module "thing" {
+  source = "snowplow-devops/PROJECT_NAME/aws"
+
+  # variables?
+}
+```

examples/complete/main.tf

@@ -0,0 +1,9 @@
+module "example" {
+  source = "../../"
+
+  # Arguments?
+}
+
+output "value" {
+  value = module.example.value
+}

examples/complete/versions.tf

@@ -0,0 +1,3 @@
+terraform {
+  required_version = ">= 0.15"
+}

go.mod

@@ -0,0 +1,10 @@
+module github.com/snowplow-devops/terraform-PROJECT_NAME
+
+go 1.16
+
+require (
+	github.com/gruntwork-io/terratest v0.36.3
+	github.com/stretchr/testify v1.7.0
+	golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 // indirect
+	golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect
+)