adelorenzo/kilo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #44 from squat/vpn-server-docs

Browse Source 
docs/vpn: document vpn as internet gateway
This commit is contained in:
Lucas Servén Marín 2020-03-09 18:57:54 +01:00 committed by GitHub
commit 494440d502
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 59 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/vpn-server.md Normal file
View File

@ -0,0 +1,56 @@
# VPN Server
The cluster VPN created by Kilo can also be used by peers as a gateway to access the Internet.
In order configure a local machine to use the cluster VPN as a gateway to the Internet, first register the local machine as a peer of the cluster following the steps in the [VPN docs](./vpn.md).
Once the machine is registered, generate the configuration for the local peer:
```shell
PEER=squat # name of the registered peer
kgctl showconf peer $PEER > peer.ini
```
Next, the WireGuard configuration must be modified to enable routing traffic for any IP via a node in the cluster.
To do so, open the WireGuard configuration in an editor, select a node in the cluster, and set the `AllowedIPs` field of that node's corresponding `peer` section to `0.0.0.0/0, ::/0`:
```shell
$EDITOR peer.ini
```
The configuration should now look something like:
```ini
[Peer]
PublicKey = 2/xU029dz/WtvMZAbnSzmhicl8U1/Y3NYmunRr8EJ0Q=
AllowedIPs = 0.0.0.0/0, ::/0
Endpoint = 108.61.142.123:51820
```
The configuration can then be applied to the local WireGuard interface, e.g. `wg0`:
```shell
IFACE=wg0
sudo wg setconf $IFACE peer.ini
```
Next, add routes for the public IPs of the WireGuard peers to ensure that the packets encapsulated by WireGuard are sent through a real interface:
```shell
default=$(ip route list all | grep default | awk '{$1=""; print $0}')
for ip in $(sudo wg | grep endpoint | awk '{print $2}' | sed 's/\(.\+\):[0-9]\+/\1/'); do
sudo ip route add $ip $default
done
```
Finally, the local machine can be configured to use the WireGuard interface as the device for the default route:
```shell
sudo ip route delete default
sudo ip route add default dev $IFACE
```
The local machine is now using the selected node as its Internet gateway and the connection can be verified.
For example, try finding the local machine's external IP address:
```shell
curl https://icanhazip.com
```

4
docs/vpn.md
View File

@ -64,7 +64,7 @@ Once the routes are in place, the connection to the cluster can be tested.
For example, try connecting to the API server: For example, try connecting to the API server:
```shell ```shell
curl -k https://10.0.27.179:6443 curl -k https://$(kubectl get endpoints kubernetes | tail -n +2 | tr , \\t | awk '{print $2}')
``` ```
Likewise, the cluster now also has layer 3 access to the newly added peer. Likewise, the cluster now also has layer 3 access to the newly added peer.
@ -105,3 +105,5 @@ EOF
``` ```
[See the multi-cluster services docs for more details on connecting clusters to external services](./multi-cluster-services.md). [See the multi-cluster services docs for more details on connecting clusters to external services](./multi-cluster-services.md).
Although it is not a primary goal of the project, the VPN created by Kilo can also be [used by peers as a gateway to the Internet; for more details, see the VPN server docs](./vpn-server.md).