https://github.com/launchbynttdata/lcaf-skeleton-terraform
Terraform Skeleton Module
https://github.com/launchbynttdata/lcaf-skeleton-terraform
launch-common-automation-framework lcaf platform-automation skeleton terraform
Last synced: 2 months ago
JSON representation
Terraform Skeleton Module
- Host: GitHub
- URL: https://github.com/launchbynttdata/lcaf-skeleton-terraform
- Owner: launchbynttdata
- License: apache-2.0
- Created: 2024-03-18T19:47:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-24T17:13:30.000Z (3 months ago)
- Last Synced: 2025-01-24T18:21:02.870Z (3 months ago)
- Topics: launch-common-automation-framework, lcaf, platform-automation, skeleton, terraform
- Language: Makefile
- Homepage:
- Size: 296 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# TF Module Skeleton
[](https://opensource.org/licenses/Apache-2.0)
[](https://creativecommons.org/licenses/by-nc-nd/4.0/)
## Overview
This repository contains a reference terraform module
## How to Use This Repo
This repo is intended to be used as a template for any new TF module. In some cases, we're able to use our VCS to template for us. In other cases, we aren't.
### Prerequisites
- [asdf](https://github.com/asdf-vm/asdf) used for tool version management
- [make](https://www.gnu.org/software/make/) used for automating various functions of the repo
- [repo](https://android.googlesource.com/tools/repo) used to pull in all components to create the full repo template
### Repo Init
Run the following command to prep repo and enable all `Makefile` commands to run
```shell
make configure
```
### Templating
#### Manual Templating
This applies to systems like Azure DevOps and CodeCommit.
We need to clone the repo, rename it, and start a fresh git history to get rid of the `lcaf-skeleton-terraform` history. Below is a loose explanation of how to do this.
``` shell
git clone
mv lcaf-skeleton-terraform tf-
cd tf-
rm -rf .git
git init
vi .git/HEAD
Change the HEAD to point to `main` instead of `master` and save the `HEAD`
```
#### Remove Educational Material
We need to clear out the example code (different from the boilerplate code). We want to save the repo structure; we don't need the contents. There are `examples`, and `tests` that apply to the boilerplate that we're not going to need as developers of new modules.
Note before you clear these things out, it's useful to actually understand what they are and why they're there. We'll be building our own as we go forward so we need to know what it is we're removing. If this isn't your first module, it's safe to fly through this. If this is your first (or your first several, even), take the time to read the code before you remove it.
```shell
cd path/to/this/repo
rm -rf examples/*
rm -rf README.md
mv TEMPLATED_README.md README.md
```
#### Version Control (VCS) Templating
This applies to systems like GitHub.
TBD
### Repo Setup
#### Overriding Make Behavior
When run, `make` will look for a file called `.lcafenv` in the repository root. This file if present will be included, and it can be used to override variables without altering the [Makefile](Makefile). A few examples of variables that can be substituted are commented out in [the file](.lcafenv).
#### Module Configuration
- You'll need to update [`versions.tf`](./versions.tf) based on your provider needs.
## Explanation of the Skeleton
### Resources and Providers
- Terraform modules define resources that can be instantiated via provider
- Possible providers include but are not limited to `aws`, `azurerm`, and `gcp`
- In this module we generate text resources with the `random` provider
### Module Guidelines
- Each repository should have a default module in its root
- Should have default values and be instantiable with minimal to no inputs
- We can think of these default values as the "default example"
- A `Makefile` provides tasks for terraform module development
- It will clone and cache `lcaf-component-tf-module` and `lcaf-component-platform` git repositories when a `make configure` is ran
- For clearing cached components, it provides a `make clean` command
- Linter config and all other tasks are defined in `lcaf-component-tf-module`
- An `examples` folder contains example uses of the default and nested modules
- There should be at least one example for each nested module
- A `tests` folder contains Go functional tests
- Make pre-deploy tests that validate terraform plan json where applicable
- Make post-deploy tests that validate the deployment where applicable
- Provider should be configured by the user, not the module
- Modules only define what providers/versions are required
### Go Functional Tests
- Modules are how Go manages dependencies
- To initiate a new modules run the command: `go mod init [repo_url]`
- It is recommended to use the absolute repository url (e.g. github.com/launchbynttdata/lcaf-skeleton-terraform)
- Relative path is highly discouraged in Go, use absolute path to import a package
- (e.g. `github.com/launchbynttdata/lcaf-skeleton-terraform/[path_to_file]`)
- To update paths or versions run the command: `go get -t ./...` go will update the dependencies accordingly
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | ~> 1.0 |
| [random](#requirement\_random) | ~> 3.6 |
## Providers
| Name | Version |
|------|---------|
| [random](#provider\_random) | 3.6.3 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [random_string.string](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [length](#input\_length) | n/a | `number` | `24` | no |
| [number](#input\_number) | n/a | `bool` | `true` | no |
| [special](#input\_special) | n/a | `bool` | `false` | no |
## Outputs
| Name | Description |
|------|-------------|
| [string](#output\_string) | n/a |