From 2e78db0f394f39bf7c116df3cf753f2871cd6edf Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Wed, 13 Dec 2023 14:17:04 -0800 Subject: [PATCH 1/7] docs: add note about nic selection --- .../site-installation/cluster-deployment.md | 112 ++++++++++++++++++ 1 file changed, 112 insertions(+) diff --git a/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md b/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md index 2d60d93aba..c567cd8315 100644 --- a/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md +++ b/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md @@ -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, 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 {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. + + + + + 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 interface or a regular expression (regex) that matches the name of the interface. For example, the following code snippet works for any NIC name that starts with `eno`. + + ```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=eno*" + ``` + + + + 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 interface or a regular expression (regex) that matches the name of the interface. For example, the following code snippet works for any NIC name that starts with `eno`. + + ```yaml {8} + charts: + flannel: + ... + # flannel command arguments + args: + - "--ip-masq" + - "--kube-subnet-mgr" + - "--iface=eno*" + ``` + + + + You do not need to make any adjustments to the Cilium pack. + + + + 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. + + + :::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. @@ -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. + + + + + 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 interface or a regular expression (regex) that matches the name of the interface. For example, the following code snippet works for any NIC name that starts with `eno`. + + ```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=eno*" + ``` + + + + 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 interface or a regular expression (regex) that matches the name of the interface. For example, the following code snippet works for any NIC name that starts with `eno`. + + ```yaml {8} + charts: + flannel: + ... + # flannel command arguments + args: + - "--ip-masq" + - "--kube-subnet-mgr" + - "--iface=eno*" + ``` + + + + You do not need to make any adjustments to the Cilium pack. + + + + 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. + + + :::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. From 5bfd07f409a3fe268a1df5f969daf78b823e7741 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Wed, 13 Dec 2023 14:24:41 -0800 Subject: [PATCH 2/7] docs: add NIC to accepted words --- vale/styles/Vocab/Internal/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/vale/styles/Vocab/Internal/accept.txt b/vale/styles/Vocab/Internal/accept.txt index 43800d7566..d06da4f02f 100644 --- a/vale/styles/Vocab/Internal/accept.txt +++ b/vale/styles/Vocab/Internal/accept.txt @@ -166,3 +166,4 @@ OVA Okta Keycloak Simple Mail Transfer Protocol +NIC From 4a869eb32e9d67abde97df2484750d4435249f84 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Fri, 15 Dec 2023 09:01:53 -0800 Subject: [PATCH 3/7] docs: add note about updating nic in overlay document --- .../clusters/edge/networking/vxlan-overlay.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/docs-content/clusters/edge/networking/vxlan-overlay.md b/docs/docs-content/clusters/edge/networking/vxlan-overlay.md index df136571da..0c321ab7ee 100644 --- a/docs/docs-content/clusters/edge/networking/vxlan-overlay.md +++ b/docs/docs-content/clusters/edge/networking/vxlan-overlay.md @@ -57,7 +57,15 @@ You will not be able to change the network overlay configurations after the clus 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. +7. In the Kubernetes layer of your cluster profile, add the parameter `cluster.kubevipArgs.vip_interface` and set its value to `scbr-100.` + + ```yaml + cluster: +  kubevipArgs: +    vip_interface: "scbr-100" + ``` + +8. 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: @@ -103,11 +111,11 @@ 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**. +9. 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. +10. 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. +11. 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. @@ -115,7 +123,7 @@ You will not be able to change the network overlay configurations after the clus 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). +12. 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 From e810e2c6e3e9c9caf70a895e6d3c43d4bf903186 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Fri, 15 Dec 2023 09:07:24 -0800 Subject: [PATCH 4/7] remove redundant step --- .../clusters/edge/networking/vxlan-overlay.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/docs-content/clusters/edge/networking/vxlan-overlay.md b/docs/docs-content/clusters/edge/networking/vxlan-overlay.md index 0c321ab7ee..0a130f81fe 100644 --- a/docs/docs-content/clusters/edge/networking/vxlan-overlay.md +++ b/docs/docs-content/clusters/edge/networking/vxlan-overlay.md @@ -57,15 +57,7 @@ You will not be able to change the network overlay configurations after the clus 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 Kubernetes layer of your cluster profile, add the parameter `cluster.kubevipArgs.vip_interface` and set its value to `scbr-100.` - - ```yaml - cluster: -  kubevipArgs: -    vip_interface: "scbr-100" - ``` - -8. 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. +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: @@ -111,11 +103,11 @@ You will not be able to change the network overlay configurations after the clus -9. Review the rest of your cluster profile values and make changes as needed. Click on **Next**. +8. Review the rest of your cluster profile values and make changes as needed. Click on **Next**. -10. 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. -11. 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. @@ -123,7 +115,7 @@ You will not be able to change the network overlay configurations after the clus 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. -12. 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 From 6fb47c7b0d156c530e76bb74996fe047d75f2fa4 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Fri, 15 Dec 2023 09:34:19 -0800 Subject: [PATCH 5/7] docs: minor fix --- .../site-deployment/site-installation/cluster-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md b/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md index c567cd8315..09470bdccb 100644 --- a/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md +++ b/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md @@ -66,7 +66,7 @@ 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, 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. + 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 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. From e1387201a12272ef5c43586e64c340098baae92f Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Fri, 15 Dec 2023 09:56:50 -0800 Subject: [PATCH 6/7] docs: add requirement that nics share the same name --- .../site-installation/cluster-deployment.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md b/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md index 09470bdccb..533af8631e 100644 --- a/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md +++ b/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md @@ -66,7 +66,7 @@ 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, 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. + 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. @@ -81,7 +81,7 @@ Use the following steps to create a new host cluster so that you can add Edge ho - 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 interface or a regular expression (regex) that matches the name of the interface. For example, the following code snippet works for any NIC name that starts with `eno`. + 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 paster pool is `eno32`. ```yaml {11} manifests: @@ -94,12 +94,12 @@ Use the following steps to create a new host cluster so that you can add Edge ho #FELIX_IPV6SUPPORT: "true" #CALICO_IPV6POOL_NAT_OUTGOING: "true" #CALICO_IPV4POOL_CIDR: "192.168.0.0/16" - IP_AUTODETECTION_METHOD: "interface=eno*" + IP_AUTODETECTION_METHOD: "interface=eno32" ``` - 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 interface or a regular expression (regex) that matches the name of the interface. For example, the following code snippet works for any NIC name that starts with `eno`. + 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: @@ -109,7 +109,7 @@ Use the following steps to create a new host cluster so that you can add Edge ho args: - "--ip-masq" - "--kube-subnet-mgr" - - "--iface=eno*" + - "--iface=eno32" ``` @@ -206,7 +206,7 @@ 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. + 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. @@ -221,7 +221,7 @@ To learn more, check out the resource from the etcd documentation titled [Why an - 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 interface or a regular expression (regex) that matches the name of the interface. For example, the following code snippet works for any NIC name that starts with `eno`. + 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 paster pool is `eno32`. ```yaml {11} manifests: @@ -234,12 +234,12 @@ To learn more, check out the resource from the etcd documentation titled [Why an #FELIX_IPV6SUPPORT: "true" #CALICO_IPV6POOL_NAT_OUTGOING: "true" #CALICO_IPV4POOL_CIDR: "192.168.0.0/16" - IP_AUTODETECTION_METHOD: "interface=eno*" + IP_AUTODETECTION_METHOD: "interface=eno32" ``` - 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 interface or a regular expression (regex) that matches the name of the interface. For example, the following code snippet works for any NIC name that starts with `eno`. + 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: @@ -249,7 +249,7 @@ To learn more, check out the resource from the etcd documentation titled [Why an args: - "--ip-masq" - "--kube-subnet-mgr" - - "--iface=eno*" + - "--iface=eno32" ``` From 310cf933ff5544ed57abf927539f826d8a80d55c Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Fri, 15 Dec 2023 11:42:38 -0800 Subject: [PATCH 7/7] fix typo --- .../site-deployment/site-installation/cluster-deployment.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md b/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md index 533af8631e..5862957517 100644 --- a/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md +++ b/docs/docs-content/clusters/edge/site-deployment/site-installation/cluster-deployment.md @@ -81,7 +81,7 @@ Use the following steps to create a new host cluster so that you can add Edge ho - 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 paster pool is `eno32`. + 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: @@ -221,7 +221,7 @@ To learn more, check out the resource from the etcd documentation titled [Why an - 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 paster pool is `eno32`. + 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: