Skip to content

Commit b7a7de1

Browse files
committed
chore: Add initial upgrade guide to capture changes
1 parent d364ef1 commit b7a7de1

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

docs/UPGRADE-10.0.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Upgrade from v9.x to v10.x
2+
3+
If you have any questions regarding this upgrade process, please consult the `examples` directory.
4+
If you find a bug, please open an issue with supporting configuration to reproduce.
5+
6+
## List of backwards incompatible changes
7+
8+
- Terraform `v1.11` is now minimum supported version to support write-only (`wo_*`) attributes.
9+
- AWS provider `v6.18` is now minimum supported version
10+
- The underlying `aws_security_group_rule` resources has been replaced with `aws_vpc_security_group_ingress_rule` and `aws_vpc_security_group_egress_rule` to allow for more flexibility in defining security group rules.
11+
12+
## Additional changes
13+
14+
### Added
15+
16+
- Support for `region` argument to specify the AWS region for the resources created if different from the provider region.
17+
18+
### Modified
19+
20+
- Variable definitions now contain detailed object types in place of the previously used `any` type
21+
22+
### Removed
23+
24+
- None
25+
26+
### Variable and output changes
27+
28+
1. Removed variables:
29+
30+
-
31+
32+
2. Renamed variables:
33+
34+
-
35+
36+
3. Added variables:
37+
38+
-
39+
40+
4. Removed outputs:
41+
42+
-
43+
44+
5. Renamed outputs:
45+
46+
-
47+
48+
6. Added outputs:
49+
50+
-
51+
52+
## Upgrade Migrations
53+
54+
### Before 9.x Example
55+
56+
```hcl
57+
module "cluster" {
58+
source = "terraform-aws-modules/rds-aurora/aws"
59+
version = "~> 9.0"
60+
61+
# Only the affected attributes are shown
62+
63+
64+
tags = {
65+
Environment = "dev"
66+
Terraform = "true"
67+
}
68+
}
69+
```
70+
71+
### After 10.x Example
72+
73+
```hcl
74+
module "cluster" {
75+
source = "terraform-aws-modules/rds-aurora/aws"
76+
version = "~> 10.0"
77+
78+
# Only the affected attributes are shown
79+
80+
tags = {
81+
Environment = "dev"
82+
Terraform = "true"
83+
}
84+
}
85+
```
86+
87+
### State Changes

0 commit comments

Comments
 (0)