Skip to content

Commit fc3faf5

Browse files
committed
ENH: Set default environment value to default
BREAKING CHANGE: If you weren't using the `environment` variable before, set it to `main` to keep the previous default functionality. The `TWINED_SERVICES_TOPIC_NAME` must also be set to `main`.
1 parent 85d3608 commit fc3faf5

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,17 @@ If you're happy with the plan, run:
4646
terraform apply
4747
```
4848
and approve the run. This will create resources whose names/IDs are prefixed with `<environment>-` where `<environment>`
49-
is `main` by default.
49+
is `default` by default.
5050

5151
> [!IMPORTANT]
52-
> If you're using an environment other than `main` [(see below)](#environments), then before using the
52+
> If you're using an environment other than `default` [(see below)](#environments), then before using the
5353
> [Twined CLI/SDK](https://github.com/octue/octue-sdk-python) to ask any questions to your Twined services, set the
5454
> `TWINED_SERVICES_TOPIC_NAME` environment variable to the value of the [`services_topic_name`](#output-reference)
5555
> Terraform output.
5656
5757
## Environments
5858
The suggested way of managing environments is via [Terraform workspaces](https://developer.hashicorp.com/terraform/language/state/workspaces).
59-
You can get started right away with the `main` environment by removing the `environment` input to the module.
59+
You can get started right away with the `default` environment by removing the `environment` input to the module.
6060

6161
To create and used other environments, see the example configuration below. It contains a `locals` block that
6262
automatically generates the environment name from the name of the current Terraform workspace by taking the text after
@@ -217,7 +217,7 @@ terraform destroy
217217
| `google_cloud_project_id` | `string` | Yes | N/A |
218218
| `google_cloud_region` | `string` | Yes | N/A |
219219
| `maintainer_service_account_names` | `set(string)` | No | `["default"]` |
220-
| `environment` | `string` | No | `"main"` |
220+
| `environment` | `string` | No | `"default"` |
221221
| `maximum_event_handler_instances` | `number` | No | `100` |
222222
| `maximum_service_registry_instances` | `number` | No | `10` |
223223
| `deletion_protection` | `bool` | No | `true` |

VERSION.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.2.2
1+
0.3.0

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ variable "maintainer_service_account_names" {
1919

2020
variable "environment" {
2121
type = string
22-
default = "main"
22+
default = "default"
2323
description = "The name of the environment to deploy the resources in (must be one word with no hyphens or underscores in). This can be derived from a Terraform workspace name and used to facilitate e.g. testing and staging environments alongside the production environment ('main')."
2424
}
2525

0 commit comments

Comments
 (0)