1"use strict";(self.webpackChunkspectro_cloud_docs=self.webpackChunkspectro_cloud_docs||[]).push([["11082"],{157025:function(e,n,t){t.r(n),t.d(n,{frontMatter:()=>i,toc:()=>c,default:()=>h,metadata:()=>s,assets:()=>a,contentTitle:()=>o});var s=JSON.parse('{"id":"clusters/edge/networking/vxlan-overlay","title":"Enable Overlay Network","description":"Learn how to enable a virtual overlay network you can control on top of an often unpredictable physical network.","source":"@site/docs/docs-content/clusters/edge/networking/vxlan-overlay.md","sourceDirName":"clusters/edge/networking","slug":"/clusters/edge/networking/vxlan-overlay","permalink":"/clusters/edge/networking/vxlan-overlay","draft":false,"unlisted":false,"editUrl":"https://github.com/spectrocloud/librarium/blob/master/docs/docs-content/clusters/edge/networking/vxlan-overlay.md","tags":[{"inline":true,"label":"edge","permalink":"/tags/edge"}],"version":"current","lastUpdatedAt":1777826507000,"sidebarPosition":30,"frontMatter":{"sidebar_label":"Enable Overlay Network","title":"Enable Overlay Network","description":"Learn how to enable a virtual overlay network you can control on top of an often unpredictable physical network.","hide_table_of_contents":false,"sidebar_position":30,"tags":["edge"]},"sidebar":"docSidebar","previous":{"title":"Publish Cluster Services with Kube-vip","permalink":"/clusters/edge/networking/kubevip"},"next":{"title":"Connect Edge Host to Wi-Fi","permalink":"/clusters/edge/networking/connect-wifi"}}'),r=t(474848),l=t(884429);let i={sidebar_label:"Enable Overlay Network",title:"Enable Overlay Network",description:"Learn how to enable a virtual overlay network you can control on top of an often unpredictable physical network.",hide_table_of_contents:!1,sidebar_position:30,tags:["edge"]},o,a={},c=[{value:"Supported Clusters",id:"supported-clusters",level:2},{value:"When Should You Consider Enabling Overlay Network?",id:"when-should-you-consider-enabling-overlay-network",level:2},{value:"Example Scenario",id:"example-scenario",level:3},{value:"Limitations",id:"limitations",level:2},{value:"Prerequisites",id:"prerequisites",level:2},{value:"Enable Overlay Network",id:"enable-overlay-network",level:2},{value:"Validate",id:"validate",level:2},{value:"Access Cluster with Overlay Network Enabled",id:"access-cluster-with-overlay-network-enabled",level:2},{value:"Resources",id:"resources",level:2}];function d(e){let n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,l.R)(),...e.components},{TabItem:s,Tabs:i,VersionedLink:o}=n;return s||u("TabItem",!0),i||u("Tabs",!0),o||u("VersionedLink",!0),(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Edge clusters are often deployed in locations where network environments are not managed by teams that maintain the Edge\ndeployments. However, a Kubernetes cluster, specifically several control plane components, requires stable IP addresses.\nIn the case of an extended network outage, it is possible that your cluster components would lose their original IP\naddresses when the cluster expects them to remain stable, causing the cluster to experience degraded performance or\nbecome non-operational."}),"\n",(0,r.jsx)(n.p,{children:"Palette allows you to create a virtual overlay network on top of the physical network, where the virtual IP addresses of\nall cluster components are managed by Palette. Inside the cluster, the different components use the virtual IP addresses\nto communicate with each other instead of the underlying IP addresses that could change due to external factors. If the\ncluster experiences an outage with the overlay network enabled, components inside the cluster retain their virtual IP\naddresses in the overlay network, even if their IP addresses in the underlying physical network change, protecting the\ncluster from an outage."}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{alt:"VxLAN Overlay Architecture",src:t(834950).A+"",width:"885",height:"381"})}),"\n",(0,r.jsx)(n.h2,{id:"supported-clusters",children:"Supported Clusters"}),"\n",(0,r.jsx)(n.p,{children:"The following table lists the various cluster combinations that support overlay networks."}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.strong,{children:"FIPS"})," column is based on the cluster's Kubernetes pack, not the host OS."]})}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Distribution"})}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:(0,r.jsx)(n.strong,{children:"Agent"})}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:(0,r.jsx)(n.strong,{children:"Appliance"})}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:(0,r.jsx)(n.strong,{children:"Local"})}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:(0,r.jsx)(n.strong,{children:"Central"})}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:(0,r.jsx)(n.strong,{children:"Single Node"})}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:(0,r.jsx)(n.strong,{children:"Multi-Node"})}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:(0,r.jsx)(n.strong,{children:"Non-FIPS"})}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:(0,r.jsx)(n.strong,{children:"FIPS"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(o,{text:"Canonical",url:"/integrations/packs/?pack=edge-canonical"})}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u274C"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u274C"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u274C"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(o,{text:"K3s",url:"/integrations/packs/?pack=edge-k3s"})}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u274C"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(o,{text:"PXK-E",url:"/integrations/packs/?pack=edge-k8s"})}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(o,{text:"RKE2",url:"/integrations/packs/?pack=edge-rke2"})}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"\u2705"})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"when-should-you-consider-enabling-overlay-network",children:"When Should You Consider Enabling Overlay Network?"}
1),"\n",(0,r.jsx)(n.p,{children:"If your Edge clusters are deployed in network environments that fit any of the following descriptions, you should\nconsider enabling an overlay network for your cluster:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Network environments with dynamic IP address management, such as a Dynamic Host Configuration Protocol (DHCP) network."}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Unstable network environments or environments that are out of your control. For example, you are deploying an Edge\nhost in a restaurant located in a commercial building, where the network is managed by the building and cannot be\neasily altered by your staff."}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Environments where you expect your Edge hosts to move from one physical location to another."}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"example-scenario",children:"Example Scenario"}),"\n",(0,r.jsx)(n.p,{children:"The Analytics team of a manufacturing company is deploying an Edge host to their assembly line to collect metrics from\nthe manufacturing process. The building in which the Edge host is deployed has a network that is managed by a DHCP\nserver. The region experiences a bad weather event that causes a sustained outage."}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Without Overlay Network"}),(0,r.jsx)(n.th,{children:"With Overlay Network"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Upon recovery, each Kubernetes component inside in the Edge host requests an IP address from the DHCP server and receives a different IP address than their original IP address before the outage happened. Since Kubernetes expects several components in the control plane to have stable IP addresses, the cluster becomes non-operational, and the assembly line is unable to resume operations."}),(0,r.jsx)(n.td,{children:"Each Kubernetes component inside in the Edge host has a virtual IP address in the overlay network. Upon recovery, the IP addresses in the overlay network remain the same despite the IP addresses changing in the underlying DHCP network. The Edge host is able to resume its workload, and the assembly line resumes operations."})]})})]}),"\n",(0,r.jsx)(n.h2,{id:"limitations",children:"Limitations"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"When adding multiple Edge hosts to an existing cluster with overlay enabled, failure to add one host will block the\naddition of the other hosts."}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["If you configured static IP on any host of your cluster using the\n",(0,r.jsx)(n.a,{href:"/clusters/edge/site-deployment/site-installation/initial-setup",children:"Terminal User Interface (TUI)"}),", enabling network overlay is\nnot supported. Static IPs reduce the need to configure an overlay network, but if you must use network overlay on top\nof static IPs, you can configure the static IPs using the\n",(0,r.jsx)(n.a,{href:"/clusters/edge/edge-configuration/installer-reference#site-network-parameters",children:"user data network block"})," instead."]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"At least one Edge host registered with your Palette account."}),"\n"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Your cluster profile must have one of the following Kubernetes distributions:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(o,{text:"Palette eXtended Kubernetes Edge (PXK-E)",url:"/integrations/packs/?pack=edge-k8s"}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(o,{text:"Palette Optimized Canonical",url:"/integrations/packs/?pack=edge-canonical"}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(o,{text:"Palette Optimized K3s",url:"/integrations/packs/?pack=edge-k3s"}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(o,{text:"Palette Optimized RKE2",url:"/integrations/packs/?pack=edge-rke2"}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"All Edge hosts must be on the same Layer-2 network."}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Broadcast messages must be allowed between all Edge hosts participating in the cluster."}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"For Virtual Machine
1(VM) Edge hosts in VMware, this means features such as promiscuous mode must be enabled to allow\nbroadcasts between hosts."}),"\n",(0,r.jsx)(n.li,{children:"Switches cannot implement features that block broadcasts between ports where Edge hosts are connected."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["If your host is a virtual machine using a VMXNET3 adapter, ensure that you add the following commands in the\n",(0,r.jsx)(n.code,{children:"user-data"})," file at the boot stage. Replace ",(0,r.jsx)(n.code,{children:"<interface-name>"})," with the name of the network interface on your Edge\nhost."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:"{2-6}",children:'stages:\n initramfs:\n - name: "Disable UDP segmentation"\n commands:\n - ethtool --offload <interface-name> tx-udp_tnl-segmentation off\n - ethtool --offload <interface-name> tx-udp_tnl-csum-segmentation off\n'})}),"\n",(0,r.jsxs)(n.p,{children:["This is related to a\n",(0,r.jsx)(n.a,{href:"https://github.com/cilium/cilium/issues/13096#issuecomment-723901955",children:"known issue with VMware's VMXNET3 adapter"}),",\nwhich is widely used in different virtual machine management services, including VMware vSphere and Hyper-V."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["If your host's physical IP address is static, ensure that you configure the IP address using the\n",(0,r.jsx)(n.a,{href:"/clusters/edge/edge-configuration/installer-reference#site-network-parameters",children:"network block"})," in your ",(0,r.jsx)(n.code,{children:"user-data"})," file."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["(Agent Mode only) By default, Edge hosts deployed using\n",(0,r.jsx)(n.a,{href:"/deployment-modes/appliance-mode/",children:"Appliance Mode"})," use ",(0,r.jsx)(n.code,{children:"systemd-networkd"})," for interface\nmanagement and ",(0,r.jsx)(n.code,{children:"systemd-resolved"})," for DNS resolution in overlay networks. If using\n",(0,r.jsx)(n.a,{href:"/deployment-modes/agent-mode/",children:"Agent Mode"}),", you must confirm that ",(0,r.jsx)(n.code,{children:"systemd-networkd"})," and\n",(0,r.jsx)(n.code,{children:"systemd-resolved"})," are installed on your Edge hosts and properly configured. Refer to our\n",(0,r.jsx)(n.a,{href:"/deployment-modes/agent-mode/overlay-preparation",children:"Configure networkd to Prepare Host for Overlay Network"}),"\nguide for more information."]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"enable-overlay-network",children:"Enable Overlay Network"}),"\n",(0,r.jsx)(n.p,{children:"You can enable an overlay network for your cluster during cluster creation."}),"\n",(0,r.jsx)(n.admonition,{type:"warning",children:(0,r.jsx)(n.p,{children:"You cannot change network overlay configurations after the cluster is created."})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Log in to ",(0,r.jsx)(n.a,{href:"https://console.spectrocloud.com",children:"Palette"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Navigate to the left main menu and select ",(0,r.jsx)(n.strong,{children:"Clusters"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Choose ",(0,r.jsx)(n.strong,{children:"Add New Cluster"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Select ",(0,r.jsx)(n.strong,{children:"Edge Native"})," for the cluster type and choose ",(0,r.jsx)(n.strong,{children:"Start Edge Native Configuration"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Enter a ",(0,r.jsx)(n.strong,{children:"Cluster name"}),", ",(0,r.jsx)(n.strong,{children:"Description"}),", and ",(0,r.jsx)(n.strong,{children:"Tags"}),". Select ",(0,r.jsx)(n.strong,{children:"Next"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Select ",(0,r.jsx)(n.strong,{children:"Add cluster profile"}),", choose the appropriate profile, and ",(0,r.jsx)(n.strong,{children:"Confirm"})," your selection. If you don't have a\ncluster profile for Edge Native, refer to the\n",(0,r.jsx)(n.a,{href:"/clusters/edge/site-deployment/model-profile",children:"Create Edge Native Cluster Profile"})," guide."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"7",children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Depending on your Palette version and the Container Network Interface (CNI) pack you use for your cluster,\nyou may need to modify the name of your Network Interface Controllers (NICs) on your Edge hosts. Starting with\nPalette Agent version 4.7.9 (Palette version 4.7.13), you only need to modify NICs on Edge hosts if you use a\nCNI pack other than ",(0,r.jsx)(o,{text:"Calico",url:"/integrations/cni-calico"}),",\n",(0,r.jsx)(o,{text:"Cilium",url:"/integrations/cni-cilium-oss"}),", or\n",(0,r.jsx)(o,{text:"Flannel",url:"/integrations/cni-flannel"}),".\nFollow the appropriate workflow based on your setup."]}),"\n",(0,r.jsxs)(i,{children:[(0,r.jsx)(s,{value:"Palette Agent >= 4.7.9",label:"Palette Agent >= 4.7.9",children:(0,r.jsxs)(n.p,{children:["If you are using a CNI pack other than\n",(0,r.jsx)(o,{text:"Calico",url:"/integrations/cni-calico"}),",\n",(0,r.jsx)(o,{text:"Cilium",url:"/integrations/cni-cilium-oss"}),", or\n",(0,r.jsx)(o,{text:"Flannel",url:"/integrations/cni-flannel"}),", you must set the name of your NICs on your Edge hosts to ",(0,r.jsx)(n.code,{children:"scbr-100"}),".\nThis is the name of the interface Palette creates on your Edge devices to establish the overlay network. Refer to the\ndocumentation of your selected CNI and configure it to make sure it picks\nthe NIC named ",(0,r.jsx)(n.code,{children:"scbr-100"})," on your Edge host."]})}),(0,r.jsx)(s,{value:"Palette Agent < 4.7.9",label:"Palette Agent < 4.7.9",children:(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["In the Kubernetes layer of your cluster profile, on the ",(0,r.jsx)(n.strong,{children:"Values"})," tab, uncomment the parameter\n",(0,r.jsx)(n.code,{children:"cluster.kubevipArgs.vip_interface"})," and set its value to ",(0,r.jsx)(n.code,{children:"scbr-100"}),"."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'cluster:\n kubevipArgs:\n vip_interface: "scbr-100"\n'})}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["In the network layer of your cluster profile, set the name of the NIC on your\nEdge hosts to ",(0,r.jsx)(n.code,{children:"scbr-100"}),". This is the name of the interface Palette creates on your Edge devices to establish the\noverlay network."]}),"\n",(0,r.jsx)(n.p,{children:"Change the following sections of the packs depending on which CNI pack you use."}),"\n",(0,r.jsxs)(i,{children:[(0,r.jsxs)(s,{value:"calico",label:"Calico",children:[(0,r.jsxs)(n.p,{children:["In the ",(0,r.jsx)(o,{text:"Calico",url:"/integrations/cni-calico"})," pack YAML file, add\n",(0,r.jsx)(n.code,{children:"manifests.calico.env.calicoNode.FELIX_MTUIFACEPATTERN"})," and set its value to ",(0,r.jsx)(n.code,{children:"scbr-100"}),". Uncomment\n",(0,r.jsx)(n.code,{children:"manifests.calico.env.calicoNode.IP_AUTODETECTION_METHOD"})," and set its value to\n",(0,r.jsx)(n.code,{children:"interface=scbr-100"}),"."]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:"{8,11}",children:'manifests:\n calico:\n ...\n env:\n # Additional env variables for calico-node\n calicoNode:\n #IPV6: "autodetect"\n FELIX_MTUIFACEPATTERN: "scbr-100"\n #CALICO_IPV6POOL_NAT_OUTGOING: "true"\n #CALICO_IPV4POOL_CIDR: "192.168.0.0/16"\n IP_AUTODETECTION_METHOD: "interface=scbr-100"\n'})})]}),(0,r.jsx)(s,{value:"cilium",label:"Cilium",children:(0,r.jsxs)(n.p,{children:["You do not need to make any adjustments to the ",(0,r.jsx)(o,{text:"Cilium",url:"/integrations/cni-cilium-oss"})," pack."]})}),(0,r.jsxs)(s,{value:"flannel",label:"Flannel",children:[(0,r.jsxs)(n.p,{children:["In the ",(0,r.jsx)(o,{text:"Flannel",url:"/integrations/cni-flannel"})," pack YAML file, add the line\n",(0,r.jsx)(n.code,{children:'- "--iface=scbr-100"'})," in the default template under ",(0,r.jsx)(n.code,{children:"charts.flannel.args"}),"."]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:"{8}",children:'charts:\n flannel:\n ...\n # flannel command arguments\n args:\n - "--ip-masq"\n - "--kube-subnet-mgr"\n - "--iface=scbr-100"\n'})})]}),(0,r.jsx)(s,{value:"other",label:"Other",children:(0,r.jsxs)(n.p,{children:["If you are using other CNIs, refer to the documentation of your selected CNI and configure it to make sure that it\npicks the NIC named ",(0,r.jsx)(n.code,{children:"scbr-100"})," on your Edge host."]})})]}),"\n"]}),"\n"]})})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"8",children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Review your cluster profile values and make changes as needed. Select ",(0,r.jsx)(n.strong,{children:"Next"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["On the ",(0,r.jsx)(n.strong,{children:"Cluster Config"})," stage, toggle on ",(0,r.jsx)(n.strong,{children:"Enable overlay"}),". The ",(0,r.jsx)(n.strong,{children:"VIP"})," field disappears and is replaced by\n",(0,r.jsx)(n.strong,{children:"Overlay CIDR range"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["In the ",(0,r.jsx)(n.strong,{children:"Overlay CIDR range"})," field, provide a private IP range for your cluster to use. Ensure this range is not\nused by others in the same network environment. When you toggle on ",(0,r.jsx)(n.strong,{children:"Enable overlay"}),", Palette provides a default\nrange that is typically unused. We suggest you keep the default range unless you have a specific IP range you want\nto use."]}),"\n",(0,r.jsx)(n.p,{children:"The first IP address in the overlay CIDR range will be used as the overlay VIP. This VIP is the internal overlay VIP\nused by the cluster."}),"\n",(0,r.jsx)(n.admonition,{type:"warning",children:(0,r.jsx)(n.p,{children:"The overlay CIDR range cannot be changed after the cluster is created."})}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Finis
1h configuring your cluster and select ",(0,r.jsx)(n.strong,{children:"Finish Configuration"})," to deploy the cluster. For more information,\nrefer to ",(0,r.jsx)(n.a,{href:"/clusters/edge/site-deployment/cluster-deployment",children:"Create Cluster Definition"}),"."]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"validate",children:"Validate"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Log in to ",(0,r.jsx)(n.a,{href:"https://console.spectrocloud.com",children:"Palette"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Navigate to the left main menu and select ",(0,r.jsx)(n.strong,{children:"Clusters"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Select the host cluster you created to view its details page."}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Select the ",(0,r.jsx)(n.strong,{children:"Nodes"})," tab. For each host, the ",(0,r.jsx)(n.strong,{children:"Private Ips"})," column lists an overlay IP address within the CIDR range\nyou provided during cluster configuration."]}),"\n",(0,r.jsx)(n.admonition,{type:"tip",children:(0,r.jsxs)(n.p,{children:["To view the external IP addresses of the Edge hosts, from the left main menu, select ",(0,r.jsx)(n.strong,{children:"Clusters > Edge Hosts"}),". The\nIP address displayed in the table is the external IP address."]})}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"access-cluster-with-overlay-network-enabled",children:"Access Cluster with Overlay Network Enabled"}),"\n",(0,r.jsx)(n.p,{children:"You can access a cluster with overlay network enabled in the following ways:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Access the cluster with ",(0,r.jsx)(n.code,{children:"kubectl"}),". For more information, refer to\n",(0,r.jsx)(n.a,{href:"/clusters/cluster-management/palette-webctl",children:"Access Cluster with CLI"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Access LoadBalancer services. You can provision LoadBalancer services in your Kubernetes cluster and expose them to\nexternal traffic. For more information, refer to ",(0,r.jsx)(n.a,{href:"/clusters/edge/networking/kubevip",children:"Publish Cluster Services with Kube-vip"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Access a node via its IP address. You can use the node's external IP address to access the node directly. The overlay\nIP addresses are internal to the cluster itself and cannot be accessed from outside the cluster."}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"resources",children:"Resources"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/clusters/edge/networking/kubevip",children:"Publish Cluster Services with Kube-vip"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/troubleshooting/edge/",children:"Troubleshooting - Edge"})}),"\n"]})]})}function h(e={}){let{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}function u(e,n){throw Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},834950:function(e,n,t){t.d(n,{A:()=>s});let s=t.p+"assets/images/clusters_edge_site-installation_vxlan-overlay_architecture-a2bd51ec4ac746e9f3cc5cfaefbca9b7.webp"},884429:function(e,n,t){t.d(n,{R:()=>i,x:()=>o});var s=t(296540);let r={},l=s.createContext(r);function i(e){let n=s.useContext(l);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.