Skip to content

Commit 2fd8343

Browse files
committed
misc: update changelog and upgrade guide
1 parent 388ad4d commit 2fd8343

3 files changed

Lines changed: 83 additions & 11 deletions

File tree

.changelog/0.21.0.toml

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,12 @@ description = "The `id` attribute for the `oxide_ip_pool_silo_link` resource now
66

77
[[enhancements]]
88
title = "Validate UUID Attributes"
9-
description = "Attributes that expect UUIDs now validate whether their values are, in fact, valid UUIDs. This catches cases where names passed to attributes accidentally worked. [#795](https://github.com/oxidecomputer/terraform-provider-oxide/issues/795)."
9+
description = "Attributes that expect UUIDs now validate whether their values are, in fact, valid UUIDs. This catches cases where names passed to attributes expecting UUIDs accidentally worked. [#795](https://github.com/oxidecomputer/terraform-provider-oxide/pull/795)."
1010

1111
[[bugs]]
1212
title = "`oxide_ip_pool_silo_link`"
13-
description = "The composite `id` attribute, formatted as `IP_POOL_ID/SILO_ID`, now resolves `SILO_ID` to its UUID, even if the `silo_id` attribute was previously configured by name."
13+
description = "The `silo_id` attribute now resolves to the silo's UUID, even if the attribute was previously configured by name. [#795](https://github.com/oxidecomputer/terraform-provider-oxide/pull/795)."
1414

1515
[[bugs]]
1616
title = "`oxide_subnet_pool_silo_link`"
17-
description = "The composite `id` attribute, formatted as `SUBNET_POOL_ID/SILO_ID`, now resolves `SILO_ID` to its UUID, even if the `silo_id` attribute was previously configured by name."
18-
19-
[[bugs]]
20-
title = "`oxide_ip_pool_silo_link`"
21-
description = "The `silo_id` attribute now resolves to the silo's UUID, even if the attribute was previously configured by name."
22-
23-
[[bugs]]
24-
title = "`oxide_subnet_pool_silo_link`"
25-
description = "The `silo_id` attribute now resolves to the silo's UUID, even if the attribute was previously configured by name."
17+
description = "The `silo_id` attribute now resolves to the silo's UUID, even if the attribute was previously configured by name. [#795](https://github.com/oxidecomputer/terraform-provider-oxide/pull/795)."

docs/guides/upgrade.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,46 @@ Refer to the
1717
[changelog](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/CHANGELOG.md)
1818
for a full list of changes.
1919

20+
## Upgrading to `0.21.0`
21+
22+
Release `0.21.0` contains breaking changes that require updates to Terraform
23+
configuration files.
24+
25+
### UUID Validation
26+
27+
Attributes that expect UUIDs now validate whether their values are, in fact,
28+
valid UUIDs. This catches cases where names passed to attributes expecting UUIDs
29+
accidentally worked.
30+
31+
Terraform plans will fail with an `Invalid UUID` error on affected attributes.
32+
33+
```
34+
35+
│ Error: Invalid UUID
36+
37+
│ with oxide_ip_pool_silo_link.example,
38+
│ on main.tf line 15, in resource "oxide_ip_pool_silo_link" "example":
39+
│ 15: silo_id = "oxide"
40+
41+
│ Attribute silo_id value must be a valid UUID, got: oxide
42+
43+
```
44+
45+
Update the attribute to its UUID to comply with the validation.
46+
47+
```diff
48+
--- main.tf
49+
+++ main.tf
50+
}
51+
52+
resource "oxide_ip_pool_silo_link" "example" {
53+
- silo_id = "oxide"
54+
+ silo_id = "338bfaf2-75d3-4a1c-8850-32173960f658"
55+
ip_pool_id = "c6f8c195-8cee-40b5-bc95-7eb86edec285"
56+
is_default = false
57+
}
58+
```
59+
2060
## Upgrading to `0.20.0`
2161

2262
Release `0.20.0` contains breaking changes that require updates to Terraform

templates/guides/upgrade.md.tmpl

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,46 @@ Refer to the
1717
[changelog](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/CHANGELOG.md)
1818
for a full list of changes.
1919

20+
## Upgrading to `0.21.0`
21+
22+
Release `0.21.0` contains breaking changes that require updates to Terraform
23+
configuration files.
24+
25+
### UUID Validation
26+
27+
Attributes that expect UUIDs now validate whether their values are, in fact,
28+
valid UUIDs. This catches cases where names passed to attributes expecting UUIDs
29+
accidentally worked.
30+
31+
Terraform plans will fail with an `Invalid UUID` error on affected attributes.
32+
33+
```
34+
35+
│ Error: Invalid UUID
36+
37+
│ with oxide_ip_pool_silo_link.example,
38+
│ on main.tf line 15, in resource "oxide_ip_pool_silo_link" "example":
39+
│ 15: silo_id = "oxide"
40+
41+
│ Attribute silo_id value must be a valid UUID, got: oxide
42+
43+
```
44+
45+
Update the attribute to its UUID to comply with the validation.
46+
47+
```diff
48+
--- main.tf
49+
+++ main.tf
50+
}
51+
52+
resource "oxide_ip_pool_silo_link" "example" {
53+
- silo_id = "oxide"
54+
+ silo_id = "338bfaf2-75d3-4a1c-8850-32173960f658"
55+
ip_pool_id = "c6f8c195-8cee-40b5-bc95-7eb86edec285"
56+
is_default = false
57+
}
58+
```
59+
2060
## Upgrading to `0.20.0`
2161

2262
Release `0.20.0` contains breaking changes that require updates to Terraform

0 commit comments

Comments
 (0)