SLT - Member Example

An example "member" repository of the Storm Library for Terraform

Storm Library for Terraform

This repository is a member of the SLT | Storm Library for Terraform, a collection of Terraform modules for Amazon Web Services. The focus of these modules, maintained in separate GitHub™ repositories, is on building examples, demos and showcases on AWS. The audience of the library is learners and presenters alike - people that want to know or show how a certain service, pattern or solution looks like, or "feels".

Learn more

Installation

This demo can be built using GitHub Actions. In order to do so

• Install the Storm Library for Terraform
• Deploy this member repository

Deployment of this member should take < 2 minutes on GitHub resources.

Architecture

Explore this demo

This is not so much a demo but rather a very simple example of a "member" repository of the Storm Library for Terraform. It also serves for testing the SLT - you should deploy (apply in Terraform speak) this member right after installation of the Storm Library for Terraform in order to convince yourself that everything is working as expected and to study the concepts behind the SLT.

The only resource deployed from this repository is an aws_security_group. Note the deployment tags attached to it. They provide useful metadata about your deployment as being triggered by the GitHub workflow, like deployment-time, deployment-commit, deployment-actor and other useful information. Also note that the Name of the resource is using a very unique pattern, starting with slt-, a catalog id, the name of the demo, and the GitHub user that deployed it. These two concepts are applied to every member of the Storm Library for Terraform.

Terraform Docs

Click to show

Requirements

Name	Version
terraform	>= 1
aws	>= 6

Providers

Name	Version
aws	>= 6

Modules

No modules.

Resources

Name	Type
aws_security_group.test	resource

Inputs

Name	Description	Type	Default	Required
_metadata	Select metadata passed from GitHub Workflows	object({ actor = string # Github actor (deployer) of the deployment catalog_id = string # SLT catalog id of this module deployment = string # slt-<catalod_id>-- ref = string # Git reference of the deployment ref_name = string # Git ref_name (branch) of the deployment repo = string # GitHub short repository name (without owner) of the deployment repository = string # GitHub full repository name (including owner) of the deployment sha = string # Git (full-length, 40 char) commit SHA of the deployment short_name = string # slt-<catalog_id>- time = string # Timestamp of the deployment })	{ "actor": "", "catalog_id": "", "deployment": "", "ref": "", "ref_name": "", "repo": "", "repository": "", "sha": "", "short_name": "", "time": "" }	no
my_variable	A variable to be set either by default or from demo.tfvars	string	"set by default"	no

Outputs

Name	Description
_slt_config	Map of SLT configuration
_summary	Key-value pairs to be published in the GITHUB_STEP_SUMMARY
my_variable	The value of my_variable