Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add note about nic selection #1895

Merged
merged 9 commits into from
Dec 15, 2023
8 changes: 4 additions & 4 deletions docs/docs-content/clusters/edge/networking/vxlan-overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You will not be able to change the network overlay configurations after the clus
5. Give the cluster a name, description, and tags. Click on **Next**.

6. Select a cluster profile. If you don't have a cluster profile for Edge Native, refer to the [Create Edge Native Cluster Profile](../site-deployment/model-profile.md) guide. Click on **Next** after you have selected a cluster profile.

7. In the network layer of your cluster profile, specify the name of the Network Interface Controllers (NIC) on your Edge hosts to be `scbr-100`. This is the name of the interface Palette creates on your Edge devices to establish the overlay network.

The following are the sections of the packs you need to change depending on which CNI pack you are using:
Expand Down Expand Up @@ -105,17 +105,17 @@ You will not be able to change the network overlay configurations after the clus

8. Review the rest of your cluster profile values and make changes as needed. Click on **Next**.

8. In the **Cluster Config** stage, toggle on **Enable Overlay Network**. This will prompt you to provide additional configuration for your virtual overlay network.
9. In the **Cluster Config** stage, toggle on **Enable Overlay Network**. This will prompt you to provide additional configuration for your virtual overlay network.

9. In the **Overlay CIDR Range** field, provide a private IP range for your cluster to use. Ensure that this range is not used by others in the same network environment. When you toggle on **Enable Overlay Network**, Palette provides with a default commonly unused range. We suggest you keep the default range unless you have a specific IP range you want to use.
10. In the **Overlay CIDR Range** field, provide a private IP range for your cluster to use. Ensure that this range is not used by others in the same network environment. When you toggle on **Enable Overlay Network**, Palette provides with a default commonly unused range. We suggest you keep the default range unless you have a specific IP range you want to use.

:::caution
The overlay CIDR range cannot be changed after the cluster creation.
:::

After you have provided the overlay CIDR, the **VIP** field at the top of the page will be grayed out, and the first IP address in the overlay CIDR range will be used as the Overlay VIP. This VIP is the internal overlay VIP used by the cluster.

10. Finish the rest of the cluster configurations and click **Finish Configuration** to deploy the cluster. For more information, refer to [Create Cluster Definition](../site-deployment/site-installation/cluster-deployment.md).
11. Finish the rest of the cluster configurations and click **Finish Configuration** to deploy the cluster. For more information, refer to [Create Cluster Definition](../site-deployment/site-installation/cluster-deployment.md).

## Validate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,62 @@ Use the following steps to create a new host cluster so that you can add Edge ho

If the NIC is configured on the Edge host network, an IP address is displayed next to the name of the NIC. If the NIC is not configured on the Edge host network, you can specify its IP address, default gateway, subnet mask, as well as DNS server to configure it.

If you choose to change the default NIC used by your nodes in the master node pool, you need to make sure all the NICs in the master node pool share the same name. You also must make corresponding changes in the Kubernetes layer and the Container Network Interface (CNI) layer.

In the Kubernetes layer, enter a new parameter `cluster.kubevipArgs.vip_interface` and set its value to the name of the NIC used by your master nodes. For example, if the NIC used by the nodes in your master pool is named `ens32`, add the following two lines.

```yaml {3}
cluster:
 kubevipArgs:
   vip_interface: "ens32"
```

In the CNI layer, depending on which CNI pack you choose for your cluster profile, you need to make changes in the following locations.

<Tabs>
<TabItem value="calico" label="Calico">

In the Calico pack YAML file default template, uncomment `manifests.calico.env.calicoNode.IP_AUTODETECTION_METHOD` and set its value to `interface=INTERFACE_NAME`. Replace `INTERFACE_NAME` with the name of the NIC in your master node pool. For example, set `IP_AUTODETECTION_METHOD` to `"interface=eno32"` if the NIC name of the nodes in your master pool is `eno32`.

