Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 3.63 KB

DEVELOPMENT.md

File metadata and controls

109 lines (81 loc) · 3.63 KB
Raw

DEVELOPMENT

Requirements

Setup

pre-commit install
git secrets --install
git secrets --register-aws

Documentation

Documentation is generated with terraform-docs. The config file is stored at .config/.terraform-docs.yml. See: https://github.com/terraform-docs/terraform-docs. Run terraform-docs markdown ./ from the root of the repository to regenerate the README files.

Running an example

Change to a example folder: cd examples/slurm.required/ Initialize terraform: terraform init Run a plan: terraform plan -out tfplan Apply the plan: terraform apply tfplan

Terraform State Management

Terraform state may contain some sensitive data about your resources. By default, Terraform stores state files locally, which is an insecure practice. In order to secure state files, all the examples are configured to use S3 as Terraform Backend, so that state files are not stored locally, but on S3.

When running terraform init, you will be prompted to specify an existing S3 bucket in us-east-1 to store state files. To customize the S3 destination without being prompted, you can define a backend file terraform.tfbackend with the following content:

bucket = "my-bucket"
key    = "path/to/example/example_name/terraform.tfstate"
region = "my-region"

and run terraform init -backend-config=terraform.tfbackend.

Alternatively, you can pass settings one by one to terraform init as follows:

terraform init \
-backend-config="bucket=my-bucket" \
-backend-config="key=path/to/example/example_name/terraform.tfstate"
-backend-config="region=my-region"

Testing

Tests require a connection to an AWS account so they cannot be considered unit tests. No resources are currently created. To run tests initialize terraform and run the test command. Tests exist in the main module and each submodule.

Example running tests for the main module. From the root of the repository run:

terraform init
terraform test

Example runnings tests for the required infra submodule:

cd ./modules/required_infra
terraform init
terraform test

Checks

Fix terraform code by using the terraform fmt command.

From the root of the project run: terraform fmt -recursive ./

To check without fixing use: terraform fmt -recursive -check ./

Examples

Three examples exist inside the ./examples folder. By default these examples will deploy resources using the default profile in us-east-1. If customization is needed variables can be changed using a tfvars file.

To customize first create a terraform.tfvars similar to the following in one of the example folders:

profile  = "some_profile"
role = "some_role"
region = "us-west-2"

The profile, role, and region correspond to the variables defined in the example. Depending on the example different variables can be set. The variable definitions can be found in the variables.tf file. It is also possible to use standard AWS cli environment variables to set these. For example, AWS_PROFILE, AWS_ROLE, AWS_REGION may be set in the environment.

Then run an init, plan, and apply to try out an example:

terraform init
terraform plan -out tfplan
terraform apply tfplan

Tools

To clean up your local Terraform environment by removing the directories and files created by Terraform as part of the init, plan, apply phases, run:

bash tools/clean.sh