-
-
Notifications
You must be signed in to change notification settings - Fork 74
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[feature] Adding Wireguard and VXLAN support #187
Conversation
5c28cb4
to
8f50313
Compare
config['interfaces'][0]['addresses'] = [ | ||
{ | ||
'proto': 'static', | ||
'family': 'ipv4', |
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.
We can't know whether the IP address will belong to IPv4 or IPv6 family since we are dealing with variables here.
@@ -307,7 +307,6 @@ | |||
"type": "string", | |||
"title": "ipv4 address", | |||
"minLength": 7, | |||
"format": "ipv4", |
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 was preventing to us to use variable name in templates
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.
@pandafy let's make sure Wireguard is mentioned in the README (we have OpenVPN so it makes sense to mention Wireguard as well).
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.
Sorry I forgot to mention to mention WireGuard it here too: https://github.com/openwisp/netjsonconfig/blob/master/docs/source/index.rst
@@ -0,0 +1,193 @@ | |||
================= |
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.
is this file listed in the toctree? I tried generating the docs and don't see it in the menu.
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.
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.
@nemesisdesign can this be resolved?
@@ -0,0 +1,78 @@ | |||
============================ |
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.
is this file listed in the toctree? I tried generating the docs and don't see it in the menu.
5aa0b36
to
51338a8
Compare
.. include:: ../_github.rst | ||
|
||
The ``VXLAN over WireGuard`` backend extends :doc:`Wireguard backend </backends/wireguard>` | ||
to add configurations required for VXLAN. |
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.
I think something like configurations required for configuring VXLAN tunnels encapsulated in WireGuard tunnels.
may be more specific and clear.
docs/source/backends/openwrt.rst
Outdated
option route_allowed_ips '1' | ||
|
||
VXLAN over WireGuard | ||
-------------------- |
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.
I think there's a misunderstanding here.
VXLAN can work independently from wireguard, so we should document it independently.
VXLAN is a layer 2 tunnel which can be encapsulated in any L3 technology, so I don't think we need to specify VXLAN over wireguard.
Maybe, we can leave one last example showing how to encapsulate a vxlan tunnel in a wireguard tunnel.
docs/source/backends/openwrt.rst
Outdated
| | | | | | ||
| | | | 2 to 15 alphanumeric characters, dashes and underscores | | ||
+-----------------------+---------+-----------+-----------------------------------------------------------------+ | ||
| ``route_allowed_ips`` | boolean | ``False`` | automatically create a route for each Allowed IPs for this peer | |
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.
It's fine but automatically create a route for each of the Allowed IPs for this peer
flows more smoothly.
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.
Docs look good
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.
@pandafy can you address this suggestion please?
#187 (review)
The rest looks good and I think we should merge!
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.
@pandafy it's ready to merge but I think we can squash/group some commits of yours to keep history tidy, please proceed when you can.
Related to #185
- Added examples for WireGuard, VXLAN and VXLAN over WireGuard - Updated OpenWrt documentation to describle usage of auto_client methods
f7e9903
to
6365223
Compare
What's missing:
Postponed: #188.