Skip to content

Commit 63411d3

Browse files
DavidS-ovmactions-user
authored andcommitted
Eng 2679 phase 6 documentation for terraform aws source module (#3960)
Re-do https://github.com/overmindtech/workspace/pull/3959 as the change was merged out of order and got lost in rebasing; this depends on https://github.com/overmindtech/workspace/pull/3958 getting merged first. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation and workflow tooling changes only; no runtime code paths or security-sensitive logic are modified. > > **Overview** > Updates Terraform AWS source module documentation and publishing references to use the new registry address `overmindtech/aws-source/overmind`, and adds clearer module development/testing guidance. > > Adds customer-facing docs at `docs.overmind.tech/docs/sources/aws/terraform.md`, expands the module README with import instructions, and introduces `aws-source/module/.cursor/BUGBOT.md` review rules to keep IAM policy changes read-only and Terraform provider errors using `diag.Diagnostics`. > > Enhances `.cursor/commands/open-pull-request.md` to capture an approved plan from Linear tickets and require a PR section explicitly documenting *deviations from the approved plan*. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 9356970fb0d18ac929d804484030d0cafa6621f5. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> GitOrigin-RevId: 1a5dc90ab5d93ecf70bf377cf58172a34f763314
1 parent 04ac8ad commit 63411d3

File tree

3 files changed

+21
-7
lines changed

3 files changed

+21
-7
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ provider "aws" {
1818
}
1919
2020
module "overmind_aws_source" {
21-
source = "overmindtech/aws-source-setup/overmind"
21+
source = "overmindtech/aws-source/overmind"
2222
2323
name = "production"
2424
}
@@ -41,7 +41,7 @@ module "overmind_aws_source" {
4141
| `source_id` | UUID of the Overmind source |
4242
| `external_id` | AWS STS external ID used in the trust policy |
4343

44-
## Multi-account example
44+
## Multi-Account Example
4545

4646
Use AWS provider aliases to onboard several accounts at once:
4747

@@ -61,7 +61,7 @@ provider "aws" {
6161
}
6262
6363
module "overmind_production" {
64-
source = "overmindtech/aws-source-setup/overmind"
64+
source = "overmindtech/aws-source/overmind"
6565
name = "production"
6666
6767
providers = {
@@ -71,7 +71,7 @@ module "overmind_production" {
7171
}
7272
7373
module "overmind_staging" {
74-
source = "overmindtech/aws-source-setup/overmind"
74+
source = "overmindtech/aws-source/overmind"
7575
name = "staging"
7676
regions = ["eu-west-1"]
7777
@@ -82,6 +82,20 @@ module "overmind_staging" {
8282
}
8383
```
8484

85+
## Importing Existing Sources
86+
87+
If you already created an Overmind AWS source through the UI and want to manage it
88+
with Terraform, you can import it using the source UUID (visible on the source
89+
details page in [Settings > Sources](https://app.overmind.tech/settings/sources)):
90+
91+
```shell
92+
terraform import module.overmind_aws_source.overmind_aws_source.this <source-uuid>
93+
```
94+
95+
After importing, run `terraform plan` to verify the state matches your
96+
configuration. Terraform will show any drift between the imported resource and
97+
your HCL.
98+
8599
## Authentication
86100

87101
The Overmind provider reads `OVERMIND_API_KEY` from the environment. The API key

examples/multi-account/main.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ provider "aws" {
1919
}
2020

2121
module "overmind_production" {
22-
source = "overmindtech/aws-source-setup/overmind"
22+
source = "overmindtech/aws-source/overmind"
2323
name = "production"
2424

2525
providers = {
@@ -29,7 +29,7 @@ module "overmind_production" {
2929
}
3030

3131
module "overmind_staging" {
32-
source = "overmindtech/aws-source-setup/overmind"
32+
source = "overmindtech/aws-source/overmind"
3333
name = "staging"
3434
regions = ["eu-west-1"]
3535

examples/single-account/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ provider "aws" {
55
}
66

77
module "overmind_aws_source" {
8-
source = "overmindtech/aws-source-setup/overmind"
8+
source = "overmindtech/aws-source/overmind"
99

1010
name = "production"
1111
}

0 commit comments

Comments
 (0)