Skip to content

Commit 6f77c4b

Browse files
achuribooksachuribooks
authored
docs: DOC-2102: Remove NIC and vip_interface Requirements for Network Overlay Clusters (#7841)
* Removing NIC and vip_interface requirements for network overlay clusters * Empty commit to trigger Netlify preview * Updating stylus agent version in known issue
1 parent 52d8db2 commit 6f77c4b

File tree

2 files changed

+17
-73
lines changed

2 files changed

+17
-73
lines changed

‎docs/docs-content/clusters/edge/networking/vxlan-overlay.md‎

Lines changed: 16 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -118,88 +118,32 @@ You cannot change network overlay configurations after the cluster is created.
118118

119119
5. Enter a **Cluster name**, **Description**, and **Tags**. Select **Next**.
120120

121+
<!-- prettier-ignore-start -->
122+
121123
6. Select **Add cluster profile**, choose the appropriate profile, and **Confirm** your selection. If you don't have a
122124
cluster profile for Edge Native, refer to the
123125
[Create Edge Native Cluster Profile](../site-deployment/model-profile.md) guide.
124126

125-
7. In the Kubernetes layer of the cluster profile, on the **Values** tab, uncomment the parameter
126-
`cluster.kubevipArgs.vip_interface` and set its value to `scbr-100`.
127-
128-
```yaml
129-
cluster:
130-
kubevipArgs:
131-
vip_interface: "scbr-100"
132-
```
133-
134-
8. In the network layer of your cluster profile, specify the name of the Network Interface Controllers (NIC) on your
135-
Edge hosts to be `scbr-100`. This is the name of the interface Palette creates on your Edge devices to establish the
136-
overlay network.
137-
138-
The following are the sections of the packs you need to change depending on which CNI pack you are using:
139-
140-
<Tabs>
141-
142-
<TabItem value="calico" label="Calico">
143-
144-
In the Calico pack YAML file, add `manifests.calico.env.calicoNode.FELIX_MTUIFACEPATTERN` and set its value to
145-
`scbr-100`. Uncomment `manifests.calico.env.calicoNode.IP_AUTODETECTION_METHOD` and set its value to
146-
`interface=scbr-100`.
147-
148-
```yaml {8,11}
149-
manifests:
150-
calico:
151-
...
152-
env:
153-
# Additional env variables for calico-node
154-
calicoNode:
155-
#IPV6: "autodetect"
156-
FELIX_MTUIFACEPATTERN: "scbr-100"
157-
#CALICO_IPV6POOL_NAT_OUTGOING: "true"
158-
#CALICO_IPV4POOL_CIDR: "192.168.0.0/16"
159-
IP_AUTODETECTION_METHOD: "interface=scbr-100"
160-
```
161-
162-
</TabItem>
163-
164-
<TabItem value="flannel" label="Flannel">
165-
166-
In the Flannel pack YAML file, add the line `- "--iface=scbr-100"` in the default template under
167-
`charts.flannel.args`.
168-
169-
```yaml {8}
170-
charts:
171-
flannel:
172-
...
173-
# flannel command arguments
174-
args:
175-
- "--ip-masq"
176-
- "--kube-subnet-mgr"
177-
- "--iface=scbr-100"
178-
```
179-
180-
</TabItem>
181-
182-
<TabItem value="cilium" label="Cilium">
183-
184-
You do not need to make any adjustments to the Cilium pack.
185-
186-
</TabItem>
187-
188-
<TabItem value="other" label="Other">
127+
:::info
189128

190-
If you are using other CNIs, refer to the documentation of your selected CNI and configure it to make sure that it
191-
picks the NIC named `scbr-100` on your Edge host.
129+
If you are using a Container Network Interface (CNI) pack other than
130+
<VersionedLink text="Calico" url="/integrations/cni-calico" />,
131+
<VersionedLink text="Cilium" url="/integrations/cni-cilium-oss" />, or
132+
<VersionedLink text="Flannel" url="/integrations/cni-flannel" />, you must set the name of your Network Interface
133+
Controllers (NICs) on your Edge hosts to `scbr-100`. This is the name of the interface Palette creates on your Edge
134+
devices to establish the overlay network. Refer to the documentation of your selected CNI and configure it to make
135+
sure it picks the NIC named `scbr-100` on your Edge host.
192136

193-
</TabItem>
137+
:::
194138

195-
</Tabs>
139+
<!-- prettier-ignore-end -->
196140

197-
9. Review the rest of your cluster profile values and make changes as needed. Select **Next**.
141+
7. Review your cluster profile values and make changes as needed. Select **Next**.
198142

199-
10. On the **Cluster Config** stage, toggle on **Enable overlay**. The **VIP** field disappears and is replaced by
143+
8. On the **Cluster Config** stage, toggle on **Enable overlay**. The **VIP** field disappears and is replaced by
200144
**Overlay CIDR range**.
201145

202-
11. In the **Overlay CIDR range** field, provide a private IP range for your cluster to use. Ensure this range is not
146+
9. In the **Overlay CIDR range** field, provide a private IP range for your cluster to use. Ensure this range is not
203147
used by others in the same network environment. When you toggle on **Enable overlay**, Palette provides a default
204148
range that is typically unused. We suggest you keep the default range unless you have a specific IP range you want
205149
to use.
@@ -213,7 +157,7 @@ You cannot change network overlay configurations after the cluster is created.
213157

214158
:::
215159

216-
12. Finish configuring your cluster and select **Finish Configuration** to deploy the cluster. For more information,
160+
10. Finish configuring your cluster and select **Finish Configuration** to deploy the cluster. For more information,
217161
refer to [Create Cluster Definition](../site-deployment/cluster-deployment.md).
218162

219163
## Validate

‎docs/docs-content/release-notes/known-issues.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The following table lists all known issues that are currently active and affecti
1717
| Description | Workaround | Publish Date | Product Component |
1818
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------- |
1919
| Cilium may fail to start on MAAS machines that are configured with a `br0` interface and are part of a <VersionedLink text="Canonical Kubernetes" url="/integrations/packs/?pack=kubernetes-ck8s" /> cluster, displaying errors like `daemon creation failed: failed to detect devices: unable to determine direct routing device. Use --direct-routing-device to specify it`. This happens because Canonical Kubernetes supports setting various Cilium annotations, but it lacks some fields required for the MAAS `br0` network configuration due to [a limitation in `k8s-snap`](https://github.com/canonical/k8s-snap/issues/1740). | Avoid using MAAS machines with a `br0` interface when provisioning Canonical Kubernetes clusters. Instead, choose machines whose primary interface is directly connected to the MAAS-managed subnet or VLAN. | August 17, 2025 | Clusters, Packs |
20-
| Network overlay cluster nodes may display erroneous `failed to add static FDB entry after cleanup...Stdout already set, output` logs after [upgrading the Palette agent](../clusters/edge/cluster-management/agent-upgrade-airgap.md) to version 4.7.7. Cluster functionality is not affected. | No workaround available. | August 17, 2025 | Edge |
20+
| Network overlay cluster nodes may display erroneous `failed to add static FDB entry after cleanup...Stdout already set, output` logs after [upgrading the Palette agent](../clusters/edge/cluster-management/agent-upgrade-airgap.md) to version 4.7.9. Cluster functionality is not affected. | No workaround available. | August 17, 2025 | Edge |
2121
| Container runtime may fail to run with the message `Failed to run CRI service error=failed to recover state: failed to get metadata for stored sandbox` after a node is upgraded to 1.29.14. This is related to an [upstream issue with containerd](https://github.com/containerd/containerd/issues/10848). | Remove the container runtime folder with `rm -rf /var/lib/containerd`. Then restart containerd and kubelet using `systemctl restart containerd && systemctl restart kublet`. | August 17, 2025 | Edge |
2222
| Due to [an upstream issue with a Go library and CLIs for working with container registries](https://github.com/google/go-containerregistry/issues/2124), unintended or non-graceful reboots during content push operations to registries can cause consistency issues. This leads to content sync in locally managed clusters throwing the `content-length: 0 ` error. | Refer to [Troubleshooting - Edge](https://deploy-preview-7798--docs-spectrocloud.netlify.app/troubleshooting/edge/#scenario---content-length-0-errors-during-content-synchronization) for the workaround. | August 17, 2025 | Edge |
2323
| Controller mode MAAS deployments using the <VersionedLink text="Canonical Kubernetes pack" url="/integrations/packs/?pack=kubernetes-ck8s" /> automatically install the Cilium CNI. This happens because of a known issue with the Canonical Kubernetes Cluster API (CAPI) bootstrap provider and cannot be disabled. However, Palette still requires users to explicitly configure a CNI in the cluster profile. | Select the **Cillum CNI (Canonical Kubernetes)** pack when creating a cluster profile to fulfill the CNI requirement. Palette recognizes this selection and allows cluster creation to proceed, even though Cilium is installed by the bootstrap process. | August 17, 2025 | Clusters, Packs |

0 commit comments

Comments
 (0)