Skip to content

Commit d67d0d1

Browse files
committed
docs(readme): use RFC 5737 documentation IPs in getting-started walkthrough
Address review feedback from coderabbitai on README.md:135: The rendered config sample showed the old placeholder https://192.168.0.1:6443, which contradicted the values.yaml example. Swap the walkthrough to the RFC 5737 TEST-NET-1 range (192.0.2.0/24) for both node and gateway so the example uses IPs reserved for documentation and cannot accidentally collide with a real network. Assisted-By: Claude <[email protected]> Signed-off-by: Aleksei Sviridkin <[email protected]>
1 parent 6295e02 commit d67d0d1

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,22 +72,22 @@ automatically from the node's default-gateway-bearing link, so no
7272
override is needed unless you have a multi-homed node that requires
7373
a specific subnet pinned.
7474

75-
Boot Talos Linux node, let's say it has address `1.2.3.4`. Then:
75+
Boot Talos Linux node, let's say it has address `192.0.2.4`. Then:
7676

7777
```yaml
78-
# values.yaml (single-node example matching the 1.2.3.4 node below)
79-
endpoint: "https://1.2.3.4:6443"
78+
# values.yaml (single-node example matching the 192.0.2.4 node below)
79+
endpoint: "https://192.0.2.4:6443"
8080
floatingIP: ""
8181
```
8282
8383
Gather node information:
8484
```bash
85-
talm -n 1.2.3.4 -e 1.2.3.4 template -t templates/controlplane.yaml -i > nodes/node1.yaml
85+
talm -n 192.0.2.4 -e 192.0.2.4 template -t templates/controlplane.yaml -i > nodes/node1.yaml
8686
```
8787

8888
Edit `nodes/node1.yaml` file:
8989
```yaml
90-
# talm: nodes=["1.2.3.4"], endpoints=["1.2.3.4"], templates=["templates/controlplane.yaml"]
90+
# talm: nodes=["192.0.2.4"], endpoints=["192.0.2.4"], templates=["templates/controlplane.yaml"]
9191
machine:
9292
network:
9393
# -- Discovered interfaces:
@@ -108,10 +108,10 @@ machine:
108108
interfaces:
109109
- interface: enx9c6b0047066c
110110
addresses:
111-
- 1.2.3.4/26
111+
- 192.0.2.4/26
112112
routes:
113113
- network: 0.0.0.0/0
114-
gateway: 1.2.3.1
114+
gateway: 192.0.2.1
115115
nameservers:
116116
- 8.8.8.8
117117
- 8.8.4.4
@@ -132,7 +132,7 @@ machine:
132132
cluster:
133133
clusterName: talm
134134
controlPlane:
135-
endpoint: https://192.168.0.1:6443
135+
endpoint: https://192.0.2.4:6443
136136
```
137137
138138
> **Note:** The output format depends on the Talos version configured in `Chart.yaml` (`templateOptions.talosVersion`) or via the `--talos-version` CLI flag.

0 commit comments

Comments
 (0)