linux-system-roles / vpn

Role for managing VPN/IPSec
https://linux-system-roles.github.io/vpn/
MIT License
8 stars 14 forks source link

Modify README with updated design specification #2

Closed mprovenc closed 3 years ago

pcahyna commented 3 years ago

Looks good, I had many comments, but they refer more to the way how is the design being described, rather than to the design itself. Some comments about the design itself:

richm commented 3 years ago

Looks good, I had many comments, but they refer more to the way how is the design being described, rather than to the design itself. Some comments about the design itself:

* should one use nested dicts like `ipsec.` or `ike.`?

I would prefer nested dicts. In the global context you would use vpn_ipsec.parameter, and in the vpn_connections context you would use ipsec.parameter.

* should there be a `vpn_protocol` parameter in addition to `vpn_provider`? Some providers may use the same protocol, like IPSec. In this case, changing the provider and keeping the protocol for a subset of hosts should allow them to continue communicating with the rest, if the two implementations are properly interoperable. OTOH, hosts using different protocols would not be able to communicate. (Wiregard uses its own protocol, IIRC.)
  As currently each provider (Wireguard and libreswan) support only one protocol, you probably don't need to introduce the `vpn_protocol` variable now, as it can be inferred.

Right. I think for now we should omit a separate protocol field. I think the protocol is set via a combination of ipsec and ike parameters (@letoams please confirm)

richm commented 3 years ago

I just added support for github actions for CI - you should pull the latest master branch and rebase your changes on top

jharuda commented 3 years ago

[citest commit:10178dbdb66322058d401e318aea3a75e489f98e]

mprovenc commented 3 years ago

@richm is there anything else we need to do before merging this PR? I haven't made any changes for a while and I think the documentation accurately reflects what is contained in MVP.

richm commented 3 years ago

@richm is there anything else we need to do before merging this PR? I haven't made any changes for a while and I think the documentation accurately reflects what is contained in MVP.

I think just squash and rebase on top of the latest master branch

mprovenc commented 3 years ago

@richm is there anything else we need to do before merging this PR? I haven't made any changes for a while and I think the documentation accurately reflects what is contained in MVP.

I think just squash and rebase on top of the latest master branch

Okay, I think this should be good to go