Skip to content

Commit

Permalink
Added some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mcasperson committed Aug 13, 2024
1 parent d53811a commit 5320655
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,23 @@ This tool prepares an Octopus space to allow space level resources and projects
* [macOS](https://github.com/mcasperson/OctoterraWizard/releases/latest/download/octoterrawiz_macos_arm64)
* [Windows](https://github.com/mcasperson/OctoterraWizard/releases/latest/download/octoterrawiz_windows_amd64.exe)

## Environment variables

* `OCTOTERRAWIZ_BACKEND_TYPE`: Either `AWS S3` or `Azure Storage`
* `AWS_ACCESS_KEY_ID`: [AWS environment variable](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
* `AWS_SECRET_ACCESS_KEY`: [AWS environment variable](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
* `AWS_DEFAULT_REGION`: [AWS environment variable](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
* `AWS_DEFAULT_BUCKET`: The name of the S3 bucket holding the Terraform state
* `OCTOTERRAWIZ_PROMPT_FOR_DELETE`: If set to `true`, the tool will prompt for confirmation before deleting resources
* `OCTOTERRAWIZ_USE_CONTAINER_IMAGES`: If set to `true`, the tool will use container images to run Terraform steps
* `OCTOTERRAWIZ_AZURE_RESOURCE_GROUP`: The name of the Azure resource group holding the Terraform state
* `OCTOTERRAWIZ_AZURE_STORAGE_ACCOUNT`: The name of the Azure storage account holding the Terraform state
* `OCTOTERRAWIZ_AZURE_CONTAINER`: The name of the Azure storage container holding the Terraform state
* `AZURE_SUBSCRIPTION_ID`: [Azure environment variable](https://azure.github.io/static-web-apps-cli/docs/cli/env-vars/)
* `AZURE_TENANT_ID`: [Azure environment variable](https://azure.github.io/static-web-apps-cli/docs/cli/env-vars/)
* `AZURE_CLIENT_ID`: [Azure environment variable](https://azure.github.io/static-web-apps-cli/docs/cli/env-vars/)
* `AZURE_CLIENT_SECRET`: [Azure environment variable](https://azure.github.io/static-web-apps-cli/docs/cli/env-vars/)

## Screenshot

![](screenshot.png)

0 comments on commit 5320655

Please sign in to comment.