{docs,tailscale}: better document device_subnet_routes #428
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mpminardi
force-pushed
the
mpminardi/better-subnet-routes-docs
branch
from
bc6f6a9 to
334d161
Compare
oxtoacart
reviewed
Sep 10, 2024
| @@ -3,12 +3,18 @@ | |||
| page_title: "tailscale_device_subnet_routes Resource - terraform-provider-tailscale" | |||
| subcategory: "" | |||
| description: |- | |||
| The device_subnet_routes resource allows you to configure subnet routes for your Tailscale devices. See https://tailscale.com/kb/1019/subnets for more information. | |||
| "The device_subnet_routes resource allows you to configure enabled subnet routes for your Tailscale devices. See https://tailscale.com/kb/1019/subnets for more information. | |||
| Routes must be both advertised and enabled for a device to act as a subnet router or exit node. Advertised routes must be set directly on the device and cannot be managed through Terraform. If a device has advertised routes, they are not exposed to traffic until they are enabled. Conversely, if routes are enabled before they are advertised, they are not available for routing until the device in question has advertised them. | |||
There was a problem hiding this comment.
Nit:
"advertised routes must be set directly on the device" -> "routes must be advertised directly from the device"
There was a problem hiding this comment.
Nit:
"If a device has advertised routes" -> "If a device is advertising routes"
There was a problem hiding this comment.
Nit:
"the device in question has advertised them" -> "the device in question is advertising them"
oxtoacart
reviewed
Sep 10, 2024
| The device_subnet_routes resource allows you to configure subnet routes for your Tailscale devices. See https://tailscale.com/kb/1019/subnets for more information. | ||
| "The device_subnet_routes resource allows you to configure enabled subnet routes for your Tailscale devices. See https://tailscale.com/kb/1019/subnets for more information. | ||
|
|
||
| Routes must be both advertised and enabled for a device to act as a subnet router or exit node. Advertised routes must be set directly on the device and cannot be managed through Terraform. If a device has advertised routes, they are not exposed to traffic until they are enabled. Conversely, if routes are enabled before they are advertised, they are not available for routing until the device in question has advertised them. |
oxtoacart
approved these changes
Sep 10, 2024
Add better documentation to the device_subnet_routes resource to clarify that routes need to be advertised on the device itself, and that all routes (including those enabled via the admin console / autoApprovers in the ACL) must be added to the `routes` param when using this resource to avoid configuration drift. Updates tailscale/corp#22115 Signed-off-by: Mario Minardi <[email protected]>
mpminardi
force-pushed
the
mpminardi/better-subnet-routes-docs
branch
from
334d161 to
b086ba8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add better documentation to the device_subnet_routes resource to clarify that routes need to be advertised on the device itself, and that all routes (including those enabled via the admin console / autoApprovers in the ACL) must be added to the
routesparam when using this resource to avoid configuration drift.Updates https://github.com/tailscale/corp/issues/22115