Skip to content

workbench: diff-suppress server-injected version-description metadata - #18474

Open
jeffreylwang wants to merge 2 commits into
GoogleCloudPlatform:mainfrom
jeffreylwang:wbi-version-description-diffsuppress
Open

workbench: diff-suppress server-injected version-description metadata#18474
jeffreylwang wants to merge 2 commits into
GoogleCloudPlatform:mainfrom
jeffreylwang:wbi-version-description-diffsuppress

Conversation

@jeffreylwang

@jeffreylwang jeffreylwang commented Jul 30, 2026

Copy link
Copy Markdown

The Workbench backend surfaces a system-owned instance metadata key version-description (a human-readable image description derived from the VmImage release configs, e.g. Debian 11, Python 3.10). Users can never set this key, so the google_workbench_instance provider must diff-suppress it; otherwise every Terraform-managed Workbench instance gets a permadiff (same class of issue as new-proxy-agent-enabled, #17310).

This adds version-description to WorkbenchInstanceProvidedMetadata (purely server-owned, always injected, not EUC-specific).

Context (Google-internal): b/539638368.

workbench: suppressed a diff on `google_workbench_instance` for the server-injected `version-description` metadata key

The Workbench backend surfaces a system-owned instance metadata key `versionDescription` (a human-readable image description derived from the VmImage release configs, e.g. "Debian 11, Python 3.10"). Users never set it, so without a diff-suppress entry it causes a permadiff on google_workbench_instance (same class as new-proxy-agent-enabled, GoogleCloudPlatform#17310). Add it to WorkbenchInstanceProvidedMetadata (server-owned, always injected).
@modular-magician modular-magician added the awaiting-approval Pull requests that need reviewer's approval to run presubmit tests label Jul 30, 2026
@github-actions
github-actions Bot requested a review from SirGitsalot July 30, 2026 19:15
@github-actions

Copy link
Copy Markdown

Googlers: For automatic test runs see go/terraform-auto-test-runs.

@SirGitsalot, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

@jeffreylwang

Copy link
Copy Markdown
Author

@bcreddy-gcp could you please take a look / review this? This adds versionDescription to WorkbenchInstanceProvidedMetadata (the Workbench server-injected metadata diff-suppress list) to prevent a permadiff on google_workbench_instance, matching the precedent from #17310. You're listed as the point of contact for the Workbench metadata guard. Thanks!

@jeffreylwang jeffreylwang changed the title workbench: diff-suppress server-injected versionDescription metadata workbench: diff-suppress server-injected version-description metadata Jul 31, 2026
@jeffreylwang

Copy link
Copy Markdown
Author

Renamed the metadata key from versionDescription to version-description for consistency with the other kebab-case Workbench metadata keys (the PR diff now adds version-description).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting-approval Pull requests that need reviewer's approval to run presubmit tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants