@pocket-tools/terraform-modules
v5.17.2
Published
This is a collection of terraform typescript cdk modules that @Pocket uses in various services.
Downloads
842
Readme
terraform-modules
This is a collection of terraform typescript cdk modules that @Pocket uses in various services.
Why?
Our goals for this project are as follows:
- To have as little infrastructure code as possible in repos.
- To have as little duplicated infrastructure code as possible in repos.
- To provide reasonable defaults for our most common AWS services.
- To provide an as-simple-as-possible-while-still-configurable API to our most common AWS services by abstraction.
Repository Structure
The bulk of the code for this repository is broken up into two folders:
/src/base
: Contains abstractions of AWS services, e.g. an ECS or Redis Cluster, or an SQS Queue/src/pocket
: Contains higher level abstractions that are specific to Pocket's infrastructure, e.g. an ALB-backed application or our PagerDuty config
See the README
file in each of these respective directories to learn more. (Coming soon.)
Testing
Snapshot Testing
Snapshot testing ensures that our components produce predictable output when synthesized.
When a snapshot test is first run, it generates a snapshot (in a __snapshots__
directory) that is used to compare future synthesizing against a known, expected output. If a component changes, it's likely that the expected snapshot should change. If you are making a PR that changes a component, you should also update the related snapshot file. This can be done by running the test command with additional flags instructing Jest to re-build the snapshot based on the new state of the component:
npm test -- -u
The above will update any necessary snapshot files to be used on future test runs.
As you can infer from the above, snapshots do not test the actual infrastructure result of running the synthesized terraform, meaning components should be tested manually (see below) to ensure they are performing the expected tasks prior to writing snapshot tests.
Testing in AWS
While snapshot testing is great for things like regressions, it doesn't actually tell us if the code we've provided (e.g. the configuration of a particular AWS service) can be built in AWS.
You can use the existing example.ts
file to test the modules in this repo.
- Install tfenv
- Run
tfenv use
to ensure you are on the same terraform version this repo is built for (defined in.terraform-version
). - Run
npm install
- Run
npm run build:dev
cd
into the generatedcdktf.out/stacks/acme-example
directory- Run
terraform init
- Run
terraform validate
to validate the generated JSON (debugging level 1)
To test against our infrastructure (debugging level 2):
- Log into terraform
terraform login
if not already. You will be prompted to save an API token. - Run
$(maws)
and select the 👉dev👈 backend SSO role (triple check that you are in DEV) - Run
terraform plan
, alternately in repo root runcdktf plan
- Check one more time that you are in the dev account
- Check with your teammates that it's okay to blow up the dev infra, then run
terraform apply
, alternately in repo root runcdktf apply
- Clean up your mess by running
terraform destroy
when you're all done, alternately in repo root runcdktf destroy
Note that this isn't a full end-to-end verification, and will hang on domain certificate steps, but the above should surface most generated terraform issues.
Testing in Dependent Repos
Sometimes it is useful to develop the module while consuming it in another repo.
- Run
npm link
in the root of this repo - In the consumer repo run
npm link @pocket-tools/terraform-modules
- In this repo run
npm run watch
- Profit in the consumer repo - meaning, test deploying your application to AWS (probably in the dev account)
When you are done be sure to:
npm unlink
in this reponpm unlink @pocket-tools/terraform-modules
in the consuming repo