Skip to content

Commit 4686c38

Browse files
modular-magicianslevenick
authored andcommitted
Minor amendments to the upgrade guide (#5409) (#3817)
Signed-off-by: Modular Magician <[email protected]>
1 parent 419a6ec commit 4686c38

File tree

2 files changed

+34
-27
lines changed

2 files changed

+34
-27
lines changed

.changelog/5409.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:none
2+
3+
```

website/docs/guides/version_4_upgrade.html.markdown

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -172,11 +172,13 @@ Previously users could specify `trace-append` or `trace-ro` as scopes for a give
172172
However, to better align with [Google documentation](https://cloud.google.com/sdk/gcloud/reference/alpha/compute/instances/set-scopes#--scopes), `trace` will now be the only valid scope, as it's an alias for `trace.append` and
173173
`trace-ro` is no longer a documented option.
174174

175-
## Datasource: `google_product_resource`
175+
## Datasource: `google_kms_key_ring`
176176

177-
### Datasource-level change example
177+
### `id` now matches the `google_kms_key_ring` id format
178178

179-
Description of the change and how users should adjust their configuration (if needed).
179+
The format has changed to better match the resource's ID format.
180+
181+
Interpolations based on the `id` of the datasource may require updates.
180182

181183
## Resource: `google_bigquery_job`
182184

@@ -345,7 +347,19 @@ This resource would fail to deploy without this field defined. Specify the
345347

346348
### `source_disk_link` is now removed
347349

348-
Removed in favor of `source_disk`.
350+
Removed, as the information available was redundant. You can reconstruct a
351+
compatible value based on `source_disk` and `zone`. With a reference such as the
352+
following:
353+
354+
```
355+
google_compute_snapshot.my_snapshot.source_disk_link
356+
```
357+
358+
Substitute the following:
359+
360+
```
361+
"projects/${google_compute_snapshot.my_snapshot.project}/zones/${google_compute_snapshot.my_snapshot.zone}/disks/${google_compute_snapshot.my_snapshot.source_disk}"
362+
```
349363

350364
## Resource: `google_kms_crypto_key`
351365

@@ -359,14 +373,6 @@ Removed in favor of `id`.
359373

360374
Removed in favor of `id`.
361375

362-
## Datasource: `google_kms_key_ring`
363-
364-
### `id` now matches the `google_kms_key_ring` id format
365-
366-
The format has changed to better match the resource's ID format.
367-
368-
Interpolations based on the `id` of the datasource may require updates.
369-
370376
## Resource: `google_data_loss_prevention_trigger`
371377

372378
### Exactly one of `inspect_job.0.storage_config.0.cloud_storage_options.0.file_set.0.url` or `inspect_job.0.storage_config.0.cloud_storage_options.0.file_set.0.regex_file_set` is required
@@ -433,6 +439,12 @@ the proposed diff.
433439
converted it while the upstream API migration was in progress. Now that the API migration has finished,
434440
the provider will no longer convert the service name. Use `bigquery.googleapis.com` instead.
435441

442+
## Resource: `google_pubsub_subscription`
443+
444+
### `path` is now removed
445+
446+
`path` has been removed in favor of `id` which has an identical value.
447+
436448
## Resource: `google_spanner_instance`
437449

438450
### Exactly one of `num_nodes` or `processing_units` is required
@@ -463,13 +475,19 @@ resource "google_spanner_instance" "default" {
463475
}
464476
```
465477

466-
### Resource: `google_sql_database_instance`
478+
## Resource: `google_sql_database_instance`
467479

468480
### First-generation fields have been removed
469481

470482
Removed fields specific to first-generation SQL instances:
471483
`authorized_gae_applications`, `crash_safe_replication`, `replication_type`
472484

485+
### `database_version` field is now required
486+
487+
The `database_version` field is now required.
488+
Previously, it was an optional field and the default value was `MYSQL_5_6`.
489+
Description of the change and how users should adjust their configuration (if needed).
490+
473491
### Drift detection and defaults enabled on fields
474492

475493
Added drift detection and plan-time defaults to several fields used to configure
@@ -503,17 +521,3 @@ Terraform only detected drift when the field had been set in config explicitly.
503521

504522
Previously, the default value of `location` was `US`. In an attempt to avoid allowing invalid
505523
conbination of `storageClass` value and default `location` value, `location` field is now required.
506-
507-
## Resource: `google_sql_database_instance`
508-
509-
### `database_version` field is now required
510-
511-
The `database_version` field is now required.
512-
Previously, it was an optional field and the default value was `MYSQL_5_6`.
513-
Description of the change and how users should adjust their configuration (if needed).
514-
515-
## Resource: `google_pubsub_subscription`
516-
517-
### `path` is now removed
518-
519-
`path` has been removed in favor of `id` which has an identical value.

0 commit comments

Comments
 (0)