```yaml {11}
manifests:
calico:
...
env:
# Additional env variables for calico-node
calicoNode:
#IPV6: "autodetect"
#FELIX_IPV6SUPPORT: "true"
#CALICO_IPV6POOL_NAT_OUTGOING: "true"
#CALICO_IPV4POOL_CIDR: "192.168.0.0/16"
IP_AUTODETECTION_METHOD: "interface=eno32"
```
</TabItem>
<TabItem value="flannel" label="Flannel">

In the Flannel pack YAML file, add a line `- "--iface=INTERFACE_NAME"` in the default template under `charts.flannel.args`. Replace `INTERFACE_NAME` with the name of the NIC. For example, add the line `- "--iface=eno32` if the NIC name of your master nodes is `eno32`.

```yaml {8}
charts:
flannel:
...
# flannel command arguments
args:
- "--ip-masq"
- "--kube-subnet-mgr"
- "--iface=eno32"
```
</TabItem>

<TabItem value="cilium" label="Cilium">
You do not need to make any adjustments to the Cilium pack.
</TabItem>

<TabItem value="other" label="Other">
If you are using other CNIs, refer to the documentation of your selected CNI and configure it to make sure that it picks the right NIC on your Edge hosts.
</TabItem>
</Tabs>

:::caution

After you create the cluster, you will not be able to change the IP address or NIC of your existing Edge hosts unless you remove and re-add them back to the cluster.
Expand Down Expand Up @@ -150,6 +206,62 @@ To learn more, check out the resource from the etcd documentation titled [Why an

If the NIC is configured on the Edge host network, an IP address is displayed next to the name of the NIC. If the NIC is not configured on the Edge host network, you can specify its IP address, default gateway, subnet mask, as well as DNS server to configure it.

If you choose to change the default NIC used by your nodes, you need to make sure all the NICs in the master node pool share the same name. You also must make corresponding changes in the Kubernetes layer and the CNI layer.

In the Kubernetes layer, enter a new parameter `cluster.kubevipArgs.vip_interface` and set its value to the name of the NIC used by your master nodes. For example, if the NIC used by the nodes in your master pool is named `ens32`, add the following two lines.

```yaml {2-3}
cluster:
 kubevipArgs:
   vip_interface: "ens32"
```

In the CNI layer, depending on which CNI pack you choose for your cluster profile, you need to make changes in the following locations.

<Tabs>
<TabItem value="calico" label="Calico">

In the Calico pack YAML file default template, uncomment `manifests.calico.env.calicoNode.IP_AUTODETECTION_METHOD` and set its value to `interface=INTERFACE_NAME`. Replace `INTERFACE_NAME` with the name of the NIC in your master node pool. For example, set `IP_AUTODETECTION_METHOD` to `"interface=eno32"` if the NIC name of the nodes in your master pool is `eno32`.

```yaml {11}
manifests:
calico:
...
env:
# Additional env variables for calico-node
calicoNode:
#IPV6: "autodetect"
#FELIX_IPV6SUPPORT: "true"
#CALICO_IPV6POOL_NAT_OUTGOING: "true"
#CALICO_IPV4POOL_CIDR: "192.168.0.0/16"
IP_AUTODETECTION_METHOD: "interface=eno32"
```
</TabItem>
<TabItem value="flannel" label="Flannel">

In the Flannel pack YAML file, add a line `- "--iface=INTERFACE_NAME"` in the default template under `charts.flannel.args`. Replace `INTERFACE_NAME` with the name of the NIC. For example, add the line `- "--iface=eno32` if the NIC name of your master nodes is `eno32`.

```yaml {8}
charts:
flannel:
...
# flannel command arguments
args:
- "--ip-masq"
- "--kube-subnet-mgr"
- "--iface=eno32"
```
</TabItem>

<TabItem value="cilium" label="Cilium">
You do not need to make any adjustments to the Cilium pack.
</TabItem>

<TabItem value="other" label="Other">
If you are using other CNIs, refer to the documentation of your selected CNI and configure it to make sure that it picks the right NIC on your Edge hosts.
</TabItem>
</Tabs>

:::caution

After you add the Edge host to your cluster, you will not be able to change its IP address unless you remove and re-add them back to the cluster.
Expand Down
1 change: 1 addition & 0 deletions vale/styles/Vocab/Internal/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,4 @@ OVA
Okta
Keycloak
Simple Mail Transfer Protocol
NIC