Skip to content

dataproc: add encryption_config block to docs#16105

Merged
BBBmau merged 4 commits into
GoogleCloudPlatform:mainfrom
BBBmau:add-encryptionConfig-workflowTemplate
Feb 3, 2026
Merged

dataproc: add encryption_config block to docs#16105
BBBmau merged 4 commits into
GoogleCloudPlatform:mainfrom
BBBmau:add-encryptionConfig-workflowTemplate

Conversation

@BBBmau

@BBBmau BBBmau commented Jan 9, 2026

Copy link
Copy Markdown
Collaborator

Release Note Template for Downstream PRs (will be copied)

At first it seemed as though we didn't support encryption_config to be able to setup dataproc_workflow_templates with CMEK but the resource documentation simply lacked the top-level mention of encryption_config.

This will add the encryption_config block as well as an example for encryption_config block usage.

Link to the current dataproc_workflow_template documentation page

See Write release notes for guidance.

@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 1 file changed, 3 insertions(+), 2 deletions(-))

@BBBmau BBBmau force-pushed the add-encryptionConfig-workflowTemplate branch from 106cfd2 to 4850494 Compare January 12, 2026 23:50
@BBBmau BBBmau changed the title dataproc: add encryption_config as custom_schema_value for workflowTemplate dataproc: add encryption_config block to docs Jan 12, 2026
@BBBmau BBBmau requested a review from melinath January 12, 2026 23:52
@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 96 insertions(+), 8 deletions(-))
google-beta provider: Diff ( 1 file changed, 93 insertions(+), 6 deletions(-))

@github-actions

Copy link
Copy Markdown

@melinath This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

@github-actions

Copy link
Copy Markdown

@GoogleCloudPlatform/terraform-team @melinath This PR has been waiting for review for 1 week. Please take a look! Use the label disable-review-reminders to disable these notifications.

@melinath

Copy link
Copy Markdown
Member

@zli82016 it looks like this is a DCL resource - shouldn't it have docs generated instead of needing them handwritten?

@zli82016

zli82016 commented Jan 22, 2026

Copy link
Copy Markdown
Member

@zli82016 it looks like this is a DCL resource - shouldn't it have docs generated instead of needing them handwritten?

It looks like the docs for this resource is handwritten. I think it is OK to add the field to the doc manually.

But do we want to override the field in the file tpgtools/overrides/dataproc/workflow_template.yaml?

@melinath melinath left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yeah, it looks like this doc file has been handwritten for a while. Weird!

Comment on lines +7 to +12
- type: CUSTOM_SCHEMA_VALUES
field: encryption_config
details:
required: false
optional: true
computed: true

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to Zhenhua's question; this seems outside the scope of this PR.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, this came from having the assumption that it wasn't already supported on the resource itself. will remove in latest commit

@BBBmau BBBmau force-pushed the add-encryptionConfig-workflowTemplate branch from 4850494 to b49a67d Compare January 27, 2026 16:38
@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 1 file changed, 93 insertions(+), 6 deletions(-))
google-beta provider: Diff ( 1 file changed, 93 insertions(+), 6 deletions(-))

@BBBmau BBBmau requested a review from melinath January 28, 2026 21:10
Required. WorkflowTemplate scheduling information.
(Required) WorkflowTemplate scheduling information.

* The `encryption_config` - (Optional) Encryption settings for encrypting workflow template job arguments.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The `encryption_config` - (Optional) Encryption settings for encrypting workflow template job arguments.
* `encryption_config` - (Optional) Encryption settings for encrypting workflow template job arguments.


The `encryption_config` block supports:

* `kms_key` - (Optional) The Cloud KMS key name to use for encrypting workflow template [job arguments](https://cloud.google.com/dataproc/docs/concepts/workflows/use-workflows?_gl=1*1a0vliy*_ga*MTA5NTk1NjQ5MC4xNzAyMzEzMTA2*_ga_WH2QY8WWF5*czE3NjgyNTk1Mjkkbzk1JGcxJHQxNzY4MjYxNTM0JGo1OSRsMCRoMA..#adding_jobs_to_a_template).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here & below:

  • these links all seem to include extraneous ?gl= query params; could those be removed?
  • all the links now redirect to docs.cloud.google.com - could we update them to point there directly instead? Context: Add docs subdomain to resourcemanager links #16189 & similar PRs recently.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just here: #adding_jobs_to_a_template isn't the correct anchor. It could be worth double-checking the rest.


* The `encryption_config` - (Optional) Encryption settings for encrypting workflow template job arguments.

The `encryption_config` block supports:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: not a blocker since this doc is already incorrect, but this should be structured differently, with anchor links from the field definition to what's in the block. Currently, the jobs field is very far from its subfields with no links, and this PR makes that slightly worse. Compare for example: https://github.com/hashicorp/terraform-provider-google-beta/blob/6bbd36a89f4448462e988c990892e0a06d1a9134/website/docs/r/alloydb_instance.html.markdown?plain=1#L289

@BBBmau

BBBmau commented Jan 29, 2026

Copy link
Copy Markdown
Collaborator Author

went ahead and fixed the structuring and cleaned up the links

@BBBmau BBBmau requested a review from melinath January 29, 2026 19:11
@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 1 file changed, 110 insertions(+), 23 deletions(-))
google-beta provider: Diff ( 1 file changed, 110 insertions(+), 23 deletions(-))

@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 1 file changed, 110 insertions(+), 23 deletions(-))
google-beta provider: Diff ( 1 file changed, 110 insertions(+), 23 deletions(-))

@BBBmau BBBmau added this pull request to the merge queue Feb 2, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Feb 2, 2026
@BBBmau BBBmau added this pull request to the merge queue Feb 3, 2026
Merged via the queue into GoogleCloudPlatform:main with commit cc3e7cd Feb 3, 2026
23 checks passed
@BBBmau BBBmau deleted the add-encryptionConfig-workflowTemplate branch February 3, 2026 19:21
NandiniAgrawal15 pushed a commit to NandiniAgrawal15/magic-modules that referenced this pull request Feb 5, 2026
wuchris-g pushed a commit to wuchris-g/magic-modules that referenced this pull request Feb 5, 2026
JianweiQ pushed a commit to JianweiQ/magic-modules that referenced this pull request Feb 20, 2026
kapoorne-g pushed a commit to kapoorne-g/magic-modules that referenced this pull request Feb 24, 2026
kefang2 pushed a commit to kefang2/magic-modules that referenced this pull request Feb 28, 2026
aditikumarii-google pushed a commit to aditikumarii-google/magic-modules that referenced this pull request Mar 10, 2026
ChuAmberZhang pushed a commit to ChuAmberZhang/magic-modules that referenced this pull request Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants