deployer

Terraform Example Foundation deploy helper

Helper tool to deploy the Terraform example foundation.

Usage

• Check if required tools, Go 1.18+, Terraform 1.3.0+, gcloud 393.0.0+, and Git 2.28.0+, are installed:

  go version
  
  terraform -version
  
  gcloud --version
  
  git --version
  

• Create a directory in the file system to host the Cloud Source repositories the will be created and a copy of the terraform example foundation.

• Clone the terraform-example-foundation repository on this directory.

  deploy-directory/
  └── terraform-example-foundation
  

• Copy the file global.tfvars.example as global.tfvars to the same directory.

  deploy-directory/
  └── global.tfvars
  └── terraform-example-foundation
  

• Update global.tfvars with values from your environment. See the READMEs for the stages for additional information:

  • 0-bootstrap
  • 1-org
  • 2-environments
  • 3-networks-dual-svpc
  • 3-networks-hub-and-spoke
  • 4-projects
  • 5-app-infra

• Variable code_checkout_path is the full path to deploy-directory directory.

• Variable foundation_code_path is the full path to terraform-example-foundation directory.

• Build the helper:

  go build
  

• Validate the tfvars file:

  ./deployer -tfvars_file <PATH TO 'global.tfvars' FILE> -validate
  

Supported flags

  -tfvars_file file
        Full path to the Terraform .tfvars file with the configuration to be used.
  -steps_file file
        Path to the steps file to be used to save progress. (default ".steps.json")
  -list_steps
        List the existing steps.
  -reset_step step
        Name of a step to be reset.
  -validate
        Validate tfvars file inputs
  -quiet
        If true, additional output is suppressed.
  -disable_prompt
        Disable interactive prompt.
  -destroy
        Destroy the deployment.
  -help
        Prints this help text and exits.

Requirements

• Go 1.18+
• Google Cloud SDK version 393.0.0+
• Git version 2.28.0+
• Terraform version 1.3.0+
• See 0-bootstrap README for additional IAM requirements on the user deploying the Foundation.