From f17ad493527c72f81274f10f23ab2dda52628e53 Mon Sep 17 00:00:00 2001 From: Gabriel Arazas Date: Mon, 23 Jan 2023 17:49:16 +0800 Subject: [PATCH] docs: document the networking setup for Plover --- hosts/plover/README.adoc | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/hosts/plover/README.adoc b/hosts/plover/README.adoc index bc758f85..d4a422c1 100644 --- a/hosts/plover/README.adoc +++ b/hosts/plover/README.adoc @@ -71,6 +71,23 @@ Though, you can easily create one from the command-line interface with `kcadm.sh Still, test the logins as indicated from the seed file. +=== Networking guidelines + +Networking for a first-timer can be confusing (at least for me). +So here's the documentation for what is the practices that are following here. + +- Internal services is mainly at `172.24.0.0/16`. +- Public services is at an increment to the internal services IP address (i.e., `172.25.0.0/16`). +- Wireguard interfaces are mainly at `10.2xx.0.0/16`. + +There are some general guidelines to keep in mind when assigning the IPs statically. + +- Servers are intended at `172.1.x.x` to `172.101.x.x`. +- VPNs are at `10.2xx.x.x`. + +For more details, you can see the interfaces and their networking-related configuration in link:./modules/hardware/networks.nix[`./modules/hardware/networks.nix`]. + + == Deploying it as a Google Compute instance