Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hashicorp/learn-terraform-aft-global-customizations
https://github.com/hashicorp/learn-terraform-aft-global-customizations
aws hashicorp terraform tutorial
Last synced: about 2 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/hashicorp/learn-terraform-aft-global-customizations
- Owner: hashicorp
- License: mpl-2.0
- Created: 2021-11-23T16:54:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-20T16:48:02.000Z (over 1 year ago)
- Last Synced: 2024-09-19T06:15:11.122Z (5 days ago)
- Topics: aws, hashicorp, terraform, tutorial
- Language: Jinja
- Homepage: https://learn.hashicorp.com/tutorials/terraform/aws-control-tower-aft
- Size: 9.77 KB
- Stars: 12
- Watchers: 13
- Forks: 782
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Learn Terraform - Use Control Tower Account Factory for Terraform
This is a companion repository for the Hashicorp [Provision and Manage Accounts with
Control Tower Account Factory for Terraform
tutorial](https://developer.hashicorp.com/terraform/tutorials/aws/aws-control-tower-aft).
This repository contains boilerplate configuration for defining global
customizations to use with the Account Factory for Terraform
module. The README below and the template files in this repository were
provided by AWS.
To create your global customizations, replicate this repository
and extend the Terraform configuration.
## Introduction
This repo stores the Terraform and API helpers for the Global Customizations. Global Customizations are used to customize all provisioned accounts with customer defined resources. The resources can be created through Terraform or through Python, leveraging the API helpers. The customization run is parameterized at runtime.
## Usage
To leverage Global Customizations, populate this repo as per the instructions below.
### Terraform
AFT provides Jinja templates for Terraform backend and providers. These render at the time Terraform is applied. If needed, additional providers can be defined by creating a providers.tf file.
To create Terraform resources, provide your own Terraform files (ex. main.tf, variables.tf, etc) with the resources you would like to create, placing them in the 'terraform' directory.
### API Helpers
The purpose of API helpers is to perform actions that cannot be performed within Terraform.
#### Python
The api_helpers/python folder contains a requirements.txt, where you can specify libraries/packages to be installed via PIP.
#### Bash
This is where you define what runs before/after Terraform, as well as the order the Python scripts execute, along with any command line parameters. These bash scripts can be extended to perform other actions, such as leveraging the AWS CLI or performing additional/custom Bash scripting.
- pre-api-helpers.sh - Actions to execute prior to running Terraform.
- post-api-helpers.sh - Actions to execute after running Terraform.
#### Sample api-helpers.sh
Sample #1 - Using AWS CLI to query for resources, save to a variable, and then pass to a script. In the example below, all running instances are queried, stopped, and started using AWS CLI and custom Python scritpts.
```
instances=$(aws ec2 describe-instances --filters "Name=instance-state-name,Values=running")
python ./python/source/stop_instances.py --instances $instances
sleep 10s
python ./python/source/start_instances.py --instances $instances
```
Sample #2 - Query a 3rd party IPAM solution, and save the given CIDR to AWS Parameter Store. This SSM parameter could be leveraged from Terraform using a data object to create a VPC.
```
account = $(aws sts get-caller-identity --query Account --output text)
region = $(aws ec2 describe-availability-zones --query 'AvailabilityZones[0].[RegionName]' --output text)
cidr = $(python ./python/source/get_cidr_range.py)
aws ssm put-parameter --name /$account/$region/vpc/cidr --value $cidr
```