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

Adding documentation for md5 auth key #10547

Merged
merged 2 commits into from
Apr 30, 2024
+31 −0
Merged

Adding documentation for md5 auth key #10547

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3f5b9e
Adding documentation for md5 auth key
Gorlami96 Apr 29, 2024
8368c8f
Responding to PR comments
Gorlami96 Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions mmv1/third_party/terraform/website/docs/r/compute_router_peer.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,25 @@ resource "google_compute_router_peer" "peer" {
}
```

## Example Usage - Router Peer md5 authentication key


```hcl
resource "google_compute_router_peer" "foobar" {
name = "%s-peer"
router = google_compute_router.foobar.name
region = google_compute_router.foobar.region
peer_asn = 65515
advertised_route_priority = 100
interface = google_compute_router_interface.foobar.name
peer_ip_address = "169.254.3.2"
md5_authentication_key {
name = "%s-peer-key"
key = "%s-peer-key-value"
}
}
```

## Argument Reference

The following arguments are supported:
Expand Down Expand Up @@ -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.

The field must comply with RFC1035. Structure is [documented below](#nested_md5_authentication_key).

<a name="nested_advertised_ip_ranges"></a>The `advertised_ip_ranges` block supports:

Expand Down Expand Up @@ -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.

(Required)
Name used to identify the key. Must be unique within a router. Must be
referenced by exactly one bgpPeer. Must comply with RFC1035.

* `key` -
(Required, Input Only)
Value of the key. Maximum length is 80 characters. Can only contain printable ASCII characters
Gorlami96 marked this conversation as resolved.
Show resolved Hide resolved

## Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:
Expand Down
Loading