Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 2.31 KB

README.md

File metadata and controls

69 lines (43 loc) · 2.31 KB
Raw

Base Terraform

Creates the foundational infrastructure for the application's infrastructure. These Terraform files will create a remote state and a registry. Most other infrastructure pieces will be created within the environments directory.

Included Files

  • main.tf
    The main entry point for the Terraform run.

  • variables.tf
    Common variables to use in various Terraform files.

  • state.tf
    Generate a remote state bucket in S3 for use with later Terraform runs.

  • ecr.tf
    Creates an AWS Elastic Container Registry (ECR) for the application.

Usage

Typically, the base Terraform will only need to be run once, and then should only need changes very infrequently.

# Sets up Terraform to run
$ terraform init

# Executes the Terraform run
$ terraform apply

Variables

Name Description Type Default Required
app Name of the application. This value should usually match the application tag below. string yes
aws_profile The AWS profile to use, this would be the same value used in AWS_PROFILE. string yes
image_tag_mutability The tag mutability setting for the repository. string IMMUTABLE
region The AWS region to use for the bucket and registry. string us-east-1
saml_role The role that will have access to the S3 bucket, this should be a role that all members of the team have access to. string yes
tags A map of the tags to apply to various resources. The required tags are:
+ application, name of the app
+ environment, the environment being created
+ team, team responsible for the application
+ contact-email, contact email for the team
+ customer, who the application was create for		 map <map> yes

Outputs

Name Description
bucket Returns the name of the S3 bucket that will be used in later Terraform files
docker_registry Returns the name of the ECR registry, this will be used later in various scripts

Additional Information