Skip to main content

Developer Environment Setup

Using the DevContainer in this repository​

This repository includes support for DevContainers. In order to install this into your environment, you will need to have:

Once your development environment is ready, you can simply clone this repository into your IDE. For VS Code installations, you should be prompted to reopen the workspace in a new container.

To modify the DevContainer, simply edit the devcontainer.json at the root of this repository and reload.

Using Harness Cloud Development Environments (Gitspaces)​

Harness supports the use of Cloud Development Environments (Harness Gitspaces) which can launch an interactive environment using the Harness CDE module. For more information, see the details on Harness Cloud Development Environments

Local Container Based development​

A robust Makefile configuration is included within this repository. The command file contains frequently used shortcuts and commands. To use this solution, you will need to have:

Find more information on Local Testing using make in this repository

To get the current list of available commands, type make help in a Terminal session in this directory.

debug            Loads the current directory into the container to allow running commands locally
init             Executes Terraform/Tofu `init`. Pass `migrate` to delete any local `backed.tf` and a `-migrate-state` will be performed.
plan             Executes a Terraform/Tofu `plan`
plan_output      Executes a Terraform/Tofu `plan`
plan_show        Executes a Terraform/Tofu `plan`
apply            Automatically runs a Terraform/Tofu `apply`
destroy          Automatically runs a Terraform/Tofu `destroy`
refresh          Refreshes the statefile
output           Display the Terraform/Tofu outputs | To return a single output, pass `RESOURCE=<terraform-output-name>`
fmt              Formats the Terraform files in the current directory
fmt_all          Formats all Terraform files in the entire repository
testing_cleanup  Removes the local `.terraform` and `.terraform.lock.hcl` files.
cycle            Idempotency Check. Runs the commands - init, destroy, apply, and plan
teardown         Full Suite Cleanup.  Runs the commands - destroy and testing_cleanup
all              End-to-end testing. Runs the commands - init, fmt, plan, apply, destroy, testing_cleanup
version_tests    Runs an entire suite of executions for a template based on the chose type. Supported types: terraform or tofu - e.g `type=tofu`
full_suite       Cycles a full End-to-end testing for all versions listed. Reads all versions in the .terraform_verions and .tofu_versions files.
generate         Generate a new directory using a template type. The argument `name=<new-template-name>` needs to be passed along with this command