Skip to main content

Deploy an IPv6 Edge Cluster

Palette Edge supports IPv6-only clusters and dual-stack clusters. In an IPv6-only cluster, the nodes, pods, and services use IPv6 addresses. In a dual-stack cluster, they use both IPv4 and IPv6 addresses. In both cases, the cluster has a single Virtual IP (VIP) address.

This guide explains how to configure a cluster profile for IPv6, check your Edge hosts, and create and validate the cluster.

Limitations​

  • IPv6 is supported for centrally managed Edge clusters only. Locally managed clusters that you create with Local UI are not supported.

  • IPv6 is not supported for Edge hosts in agent mode or for airgapped Edge hosts.

  • IPv6 is supported with Palette eXtended Kubernetes Edge (PXK-E) only. Canonical Kubernetes, K3s, and RKE2 are not supported.

  • IPv6 is supported with the Cilium Container Network Interface (CNI) only.

  • All Edge hosts in a cluster must use the same IP address families. You cannot combine Edge hosts that use only IPv4 addresses with Edge hosts that use IPv6 addresses in one cluster.

  • A cluster has one VIP, which is an IPv4 address, an IPv6 address, or a Fully Qualified Domain Name (FQDN). You cannot assign both an IPv4 VIP and an IPv6 VIP to the same cluster, including a dual-stack cluster.

  • Edge hosts must receive their IPv6 addresses through Dynamic Host Configuration Protocol (DHCP) or Stateless Address Autoconfiguration (SLAAC). Static IPv6 addresses on Edge hosts are not supported.

  • Overlay networks are not supported with IPv6. Refer to Enable Overlay Network for more information about overlay networks.

  • IPv6 is not validated with single-node Edge clusters. Use a multi-node cluster.

  • Two-node high availability clusters are not supported with IPv6.

  • IPv6 is not validated with Trusted Boot.

Prerequisites​

  • Palette version 4.10.46 or later. Every Edge host must use the Palette agent version that corresponds to Palette 4.10.46, or a later version. Refer to the Edge Compatibility Matrix to identify the Palette agent version, which the matrix lists as the Edge host version.
  • Two or more Edge hosts that are deployed in appliance mode and registered with Palette. Refer to Register Edge Host for guidance.

  • An IPv6 address on each Edge host that the host received through DHCP or SLAAC. For a dual-stack cluster, each Edge host also needs an IPv4 address.

  • IPv6 forwarding enabled on every Edge host. Appliance mode enables IPv6 forwarding. A Security Technical Implementation Guide (STIG) remediation can disable it. If you use a STIG-hardened image, enable IPv6 forwarding after the remediation.

  • If your Edge hosts connect through a proxy server, use bracketed IPv6 addresses in the proxy settings, for example, http://[fd00::1]:3128, and add your IPv6 CIDR ranges to stylus.site.network.noProxy. Refer to Edge Installer Configuration Reference for guidance.

  • One unused IP address in the network of your Edge hosts for the VIP of the cluster. An IPv6-only cluster requires an IPv6 address.

  • Two IPv6 Classless Inter-Domain Routing (CIDR) ranges that do not overlap with your network, one for pods and one for services. A dual-stack cluster also needs two IPv4 CIDR ranges.

  • Access to a terminal session on each Edge host.

  • kubectl installed to validate the cluster.

Configure the Cluster Profile​

  1. Log in to Palette.

  2. From the left main menu, select Profiles, and then select your Edge cluster profile.

  3. Select the Kubernetes layer of the cluster profile.

  4. Use the YAML editor to set the pod CIDR and the service CIDR under cluster.config.clusterConfiguration.networking.

    cluster:
    config: |
    clusterConfiguration:
    networking:
    podSubnet: <ipv6-pod-cidr>
    serviceSubnet: <ipv6-service-cidr>

    Replace <ipv6-pod-cidr> with the IPv6 CIDR range for pods, such as fd00:10:244::/56, and <ipv6-service-cidr> with the IPv6 CIDR range for services, such as fd00:10:96::/112.

  5. Under cluster.kubevipArgs, set vip_arp to true.

    cluster:
    kubevipArgs:
    vip_arp: true
  6. Select Confirm Updates.

  7. Select the Network layer of the cluster profile, and confirm that it contains the Cilium pack. Keep the default values of the pack.

  1. (Optional) If your cluster profile contains the MetalLB pack, add an IPv6 address pool to the pack values.
  1. Select Save Changes.

Check the Edge Hosts​

Complete the following steps on each Edge host that you plan to add to the cluster.

  1. Open a terminal session on the Edge host.

  2. List the IPv6 addresses of the host, and confirm that the Network Interface Card (NIC) that the cluster uses has an IPv6 address from DHCP or SLAAC.

    ip -family inet6 address show
  3. Confirm that IPv6 forwarding is enabled. Both values must be 1.

    sysctl net.ipv6.conf.all.forwarding net.ipv6.conf.default.forwarding
    Example Output
    net.ipv6.conf.all.forwarding = 1
    net.ipv6.conf.default.forwarding = 1

Create the Cluster​

  1. Follow the steps in Create an Edge Native Host Cluster, and use the following settings for IPv6.

    SettingValue
    Cluster profileThe cluster profile that you configured in Configure the Cluster Profile.
    VIPOne IP address. An IPv6-only cluster requires an IPv6 address. Enter an IPv6 address without brackets, for example, fd00:150::100.
    Enable overlayLeave this setting disabled.
    Edge hostsAdd only Edge hosts whose IP address families match the cluster. If an Edge host has more than one NIC, select the NIC that has the IPv6 address.
  2. Wait until the Cluster Status field displays Running.

Validate​

Use the following steps to confirm that the cluster uses IPv6. The kubectl steps require access to the cluster. Refer to Kubectl to obtain the kubeconfig file, and then set the KUBECONFIG environment variable.

export KUBECONFIG=<path-to-kubeconfig>

Replace <path-to-kubeconfig> with the path to the kubeconfig file of the cluster.

  1. List the nodes. In an IPv6-only cluster, the INTERNAL-IP column displays an IPv6 address for each node. In a dual-stack cluster, the column displays one address for each node.

    kubectl get nodes --output wide
  2. (Dual-stack clusters only) List all addresses of each node, and confirm that each node has an IPv4 address and an IPv6 address.

    kubectl get nodes --output jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.addresses[?(@.type=="InternalIP")].address}{"\n"}{end}'
  3. Review the kubernetes service. In an IPv6-only cluster, the CLUSTER-IP column displays an IPv6 address. In a dual-stack cluster, the column displays an address from the first service CIDR range.

    kubectl get service kubernetes
  4. List the pods. In an IPv6-only cluster, the IP column displays IPv6 addresses. In a dual-stack cluster, the column displays the address from the first pod CIDR range only.

    kubectl get pods --all-namespaces --output wide
  5. Confirm that the kube-vip pods and the Cilium pods are in the Running state.

    kubectl get pods --namespace kube-system
  6. Confirm that the Kubernetes API server answers on the VIP. The command returns ok.

    curl --insecure "https://[<vip-address>]:6443/healthz"

    Replace <vip-address> with the VIP of the cluster. Keep the brackets around an IPv6 address, and remove them for an IPv4 address.

  7. Check the status of Cilium.

    cilium status

Next Steps​

To expose cluster services of type LoadBalancer through kube-vip, refer to Publish Cluster Services with Kube-vip.