Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding documentation for md5 auth key #10547

Merged
merged 2 commits into from
Apr 30, 2024
Merged

Adding documentation for md5 auth key #10547

merged 2 commits into from
Apr 30, 2024

Conversation

Gorlami96
Copy link
Contributor

@Gorlami96 Gorlami96 commented Apr 29, 2024 •
edited
Loading

Adding documentation for md5_authentication_key field in google_compute_router_peer resource. b/336239032

*Release Note Template for Downstream PRs

compute: added documentation for md5_authentication_key field in google_compute_router_peer resource

@Gorlami96 Gorlami96 marked this pull request as ready for review April 29, 2024 09:21
@github-actions GitHub Actions
Copy link

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

@rileykarson, 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.

@github-actions github-actions bot requested a review from rileykarson April 29, 2024 09:22
@modular-magician
Copy link
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, 32 insertions(+))
google-beta provider: Diff ( 1 file changed, 32 insertions(+))

rileykarson
rileykarson reviewed Apr 29, 2024
View reviewed changes
Copy link
Member

@rileykarson rileykarson left a comment

Choose a reason for hiding this comment

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

The API docs are kind of rough for this field- they read like internal comments for someone familiar with the resource/feature and not like primary documentation themselves. I have some optional suggestions inline. Not required, though, so feel free to dismiss any/all and I'll approve+merge.

mmv1/third_party/terraform/website/docs/r/compute_router_peer.html.markdown
@@ -361,6 +382,17 @@ The following arguments are supported:
BFD declares that a peer is unavailable. If set, the value must
be a value between 5 and 16.

<a name="nested_md5_authentication_key"></a>The `md5_authentication_key` block supports:

* `name` -
Copy link
Member

Choose a reason for hiding this comment

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

nit: We could consider dropping Must be referenced by exactly one bgpPeer. as the schema in Terraform enforces that already- this is implied by just Must be unique within a router..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ack.

mmv1/third_party/terraform/website/docs/r/compute_router_peer.html.markdown Outdated
@@ -316,6 +335,8 @@ The following arguments are supported:
* `project` - (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.

* `md5_authentication_key` - (Optional) Present if MD5 authentication is enabled for the peering.
Copy link
Member

Choose a reason for hiding this comment

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

nit: I think we should deviate from the REST docs on this one based on terminology in https://cloud.google.com/network-connectivity/docs/router/how-to/use-md5-authentication#add-authentication, as the current description fits a proto file and not a REST API (much less a Terraform configuration). I'd suggest something like:

Configuration for MD5 authentication on the BGP session. Structure is [documented below](#nested_md5_authentication_key).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ack.

mmv1/third_party/terraform/website/docs/r/compute_router_peer.html.markdown Outdated Show resolved Hide resolved
@github-actions github-actions bot requested a review from rileykarson April 30, 2024 08:25
@modular-magician
Copy link
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, 31 insertions(+))
google-beta provider: Diff ( 1 file changed, 31 insertions(+))

@rileykarson rileykarson merged commit d24fc59 into GoogleCloudPlatform:main Apr 30, 2024
9 checks passed
This was referenced Apr 30, 2024
Merged
Merged
Merged
@Gorlami96 Gorlami96 deleted the adding-md5-auth-key-docs branch May 2, 2024 06:03
balanaguharsha pushed a commit to balanaguharsha/magic-modules that referenced this pull request May 2, 2024
@Gorlami96 @balanaguharsha
Adding documentation for md5 auth key (GoogleCloudPlatform#10547)
b5a8824
BBBmau pushed a commit to BBBmau/magic-modules that referenced this pull request May 8, 2024
@Gorlami96 @BBBmau
Adding documentation for md5 auth key (GoogleCloudPlatform#10547)
4ec7628
pawelJas pushed a commit to pawelJas/magic-modules that referenced this pull request May 16, 2024
@Gorlami96 @pawelJas
Adding documentation for md5 auth key (GoogleCloudPlatform#10547)
cf76c6f
pengq-google pushed a commit to pengq-google/magic-modules that referenced this pull request May 21, 2024
@Gorlami96 @pengq-google
Adding documentation for md5 auth key (GoogleCloudPlatform#10547)
4a13636
Cheriit pushed a commit to Cheriit/magic-modules that referenced this pull request Jun 4, 2024
@Gorlami96 @Cheriit
Adding documentation for md5 auth key (GoogleCloudPlatform#10547)
c52f2bd
pcostell pushed a commit to pcostell/magic-modules that referenced this pull request Jul 16, 2024
@Gorlami96 @pcostell
Adding documentation for md5 auth key (GoogleCloudPlatform#10547)
f14cbae
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rileykarson rileykarson rileykarson approved these changes

Assignees
No one assigned
Labels
service/compute-router
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Gorlami96 @modular-magician @rileykarson