dataproc: add encryption_config block to docs#16105
Conversation
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
|
106cfd2 to
4850494
Compare
dataproc: add encryption_config as custom_schema_value for workflowTemplatedataproc: add encryption_config block to docs
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
|
|
@melinath This PR has been waiting for review for 3 weekdays. Please take a look! Use the label |
|
@GoogleCloudPlatform/terraform-team @melinath This PR has been waiting for review for 1 week. Please take a look! Use the label |
|
@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
left a comment
There was a problem hiding this comment.
Ah, yeah, it looks like this doc file has been handwritten for a while. Weird!
| - type: CUSTOM_SCHEMA_VALUES | ||
| field: encryption_config | ||
| details: | ||
| required: false | ||
| optional: true | ||
| computed: true |
There was a problem hiding this comment.
+1 to Zhenhua's question; this seems outside the scope of this PR.
There was a problem hiding this comment.
good catch, this came from having the assumption that it wasn't already supported on the resource itself. will remove in latest commit
4850494 to
b49a67d
Compare
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
|
| Required. WorkflowTemplate scheduling information. | ||
| (Required) WorkflowTemplate scheduling information. | ||
|
|
||
| * The `encryption_config` - (Optional) Encryption settings for encrypting workflow template job arguments. |
There was a problem hiding this comment.
| * 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). |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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
|
went ahead and fixed the structuring and cleaned up the links |
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
|
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
|
Release Note Template for Downstream PRs (will be copied)
At first it seemed as though we didn't support
encryption_configto be able to setup dataproc_workflow_templates with CMEK but the resource documentation simply lacked the top-level mention ofencryption_config.This will add the
encryption_configblock 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.