Initial commit

Author: andreouellet

.gitignore

@@ -0,0 +1,29 @@
+# Local .terraform directories
+**/.terraform/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# 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
+
+# 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
+
+# Include override files you do wish to add to version control using negated pattern
+#
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.75.0
+    hooks:
+      - id: terraform_fmt
+      - id: terraform_docs
+        args: ['--args=--lockfile=false']
+      - id: terraform_tflint
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: detect-private-key

README.md

@@ -0,0 +1,57 @@
+# DevSecOps Dev Kit - Template terraform module
+
+Template of terraform module
+
+## Features
+
+## Usage
+
+## (Resource) Best Practices
+
+## Examples
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_null"></a> [null](#requirement\_null) | >= 3.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_null"></a> [null](#provider\_null) | >= 3.0 |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [null_resource.template_null_resource](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to all resources. | `map(string)` | `{}` | no |
+| <a name="input_template_variable_boolean"></a> [template\_variable\_boolean](#input\_template\_variable\_boolean) | Template variable of type boolean | `bool` | `true` | no |
+| <a name="input_template_variable_map"></a> [template\_variable\_map](#input\_template\_variable\_map) | Template variable of type map | `map(string)` | `{}` | no |
+| <a name="input_template_variable_number"></a> [template\_variable\_number](#input\_template\_variable\_number) | Template variable of type number | `number` | `123` | no |
+| <a name="input_template_variable_string"></a> [template\_variable\_string](#input\_template\_variable\_string) | Template variable of type boolean | `string` | `""` | no |
+| <a name="input_triggers"></a> [triggers](#input\_triggers) | A map of arbitrary strings that, when changed, will force the null resource to be replaced, re-running any associated provisioners | `map(string)` | `{}` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_template_null_resource_id"></a> [template\_null\_resource\_id](#output\_template\_null\_resource\_id) | The ID of the null resource |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+## Authors
+
+## License

examples/README.md

@@ -0,0 +1,52 @@
+# DevSecOps Dev Kit - Template terraform module example
+
+This example creates 3 null resources.
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```
+
+After testing with this example is completed, run ```$ terraform destroy```
+
+## Authors
+
+* andreouellet
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_null"></a> [null](#requirement\_null) | >= 3.0 |
+
+## Providers
+
+No providers.
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_template_null_resource"></a> [template\_null\_resource](#module\_template\_null\_resource) | ../ | n/a |
+
+## Resources
+
+No resources.
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_template_null_resource_id"></a> [template\_null\_resource\_id](#output\_template\_null\_resource\_id) | The ID of the null resource |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/deploy.tf

@@ -0,0 +1,19 @@
+provider "null" {
+}
+
+#provider "aws" {
+#  region = "ca-central-1"
+#}
+
+##################################################
+# Null Resource Module
+##################################################
+
+module "template_null_resource" {
+  source = "../"
+
+  triggers = {
+    name    = "dsodk-template-code-terraform-module"
+    trigger = "Change this text to trigger the module to replace null resources with new ones"
+  }
+}

examples/outputs.tf

@@ -0,0 +1,4 @@
+output "template_null_resource_id" {
+  description = "The ID of the null resource"
+  value       = module.template_null_resource.template_null_resource_id
+}

examples/variables.tf

@@ -0,0 +1,14 @@
+terraform {
+  required_version = ">= 1.0"
+
+  required_providers {
+    #    aws = {
+    #      source  = "hashicorp/aws"
+    #      version = ">= 4.0"
+    #    },
+    null = {
+      source  = "hashicorp/null"
+      version = ">= 3.0"
+    }
+  }
+}

examples/versions.tf

@@ -0,0 +1,5 @@
+resource "null_resource" "template_null_resource" {
+  count = 3
+
+  triggers = var.triggers
+}

main.tf

@@ -0,0 +1,4 @@
+output "template_null_resource_id" {
+  description = "The ID of the null resource"
+  value       = try(null_resource.template_null_resource[0].id, "")
+}