tailcfg: document peer node capability #11379
Closed
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
clairew
force-pushed
the
clairew/peer-node-capability-documentation
branch
from
282863a
to
53e0a6a
Compare
Updates tailscale/corp#17516 Signed-off-by: Claire Wang <claire@tailscale.com>
sailorfrag
reviewed
Mar 26, 2024
tailcfg/tailcfg.go
Outdated
Comment on lines
329
to
331
| // CapMap and Capabilities are both ways for control to send metadata about a peer node. | ||
| // By accessing a self node's peers - a self node can check the peer's capabilities. | ||
| // Capabilities can be used to label information about a peer. |
There was a problem hiding this comment.
I think the docs for how to use new functionality should probably be added to the new thing instead.
"A self node's peers" is awkward to say and doesn't really reflect how MapResponse is setup (also this file does not mention "self node") -- there is Peers, which is a slice of Nodes, and there is Self, which is also a Node.
Change-Id: Iad2dafb38ffb9948bc2f3dfaf9c268f7d772cf56 Signed-off-by: Adrian Dewhurst <adrian@tailscale.com>
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.
Updates tailscale/corp#17516