Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gruntwork-io/terraform-aws-utilities
A collection of useful Terraform utilities
https://github.com/gruntwork-io/terraform-aws-utilities
Last synced: 3 months ago
JSON representation
A collection of useful Terraform utilities
- Host: GitHub
- URL: https://github.com/gruntwork-io/terraform-aws-utilities
- Owner: gruntwork-io
- License: apache-2.0
- Created: 2017-03-07T14:41:28.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T02:41:11.000Z (7 months ago)
- Last Synced: 2024-05-28T07:01:35.524Z (6 months ago)
- Language: HCL
- Size: 10.6 MB
- Stars: 212
- Watchers: 22
- Forks: 77
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://gruntwork.io/?ref=repo_package_terraform_utilities)
[](https://github.com/gruntwork-io/terraform-aws-utilities/releases/latest)
# Terraform Utility Modules
This repo contains miscellaneous utility and helper modules for use with Terraform.
## What is in this repo
This repo provides a Gruntwork IaC Package and has the following folder structure:
* [modules](/modules): This folder contains the main implementation code for this repository, broken down into multiple
standalone modules.
* [examples](/examples): This folder contains examples of how to use the modules.
* [test](/test): Automated tests for the modules and examples.
The following modules are available:
* [join-path](/modules/join-path): This module can be used to join a list of given path parts into a single path that is
platform/operating system aware. **(This module requires Python)**
* [operating-system](/modules/operating-system): This module can be used to figure out what operating system is being
used to run Terraform. **(This module requires Python)**
* [require-executable](/modules/require-executable): This is a module that can be used to ensure particular executables
is available in the `PATH`. **(This module requires Python)**
* [run-pex-as-data-source](/modules/run-pex-as-data-source): This module prepares a portable environment for running PEX
files and runs them as an external data source. PEX files are python executables that contain all the requirements
necessary to run the script. **(This module requires Python)**
* [run-pex-as-resource](/modules/run-pex-as-resource): This module prepares a portable environment for running PEX files
and runs them as an local-exec provisioner on a null_resource. PEX files are python executables that contain all the
requirements necessary to run the script. **(This module requires Python)**
The following modules were deprecated and removed:
* `intermediate-variable`: This module has been superseded by [terraform local
values](https://www.terraform.io/docs/configuration/locals.html). To upgrade, switch usage of `intermediate-variable`
with `locals`.
* `enabled-aws-regions`: This module has been superseded by [terraform aws_regions data
source](https://www.terraform.io/docs/providers/aws/d/regions.html). To upgrade, switch the module block with:
data "aws_regions" "enabled_regions" {}
Then, you can get the list of enabled regions using `data.aws_regions.enabled_regions.names`.
Click on each module above to see its documentation. Head over to the [examples](/examples) folder for example usage.
## What is a module?
A Module is a canonical, reusable, best-practices definition for how to run a single piece of infrastructure, such as a
database or server cluster. Each Module is written using a combination of Terraform and scripts (mostly bash) and
include automated tests, documentation, and examples. It is maintained both by the open source community and companies
that provide commercial support.
Instead of figuring out the details of how to run a piece of infrastructure from scratch, you can reuse existing code
that has been proven in production. And instead of maintaining all that infrastructure code yourself, you can leverage
the work of the Module community to pick up infrastructure improvements through a version number bump.
## Who maintains this Module?
This Module is maintained by [Gruntwork](http://www.gruntwork.io/). If you're looking for help or commercial
support, send an email to [[email protected]](mailto:[email protected]?Subject=Terraform%20Utilities%20Module).
Gruntwork can help with:
* Setup, customization, and support for this Module.
* Modules for other types of infrastructure, such as VPCs, Docker clusters, databases, and continuous integration.
* Modules that meet compliance requirements, such as HIPAA.
* Consulting & Training on AWS, Terraform, and DevOps.
## How is this Module versioned?
This Module follows the principles of [Semantic Versioning](http://semver.org/). You can find each new release,
along with the changelog, in the [Releases Page](../../releases).
During initial development, the major version will be 0 (e.g., `0.x.y`), which indicates the code does not yet have a
stable API. Once we hit `1.0.0`, we will make every effort to maintain a backwards compatible API and use the MAJOR,
MINOR, and PATCH versions on each release to indicate any incompatibilities.
## License
Please see [LICENSE.txt](/LICENSE.txt) and [NOTICE](/NOTICE) for details on how the code in this repo is licensed.