Tax Benefits Backend

Infrastructure configuration for Tax Benefits services.

Requirements

The configurations are written in HCL and support both OpenTofu and the equivalent version of Terraform.

Usage

Local

To run the configurations locally, you will need to have AWS credentials loaded from Identity Center, an Aptible SSO token, and OpenTofu installed.

Navigate to the configuration you would like to plan or apply, then run the plan command to see what changes will be made:

cd tofu/config/backend # Replace with the appropriate configuration
tofu init
tofu plan -o tfplan.out

Review the plan output. If the changes are acceptable, apply the changes:

tofu apply tfplan.out

GitHub Actions

You can also run the configurations using GitHub Actions. There are two workflows that can be called manually: plan.yaml and deploy.yaml. These workflows can be run directly from GitHub by following their links.

Additionally, these workflows can be triggered using the GitHub CLI (where config is the name of a directory under tofu/config/):

gh workflow run <workflow>.yaml -f config=backend

You can then run gh run list --workflow <workflow>.yaml to see the status of the execution and get its id. With this id, you can watch the run and get the logs:

gh run watch <run-id>
gh run view <run-id> --log

To run the workflow for a branch other than main, you can pass the --ref <branch-name> flag.