Add more information to the wireguard interface definition #9073
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
When setting up Wireguard the provided reference documentation on it was incomplete in my opinion, and I believe this change would help make configuring it for new users easier Signed-off-by: naed3r <[email protected]>
smira
reviewed
Jul 29, 2024
| # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer. | ||
| allowedIPs: | ||
| - 192.168.1.0/24 | ||
| - interface: wg0 # Name of the wireguard interface |
There was a problem hiding this comment.
this is a good change, but this part of the documentation is automatically generated, so we'd need to figure out how to incorporate that into the doc generator (and probably in other similar places)
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.
Pull Request
What? (description)
Modified the reference to the wireguard configuration options to include the interface description.
Why? (reasoning)
The configuration implied to me that you didn't need to create an interface, but you do. In order to fix that I had to look at the other wireguard documentation to see that. In my eyes this will help be more clear on the creation of wireguard interfaces.
Acceptance
Please use the following checklist:
make conformance)make fmt)make lint)make docs)make unit-tests)