Skip to content

Commit d2508b3

Browse files
committed
docs: replace private IPs with RFC 5737 documentation ranges
1 parent c7be6e3 commit d2508b3

3 files changed

Lines changed: 15 additions & 15 deletions

File tree

docs/Troubleshooting.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,11 @@ As an example:
110110
```
111111
kubectl get nodes -o wide
112112
NAME STATUS ROLES AGE VERSION INTERNAL-IP EXTERNAL-IP OS-IMAGE KERNEL-VERSION CONTAINER-RUNTIME
113-
test-cluster-control-plane-gcgc6 Ready control-plane 11h v1.26.7 10.0.1.69 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
114-
test-cluster-load-balancer-c8rd2 Ready load-balancer,node 11h v1.26.7 10.0.2.155 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
115-
test-cluster-load-balancer-wqbcg Ready load-balancer,node 11h v1.26.7 10.0.2.152 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
116-
test-cluster-worker-hbm8s Ready node 11h v1.26.7 10.0.1.71 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
117-
test-cluster-worker-n2vbc NotReady node 17m v1.26.7 10.0.1.73 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
113+
test-cluster-control-plane-gcgc6 Ready control-plane 11h v1.26.7 198.51.100.69 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
114+
test-cluster-load-balancer-c8rd2 Ready load-balancer,node 11h v1.26.7 198.51.100.155 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
115+
test-cluster-load-balancer-wqbcg Ready load-balancer,node 11h v1.26.7 198.51.100.152 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
116+
test-cluster-worker-hbm8s Ready node 11h v1.26.7 198.51.100.71 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
117+
test-cluster-worker-n2vbc NotReady node 17m v1.26.7 198.51.100.73 <none> Ubuntu 22.04.3 LTS 5.15.0-89-generic containerd://1.7.6
118118
```
119119

120120
The load-balancers have an `e1000` interface as their default network, whereas `ens19` and `ens20` are `virtio`

docs/Usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ ALLOWED_NODES: "[pve1,pve2,pve3, ...]" # The Proxmox VE n
8585
VM_SSH_KEYS: "ssh-ed25519 ..., ssh-ed25519 ..." # The ssh authorized keys used to ssh to the machines.
8686
8787
## -- networking configuration-- ##
88-
CONTROL_PLANE_ENDPOINT_IP: "10.10.10.4" # The IP that kube-vip is going to use as a control plane endpoint.
89-
NODE_IP_RANGES: "[10.10.10.5-10.10.10.50, ...]" # The IP ranges for Cluster nodes.
90-
GATEWAY: "10.10.10.1" # The gateway for the machines network-config..
88+
CONTROL_PLANE_ENDPOINT_IP: "192.0.2.4" # The IP that kube-vip is going to use as a control plane endpoint.
89+
NODE_IP_RANGES: "[192.0.2.5-192.0.2.50, ...]" # The IP ranges for Cluster nodes.
90+
GATEWAY: "192.0.2.1" # The gateway for the machines network-config..
9191
IP_PREFIX: "25" # Subnet Mask in CIDR notation for your node IP ranges.
9292
DNS_SERVERS: "[8.8.8.8,8.8.4.4]" # The dns nameservers for the machines network-config.
9393
BRIDGE: "vmbr1" # The network bridge device for Proxmox VE VMs.

docs/advanced-setups.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ To do that you will need to set extra environment variables along with the requi
2525
2626
```bash
2727
# The secondary IP ranges for Cluster nodes
28-
export SECONDARY_IP_RANGES="[10.10.10.100-10.10.10.150]"
28+
export SECONDARY_IP_RANGES="[192.0.2.100-192.0.2.150]"
2929
# The Subnet Mask in CIDR notation for your node secondary IP ranges
3030
export SECONDARY_IP_PREFIX=24
3131
# The secondary gateway for the machines network-config
32-
export SECONDARY_GATEWAY="10.10.10.254"
32+
export SECONDARY_GATEWAY="192.0.2.254"
3333
# The secondary dns nameservers for the machines network-config
3434
export SECONDARY_DNS_SERVERS="[8.8.8.8, 8.8.4.4]"
3535
# The Proxmox secondary network bridge for VMs
@@ -60,8 +60,8 @@ The metric of the default gateway can be controlled with the proxmoxcluster defi
6060
[...]
6161
ipv4Config:
6262
addresses:
63-
- 10.10.0.70-10.10.0.79
64-
gateway: 10.10.0.1
63+
- 198.51.100.70-198.51.100.79
64+
gateway: 198.51.100.1
6565
metric: 100
6666
prefix: 24
6767
```
@@ -137,14 +137,14 @@ LoadBalancer nodes are tainted and only run pods required for load balancing.
137137
## -- loadbalancer nodes -- #
138138
LOAD_BALANCER_MACHINE_COUNT: 2 # Number of load balancer nodes
139139
EXT_SERVICE_BRIDGE: "vmbr2" # The network bridge device used for load balancing and bgp.
140-
LB_BGP_IPV4_RANGES: "[172.16.4.10-172.16.4.20]" # The IP ranges used by the cluster for establishing the bgp session.
140+
LB_BGP_IPV4_RANGES: "[203.0.113.10-203.0.113.20]" # The IP ranges used by the cluster for establishing the bgp session.
141141
LB_BGP_IPV6_RANGES:
142142
LB_BGP_IPV4_PREFIX: "24" # Subnet Mask in CIDR notation for your bgp IP ranges.
143143
LB_BGP_IPV6_PREFIX:
144144
METALLB_IPV4_ASN: "65400" # The nodes bgp asn.
145145
METALLB_IPV6_ASN:
146-
METALLB_IPV4_BGP_PEER: "172.16.4.1" # The nodes bgp peer IP address.
147-
METALLB_IPV4_BGP_PEER2: "172.16.4.2" # Backup bgp peer for H/A
146+
METALLB_IPV4_BGP_PEER: "203.0.113.1" # The nodes bgp peer IP address.
147+
METALLB_IPV4_BGP_PEER2: "203.0.113.2" # Backup bgp peer for H/A
148148
METALLB_IPV6_BGP_PEER:
149149
METALLB_IPV6_BGP_PEER2:
150150
METALLB_IPV4_BGP_SECRET: "REDACTED" # The secret required to establish a bgp session (if any).

0 commit comments

Comments
 (0)