Merge pull request #33 from Space48/make-gcp-bucket-configurable

Make GCP backend state bucket configurable, If bucket not provided then use local state

build/index.ts

@@ -11,6 +11,7 @@ export type BuildOpts = {
   region: string;
   debug: boolean;
   environment: string;
+  backend?: string;
 };
 
 export default (options: BuildOpts) => {
@@ -30,6 +31,7 @@ export default (options: BuildOpts) => {
     functionsDir: functionsOutDir,
     environment: options.environment,
     region: options.region,
+    backendBucket: options.backend,
   });
   app.synth();
 

cli/build.ts

@@ -14,6 +14,7 @@ export const cmdBuild: cliCommand = (argv) => {
     "--region": String,
     "--env": String,
     "--out-dir": String,
+    "--backend": String,
 
     // Aliases
     "-h": "--help",
@@ -40,6 +41,7 @@ export const cmdBuild: cliCommand = (argv) => {
       --region=[region] Set a valid region (defaults to europe-west2 for GCP)
       --env=[env]       Set an environment eg: production, staging, dev, uat
       --out-dir=[dir]   Set the dir for the build files
+      --backend=[path]  Path to a remote backend Terraform state
       --help, -h        Displays this message
       --debug, -d       Outputs debug logging
     For more information run a command with the --help flag
@@ -61,12 +63,14 @@ export const cmdBuild: cliCommand = (argv) => {
   const outDir = args["--out-dir"] ?? "./.build";
   const region = args["--region"] ?? "europe-west2";
   const environment = args["--env"] ?? "dev";
+  const backend = args["--backend"];
   return build({
     dir,
     outDir,
     project: (args["--project"] as unknown) as string,
     region,
     debug: !!args["--debug"],
     environment,
+    backend,
   });
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@space48/cloud-seed",
-  "version": "0.2.13",
+  "version": "0.3.0",
   "description": "Cloud infrastructure automation tool that uses Terraform CDK.",
   "main": "dist/index.js",
   "bin": {

stacks/gcp/GcpStack.ts

@@ -1,6 +1,6 @@
 import fs from "fs";
 import { Construct } from "constructs";
-import { GcsBackend, TerraformStack } from "cdktf";
+import { GcsBackend, LocalBackend, TerraformStack } from "cdktf";
 import {
   CloudfunctionsFunction,
   CloudfunctionsFunctionIamMember,
@@ -25,7 +25,6 @@ const defaultStackOptions: StackOptions = {
   functionsDir: ".build/functions",
   environment: "dev",
   region: "europe-west2",
-  backendBucket: "s48-terraform-state",
 };
 
 export default class GcpStack extends TerraformStack {
@@ -41,11 +40,17 @@ export default class GcpStack extends TerraformStack {
       ...options,
     };
 
-    // Configure the remote backend where state will be stored.
-    new GcsBackend(this, {
-      bucket: this.options.backendBucket,
-      prefix: this.options.backendPrefix,
-    });
+    // If bucket is defined,
+    // then configure the remote backend where state will be stored,
+    // else use a local backend.
+    this.options.backendBucket?.length
+      ? new GcsBackend(this, {
+          bucket: this.options.backendBucket,
+          prefix: this.options.backendPrefix,
+        })
+      : new LocalBackend(this, {
+          path: path.join(this.options.functionsDir + "../"),
+        });
 
     // Configure the Google Provider.
     new GoogleProvider(this, "GoogleAuth", {

stacks/gcp/types.ts

@@ -4,7 +4,7 @@ export type StackOptions = {
   functionsDir: string;
   environment: string;
   region: string;
-  backendBucket: string;
+  backendBucket?: string;
   backendPrefix?: string;
 };