docs: fix patching examples

Fix the patching example Signed-off-by: Noel Georgi <git@frezbo.dev>
siderolabs · Dec 24, 2021 · d69264f · d69264f
1 parent 04d90fd
commit d69264f
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 12 deletions.
diff --git a/website/content/docs/v0.4/Resource Configuration/metadata.md b/website/content/docs/v0.4/Resource Configuration/metadata.md
@@ -20,6 +20,9 @@ The configuration of each machine is constructed from a number of sources:
 
 An example usage of setting a virtual IP for the control plane nodes and adding extra `node-labels` to nodes is shown below:
 
+> Note: because of the way JSON patches work the interface setting also needs to be set in `TalosControlPlane` when defining a Virtual IP.
+This experience is not ideal, but will be addressed in a future release.
+
 *TalosControlPlane* custom resource:
 
 ```yaml
@@ -36,7 +39,9 @@ spec:
         path: /machine/network
         value:
           interfaces:
-          - vip:
+          - interface: eth0
+            dhcp: true
+            vip:
               ip: 172.16.200.52
       generateType: controlplane
       talosVersion: v0.13
@@ -46,7 +51,9 @@ spec:
         path: /machine/network
         value:
           interfaces:
-          - vip:
+          - interface: eth0
+            dhcp: true
+            vip:
               ip: 172.16.200.52
       generateType: init
       talosVersion: v0.13
@@ -81,7 +88,7 @@ spec:
               talos.dev/part-of: cluster/workload-cluster
 ```
 
-and finally in the control plane `ServerClass` custom resource we augment the network information for the nodes:
+and finally in the control plane `ServerClass` custom resource we augment the network information for other interfaces:
 
 ```yaml
 ---
@@ -100,10 +107,9 @@ spec:
     - console=tty0
     - console=ttyS1,115200n8
   - op: add
-    # the vip spec is defined in the TalosControlPlane CR
-    path: /machine/network/interfaces/0
+    path: /machine/network/interfaces/-
     value:
-      interface: eth0
+      interface: eth1
       dhcp: true
   qualifiers:
     cpu:
@@ -139,6 +145,8 @@ spec:
       interfaces:
       - interface: eth0
         dhcp: true
+      - interface: eth1
+        dhcp: true
   qualifiers:
     cpu:
     - version: Intel(R) Xeon(R) E-2136 CPU @ 3.30GHz

diff --git a/website/content/docs/v0.5/Resource Configuration/metadata.md b/website/content/docs/v0.5/Resource Configuration/metadata.md
@@ -20,6 +20,9 @@ The configuration of each machine is constructed from a number of sources:
 
 An example usage of setting a virtual IP for the control plane nodes and adding extra `node-labels` to nodes is shown below:
 
+> Note: because of the way JSON patches work the interface setting also needs to be set in `TalosControlPlane` when defining a Virtual IP.
+This experience is not ideal, but will be addressed in a future release.
+
 *TalosControlPlane* custom resource:
 
 ```yaml
@@ -36,7 +39,9 @@ spec:
         path: /machine/network
         value:
           interfaces:
-          - vip:
+          - interface: eth0
+            dhcp: true
+            vip:
               ip: 172.16.200.52
       generateType: controlplane
       talosVersion: v0.13
@@ -46,7 +51,9 @@ spec:
         path: /machine/network
         value:
           interfaces:
-          - vip:
+          - interface: eth0
+            dhcp: true
+            vip:
               ip: 172.16.200.52
       generateType: init
       talosVersion: v0.13
@@ -81,7 +88,7 @@ spec:
               talos.dev/part-of: cluster/workload-cluster
 ```
 
-and finally in the control plane `ServerClass` custom resource we augment the network information for the nodes:
+and finally in the control plane `ServerClass` custom resource we augment the network information for other interfaces:
 
 ```yaml
 ---
@@ -100,10 +107,9 @@ spec:
     - console=tty0
     - console=ttyS1,115200n8
   - op: add
-    # the vip spec is defined in the TalosControlPlane CR
-    path: /machine/network/interfaces/0
+    path: /machine/network/interfaces/-
     value:
-      interface: eth0
+      interface: eth1
       dhcp: true
   qualifiers:
     cpu:
@@ -139,6 +145,8 @@ spec:
       interfaces:
       - interface: eth0
         dhcp: true
+      - interface: eth1
+        dhcp: true
   qualifiers:
     cpu:
     - version: Intel(R) Xeon(R) E-2136 CPU @ 3.30GHz