Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
drewmullen committed Oct 25, 2023
1 parent 586a336 commit 82aa00f
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions .header.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,24 @@ It can also accept `var.workspaces.<>.vars` which can accept variable declaratio

This module allows you to specify variables in 3 different ways:

1. Attach a pre-created [variable set id](https://www.terraform.io/cloud-docs/api-docs/variable-sets) to each workspace
1. Declare variables within `shared_variable_set` as `{key = value}` to be shared to each workspace.
1. Attach a pre-created [variable set id](https://www.terraform.io/cloud-docs/api-docs/variable-sets) to each workspace with the key `shared_variable_set_ids`.
1. Specify on a per-workspace using the nested map structure below

```terraform
module "multi_region_deployment" {
source = "../.."
source = "aws-ia/workspace-orchestrator/tfe"
...
shared_variable_set_ids = [
data.tfe_variable_set.creds.id,
]
workspaces = {
eastcoast = {
vars = {
AWS_REGION = {
value = "us-east-1"
# category = "env" # unnecessary, default behavior
}
my_tf_var = {
value = "test"
Expand All @@ -44,6 +49,7 @@ module "multi_region_deployment" {
}
westcoast = {...}
}
}
```

## Examples
Expand All @@ -63,15 +69,6 @@ vcs_repo = {
oauth_token_id = "<oauth token from TFC>"
branch = "master"
}
shared_variable_set = {
"test" = { value = 123 }
"test2" = { value = 123 }
workspace_name = {
value = "test"
category = "terraform"
}
}
```

## Known Issues
Expand Down

0 comments on commit 82aa00f

Please sign in to comment.