Introduction

A base package which defines all of our Terraform CDK constructs for infrastructure as code in Azure.

Getting Started

1. Prerequisites

2. CDKTF references

3. Customer Account Setup

Customer account bootstrapping is done with the following shell scripts for now:

  • /bin/bootstrap_customer_account.sh
  • /bin/bootstrap_customer_account_service_principal.sh

This bootstrap only needs to be done once. It creates the necessary Azure resources for Terraform CDK to operate:

  • A storage account to store the Terraform state file (.tfstate) which serves as the source of truth for deployed resources
  • A storage container where the .tfstate file will be saved
  • A storage account access key for Terraform to access the state file
  • A service principal that Terraform CDK can use to authenticate and manage resources in the Azure account

Completing this bootstrap gives Terraform CDK the permissions and state storage it requires to deploy and manage infrastructure in the Azure subscription. Refer to the wiki for details on performing this one-time setup process.

Build, Test, Synthesize & Deploy

  • Testing resource synthesis and deployment is done using the cdktf-cli
  • You can run cat help inside this package to learn more
  • You can also run cdktf -help for further guidance

Contribute

TODO: Explain how other users and developers can contribute to make your code better.