From bf97010ff8fc2071dfad2ef1eb847556e987f128 Mon Sep 17 00:00:00 2001 From: Khue Doan Date: Wed, 4 Aug 2021 01:14:55 +0700 Subject: [PATCH] Convert help to README --- infra/cdk/README.md | 33 +++++++++++++++++++++++++++++++++ infra/cdk/help | 24 ------------------------ 2 files changed, 33 insertions(+), 24 deletions(-) create mode 100644 infra/cdk/README.md delete mode 100644 infra/cdk/help diff --git a/infra/cdk/README.md b/infra/cdk/README.md new file mode 100644 index 00000000..01ab29f3 --- /dev/null +++ b/infra/cdk/README.md @@ -0,0 +1,33 @@ +# Terraform CDK + +## Usage + +Compile: + +```sh +go build # Builds your go project +``` + +Synthesize: + +```sh +cdktf synth [stack] # Synthesize Terraform resources to cdktf.out/ +``` + +Diff: + +```sh +cdktf diff [stack] # Perform a diff (terraform plan) for the given stack +``` + +Deploy: + +```sh +cdktf deploy [stack] # Deploy the given stack +``` + +Destroy: + +```sh +cdktf destroy [stack] # Destroy the given stack +``` diff --git a/infra/cdk/help b/infra/cdk/help deleted file mode 100644 index 8640d244..00000000 --- a/infra/cdk/help +++ /dev/null @@ -1,24 +0,0 @@ -======================================================================================================== - - Your cdktf go project is ready! - - cat help Prints this message - - Compile: - go build Builds your go project - - Synthesize: - cdktf synth [stack] Synthesize Terraform resources to cdktf.out/ - - Diff: - cdktf diff [stack] Perform a diff (terraform plan) for the given stack - - Deploy: - cdktf deploy [stack] Deploy the given stack - - Destroy: - cdktf destroy [stack] Destroy the given stack - - Learn more about using modules and providers https://cdk.tf/modules-and-providers - -======================================================================================================== \ No newline at end of file