- Notifications
You must be signed in to change notification settings - Fork636
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Add more information to the wireguard interface definition#9073
base:main
Are you sure you want to change the base?
Conversation
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 easierSigned-off-by: naed3r <40650681+nate-moo@users.noreply.github.com>
| # 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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)
This PR is stale because it has been open 45 days with no activity. |
I think this should be moved to the new issue, and this PR is closed (or not?) since we need to redo more that just three places. |
This PR is stale because it has been open 45 days with no activity. |
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)