docs: new dev doc for terraform (#105)

Signed-off-by: Di Wang <[email protected]>

Author: hemslo

.dockerignore

@@ -3,6 +3,6 @@ module/.terraform/
 module/.terraform*
 module/*.tftest.hcl
 module/backend.tf
-module/tfvars.json
+module/terraform.tfvars.json
 module/plan
 module/plan.json

.env.example

@@ -1,2 +1,3 @@
-AWS_SHARED_CREDENTIALS_FILE=
-ER_INPUT_FILE=
+AWS_SHARED_CREDENTIALS_FILE=credentials
+INPUT_FILE=input.json
+PLAN_FILE_JSON=module/plan.json

.gitignore

@@ -166,7 +166,6 @@ cython_debug/
 # MacOS
 .DS_Store
 
-cdktf.out
 input.json
 credentials
 tmp/
@@ -176,6 +175,6 @@ tmp/
 module/.terraform/
 module/.terraform.*
 module/backend.tf
-module/tfvars.json
+module/terraform.tfvars.json
 module/plan
 module/plan.json

Dockerfile

@@ -44,7 +44,7 @@ COPY tests ./tests
 RUN make test
 
 FROM base AS prod
-# get cdktf providers
+# get terraform providers
 COPY --from=builder ${TF_PLUGIN_CACHE_DIR} ${TF_PLUGIN_CACHE_DIR}
 # get our app with the dependencies
 COPY --from=builder ${APP} ${APP}

README.md

@@ -4,7 +4,7 @@ External Resources module to provision and manage RDS instances in AWS with App-
 
 ## Tech stack
 
-* Terraform CDKTF
+* Terraform
 * AWS provider
 * Random provider
 * Python 3.12
@@ -56,32 +56,25 @@ export $(cat .env | xargs)
 
 ### On Host
 
-Ensure `cdktf` is installed
-
-```shell
-npm install --global [email protected]
-```
-
 Generate terraform config.
 
 ```shell
-ER_INPUT_FILE="$PWD"/input.json cdktf synth
+generate-tf-config
 ```
 
 Ensure AWS credentials set in current shell, then use `terraform` to verify.
 
 ```shell
-cd cdktf.out/stakcs/CDKTF
+cd module
 terraform init
 terraform plan -out=plan
 terraform show -json plan > plan.json
 ```
 
-Test validation logic
+Test hooks
 
 ```shell
-cd ../../..
-ER_INPUT_FILE="$PWD"/input.json python hooks/validate_plan.py cdktf.out/stacks/CDKTF/plan.json
+hooks/post_plan.py
 ```
 
 ### In Container
@@ -100,27 +93,12 @@ docker run --rm -ti \
   -v $PWD/input.json:/inputs/input.json:Z \
   -v $PWD/credentials:/credentials:Z \
   -e AWS_SHARED_CREDENTIALS_FILE=/credentials \
+  -e WORK=/tmp/work \
   er-aws-rds:prod
 ```
 
-Generate terraform config.
-
-```shell
-cdktf synth
-```
-
-Use `terraform` to verify.
-
-```shell
-cd cdktf.out/stakcs/CDKTF
-terraform init
-terraform plan -out=plan
-terraform show -json plan > plan.json
-```
-
-Test validation logic
+Run the whole process
 
 ```shell
-cd ../../..
-python hooks/validate_plan.py cdktf.out/stacks/CDKTF/plan.json
+./entrypoint.sh
 ```