Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.81 KB

README.md

File metadata and controls

58 lines (38 loc) · 1.81 KB
Raw

CDK for Terraform on Steroids(!!)

Typescript Template

This is a highly opinionated CDKTF template for Typescript that I developed to ease my IaaC management and have been using this is production environment for some time now without any hitch.

If you want to see a real-life example of how this template works, visit this repo.

Features

  • Use any supported backend (default is local).
  • Automatically autoload all stacks and its constructs (resources and data).
  • A minimal dependency injector using tsyringe.
  • Define Terraform Cloud workspace using the @Workspace(workspace: string, project?: string) decorator.
  • View all your definitions in a tree format by running npx ts-node main.ts.
  • GitHub workflows to automatically plan and apply changes (put .env file contents inside ENV_FILE_CONTENTS environment secret).

Requirements

  • Terraform: >=1.5
  • CDKTF: >=0.17
  • NodeJS: >=20.0
  • Yarn: >=1.22

Usage

  1. Create a template from this repo.
  2. Update the value for projectId inside the cdktf.json file. You can generate a random UUID from here.
  3. Install dependencies by running yarn install --frozen-lockfile.
  4. Install your required providers by running cdktf provider add <provider...>.
  5. Create your stacks.
  6. Run cdktf apply '*'.
  7. ???
  8. Profit.

Tests

You can follow these instructions to set up unit tests.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.