Add test for node-external-ip config parameter

tests/e2e/dualstack/dualstack_test.go

@@ -18,46 +18,6 @@ var serverCount = flag.Int("serverCount", 1, "number of server nodes")
 var agentCount = flag.Int("agentCount", 1, "number of agent nodes")
 var hardened = flag.Bool("hardened", false, "true or false")
 
-// Environment Variables Info:
-// E2E_RELEASE_VERSION=v1.23.1+k3s1 or nil for latest commit from master
-
-type objIP struct {
-	name string
-	ipv4 string
-	ipv6 string
-}
-
-func getPodIPs(kubeConfigFile string) ([]objIP, error) {
-	cmd := `kubectl get pods -A -o=jsonpath='{range .items[*]}{.metadata.name}{" "}{.status.podIPs[*].ip}{"\n"}{end}' --kubeconfig=` + kubeConfigFile
-	return getObjIPs(cmd)
-}
-func getNodeIPs(kubeConfigFile string) ([]objIP, error) {
-	cmd := `kubectl get nodes -o jsonpath='{range .items[*]}{.metadata.name}{" "}{.status.addresses[?(@.type == "InternalIP")].address}{"\n"}{end}' --kubeconfig=` + kubeConfigFile
-	return getObjIPs(cmd)
-}
-
-func getObjIPs(cmd string) ([]objIP, error) {
-	var objIPs []objIP
-	res, err := e2e.RunCommand(cmd)
-	if err != nil {
-		return nil, err
-	}
-	objs := strings.Split(res, "\n")
-	objs = objs[:len(objs)-1]
-
-	for _, obj := range objs {
-		fields := strings.Fields(obj)
-		if len(fields) > 2 {
-			objIPs = append(objIPs, objIP{name: fields[0], ipv4: fields[1], ipv6: fields[2]})
-		} else if len(fields) > 1 {
-			objIPs = append(objIPs, objIP{name: fields[0], ipv4: fields[1]})
-		} else {
-			objIPs = append(objIPs, objIP{name: fields[0]})
-		}
-	}
-	return objIPs, nil
-}
-
 func Test_E2EDualStack(t *testing.T) {
 	flag.Parse()
 	RegisterFailHandler(Fail)
@@ -113,19 +73,19 @@ var _ = Describe("Verify DualStack Configuration", Ordered, func() {
 	})
 
 	It("Verifies that each node has IPv4 and IPv6", func() {
-		nodeIPs, err := getNodeIPs(kubeConfigFile)
+		nodeIPs, err := e2e.GetNodeIPs(kubeConfigFile)
 		Expect(err).NotTo(HaveOccurred())
 		for _, node := range nodeIPs {
-			Expect(node.ipv4).Should(ContainSubstring("10.10.10"))
-			Expect(node.ipv6).Should(ContainSubstring("fd11:decf:c0ff"))
+			Expect(node.IPv4).Should(ContainSubstring("10.10.10"))
+			Expect(node.IPv6).Should(ContainSubstring("fd11:decf:c0ff"))
 		}
 	})
 	It("Verifies that each pod has IPv4 and IPv6", func() {
-		podIPs, err := getPodIPs(kubeConfigFile)
+		podIPs, err := e2e.GetPodIPs(kubeConfigFile)
 		Expect(err).NotTo(HaveOccurred())
 		for _, pod := range podIPs {
-			Expect(pod.ipv4).Should(Or(ContainSubstring("10.10.10"), ContainSubstring("10.42.")), pod.name)
-			Expect(pod.ipv6).Should(Or(ContainSubstring("fd11:decf:c0ff"), ContainSubstring("2001:cafe:42")), pod.name)
+			Expect(pod.IPv4).Should(Or(ContainSubstring("10.10.10"), ContainSubstring("10.42.")), pod.Name)
+			Expect(pod.IPv6).Should(Or(ContainSubstring("fd11:decf:c0ff"), ContainSubstring("2001:cafe:42")), pod.Name)
 		}
 	})
 
@@ -163,14 +123,14 @@ var _ = Describe("Verify DualStack Configuration", Ordered, func() {
 		cmd := "kubectl get ingress ds-ingress --kubeconfig=" + kubeConfigFile + " -o jsonpath=\"{.spec.rules[*].host}\""
 		hostName, err := e2e.RunCommand(cmd)
 		Expect(err).NotTo(HaveOccurred(), "failed cmd: "+cmd)
-		nodeIPs, err := getNodeIPs(kubeConfigFile)
+		nodeIPs, err := e2e.GetNodeIPs(kubeConfigFile)
 		Expect(err).NotTo(HaveOccurred(), "failed cmd: "+cmd)
 		for _, node := range nodeIPs {
-			cmd := fmt.Sprintf("curl  --header host:%s http://%s/name.html", hostName, node.ipv4)
+			cmd := fmt.Sprintf("curl  --header host:%s http://%s/name.html", hostName, node.IPv4)
 			Eventually(func() (string, error) {
 				return e2e.RunCommand(cmd)
 			}, "10s", "2s").Should(ContainSubstring("ds-clusterip-pod"), "failed cmd: "+cmd)
-			cmd = fmt.Sprintf("curl  --header host:%s http://[%s]/name.html", hostName, node.ipv6)
+			cmd = fmt.Sprintf("curl  --header host:%s http://[%s]/name.html", hostName, node.IPv6)
 			Eventually(func() (string, error) {
 				return e2e.RunCommand(cmd)
 			}, "5s", "1s").Should(ContainSubstring("ds-clusterip-pod"), "failed cmd: "+cmd)
@@ -183,14 +143,14 @@ var _ = Describe("Verify DualStack Configuration", Ordered, func() {
 		cmd := "kubectl get service ds-nodeport-svc --kubeconfig=" + kubeConfigFile + " --output jsonpath=\"{.spec.ports[0].nodePort}\""
 		nodeport, err := e2e.RunCommand(cmd)
 		Expect(err).NotTo(HaveOccurred(), "failed cmd: "+cmd)
-		nodeIPs, err := getNodeIPs(kubeConfigFile)
+		nodeIPs, err := e2e.GetNodeIPs(kubeConfigFile)
 		Expect(err).NotTo(HaveOccurred())
 		for _, node := range nodeIPs {
-			cmd = "curl -L --insecure http://" + node.ipv4 + ":" + nodeport + "/name.html"
+			cmd = "curl -L --insecure http://" + node.IPv4 + ":" + nodeport + "/name.html"
 			Eventually(func() (string, error) {
 				return e2e.RunCommand(cmd)
 			}, "10s", "1s").Should(ContainSubstring("ds-nodeport-pod"), "failed cmd: "+cmd)
-			cmd = "curl -L --insecure http://[" + node.ipv6 + "]:" + nodeport + "/name.html"
+			cmd = "curl -L --insecure http://[" + node.IPv6 + "]:" + nodeport + "/name.html"
 			Eventually(func() (string, error) {
 				return e2e.RunCommand(cmd)
 			}, "10s", "1s").Should(ContainSubstring("ds-nodeport-pod"), "failed cmd: "+cmd)

tests/e2e/externalip/Vagrantfile

+ENV['VAGRANT_NO_PARALLEL'] = 'no'
+NODE_ROLES = (ENV['E2E_NODE_ROLES'] ||
+  ["server-0", "agent-0" ])
+NODE_BOXES = (ENV['E2E_NODE_BOXES'] ||
+  ['generic/ubuntu2004', 'generic/ubuntu2004'])
+GITHUB_BRANCH = (ENV['E2E_GITHUB_BRANCH'] || "master")
+RELEASE_VERSION = (ENV['E2E_RELEASE_VERSION'] || "")
+NODE_CPUS = (ENV['E2E_NODE_CPUS'] || 2).to_i
+NODE_MEMORY = (ENV['E2E_NODE_MEMORY'] || 2048).to_i
+NETWORK4_PREFIX = "10.10.10"
+PUBLIC_NETWORK4_PREFIX = "10.100.100"
+install_type = ""
+
+def provision(vm, roles, role_num, node_num)
+  vm.box = NODE_BOXES[node_num]
+  vm.hostname = "#{roles[0]}-#{role_num}"
+  node_ip4 = "#{NETWORK4_PREFIX}.#{100+node_num}"
+  node_ip4_public = "#{PUBLIC_NETWORK4_PREFIX}.#{100+node_num}"
+  vm.network "private_network", 
+    :ip => node_ip4,
+    :netmask => "255.255.255.0",
+    :libvirt__dhcp_enabled => false,
+    :libvirt__forward_mode => "none"
+  vm.network "private_network", 
+    :ip => node_ip4_public,
+    :netmask => "255.255.255.0",
+    :libvirt__dhcp_enabled => false,
+    :libvirt__forward_mode => "none"
+    
+  scripts_location = Dir.exists?("./scripts") ? "./scripts" : "../scripts" 
+  vagrant_defaults = File.exists?("./vagrantdefaults.rb") ? "./vagrantdefaults.rb" : "../vagrantdefaults.rb"
+  load vagrant_defaults
+  
+  defaultOSConfigure(vm)
+
+  install_type = getInstallType(vm, RELEASE_VERSION, GITHUB_BRANCH)
+  
+  if roles.include?("server") && role_num == 0
+    vm.provision :k3s, run: 'once' do |k3s|
+      k3s.config_mode = '0644' # side-step https://github.com/k3s-io/k3s/issues/4321
+      k3s.args = "server "
+      k3s.config = <<~YAML
+        node-external-ip: #{node_ip4_public}
+        node-ip: #{node_ip4}
+        token: vagrant
+        flannel-backend: wireguard-native
+        flannel-external-ip: true
+      YAML
+      k3s.env = ["K3S_KUBECONFIG_MODE=0644", install_type]
+    end
+  end
+  if roles.include?("agent")
+    vm.provision :k3s, run: 'once' do |k3s|
+      k3s.config_mode = '0644' # side-step https://github.com/k3s-io/k3s/issues/4321
+      k3s.args = "agent "
+      k3s.config = <<~YAML
+        node-external-ip: #{node_ip4_public}
+        server: https://#{PUBLIC_NETWORK4_PREFIX}.100:6443
+        token: vagrant
+        node-ip: #{node_ip4}
+        flannel-iface: eth1
+      YAML
+      k3s.env = ["K3S_KUBECONFIG_MODE=0644", install_type]
+    end
+  end
+  # Make sure cluster traffic cannot flow via eth1 
+  vm.provision "Disable forwarding", type: "shell", inline: "sysctl -w net.ipv4.conf.eth1.forwarding=0"
+end
+
+Vagrant.configure("2") do |config|
+  config.vagrant.plugins = ["vagrant-k3s", "vagrant-reload", "vagrant-libvirt"]
+  config.vm.provider "libvirt" do |v|
+    v.cpus = NODE_CPUS
+    v.memory = NODE_MEMORY
+  end
+  
+  if NODE_ROLES.kind_of?(String)
+    NODE_ROLES = NODE_ROLES.split(" ", -1)
+  end
+  if NODE_BOXES.kind_of?(String)
+    NODE_BOXES = NODE_BOXES.split(" ", -1)
+  end
+
+  # Must iterate on the index, vagrant does not understand iterating 
+  # over the node roles themselves
+  NODE_ROLES.length.times do |i|
+    name = NODE_ROLES[i]
+    config.vm.define name do |node|
+      roles = name.split("-", -1)
+      role_num = roles.pop.to_i
+      provision(node.vm, roles, role_num, i)
+    end
+  end
+end

tests/e2e/externalip/external_test.go

+// This test verifies that two nodes, which can't connect using the local network, are
+// able to still connect using the node-external-ip. In real life, node-external-ip
+// would be a public IP. In the test, we create two networks, one sets the node
+// internal-ip and the other sets the node-external-ip. Traffic is blocked on the former
+
+package externalip
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"strings"
+	"testing"
+
+	"github.com/k3s-io/k3s/tests/e2e"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+// Valid nodeOS: generic/ubuntu2004, opensuse/Leap-15.3.x86_64
+var nodeOS = flag.String("nodeOS", "generic/ubuntu2004", "VM operating system")
+var serverCount = flag.Int("serverCount", 1, "number of server nodes")
+var agentCount = flag.Int("agentCount", 1, "number of agent nodes")
+var hardened = flag.Bool("hardened", false, "true or false")
+
+// getLBServiceIPs returns the externalIP configured for flannel
+func getExternalIPs(kubeConfigFile string) ([]string, error) {
+	cmd := `kubectl get nodes -o jsonpath='{range .items[*]}{.metadata.annotations.flannel\.alpha\.coreos\.com/public-ip-overwrite}'  --kubeconfig=` + kubeConfigFile
+	res, err := e2e.RunCommand(cmd)
+	if err != nil {
+		return nil, err
+	}
+	return strings.Split(res, " "), nil
+}
+
+// getLBServiceIPs returns the LoadBalance service IPs
+func getLBServiceIPs(kubeConfigFile string) ([]e2e.ObjIP, error) {
+	cmd := `kubectl get svc -l k8s-app=nginx-app-loadbalancer -o=jsonpath='{range .items[*]}{.metadata.name}{" "}{.status.loadBalancer.ingress[*].ip}{"\n"}{end}' --kubeconfig=` + kubeConfigFile
+	return e2e.GetObjIPs(cmd)
+}
+
+// getClientIPs returns the IPs of the client pods
+func getClientIPs(kubeConfigFile string) ([]e2e.ObjIP, error) {
+	cmd := `kubectl get pods -l app=client -o=jsonpath='{range .items[*]}{.metadata.name}{" "}{.status.podIPs[*].ip}{"\n"}{end}' --kubeconfig=` + kubeConfigFile
+	return e2e.GetObjIPs(cmd)
+}
+
+func Test_E2EExternalIP(t *testing.T) {
+	flag.Parse()
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Validate External-IP config Suite")
+}
+
+var (
+	kubeConfigFile  string
+	serverNodeNames []string
+	agentNodeNames  []string
+)
+
+var _ = Describe("Verify External-IP config", Ordered, func() {
+
+	It("Starts up with no issues", func() {
+		var err error
+		serverNodeNames, agentNodeNames, err = e2e.CreateCluster(*nodeOS, *serverCount, *agentCount)
+		Expect(err).NotTo(HaveOccurred(), e2e.GetVagrantLog(err))
+		fmt.Println("CLUSTER CONFIG")
+		fmt.Println("OS:", *nodeOS)
+		fmt.Println("Server Nodes:", serverNodeNames)
+		fmt.Println("Agent Nodes:", agentNodeNames)
+		kubeConfigFile, err = e2e.GenKubeConfigFile(serverNodeNames[0])
+		Expect(err).NotTo(HaveOccurred())
+	})
+
+	It("Checks Node Status", func() {
+		Eventually(func(g Gomega) {
+			nodes, err := e2e.ParseNodes(kubeConfigFile, false)
+			g.Expect(err).NotTo(HaveOccurred())
+			for _, node := range nodes {
+				g.Expect(node.Status).Should(Equal("Ready"))
+			}
+		}, "420s", "5s").Should(Succeed())
+		_, err := e2e.ParseNodes(kubeConfigFile, true)
+		Expect(err).NotTo(HaveOccurred())
+	})
+
+	It("Checks Pod Status", func() {
+		Eventually(func(g Gomega) {
+			pods, err := e2e.ParsePods(kubeConfigFile, false)
+			g.Expect(err).NotTo(HaveOccurred())
+			for _, pod := range pods {
+				if strings.Contains(pod.Name, "helm-install") {
+					g.Expect(pod.Status).Should(Equal("Completed"), pod.Name)
+				} else {
+					g.Expect(pod.Status).Should(Equal("Running"), pod.Name)
+				}
+			}
+		}, "420s", "5s").Should(Succeed())
+		_, err := e2e.ParsePods(kubeConfigFile, true)
+		Expect(err).NotTo(HaveOccurred())
+	})
+
+	It("Verifies that each node has vagrant IP", func() {
+		nodeIPs, err := e2e.GetNodeIPs(kubeConfigFile)
+		Expect(err).NotTo(HaveOccurred())
+		for _, node := range nodeIPs {
+			Expect(node.IPv4).Should(ContainSubstring("10.10."))
+		}
+	})
+	It("Verifies that each pod has vagrant IP or clusterCIDR IP", func() {
+		podIPs, err := e2e.GetPodIPs(kubeConfigFile)
+		Expect(err).NotTo(HaveOccurred())
+		for _, pod := range podIPs {
+			Expect(pod.IPv4).Should(Or(ContainSubstring("10.10."), ContainSubstring("10.42.")), pod.Name)
+		}
+	})
+	It("Verifies that flannel added the correct annotation for the external-ip", func() {
+		nodeIPs, err := getExternalIPs(kubeConfigFile)
+		Expect(err).NotTo(HaveOccurred())
+		for _, annotation := range nodeIPs {
+			Expect(annotation).Should(ContainSubstring("10.100.100."))
+		}
+	})
+	It("Verifies internode connectivity over the tunnel", func() {
+		_, err := e2e.DeployWorkload("pod_client.yaml", kubeConfigFile, *hardened)
+		Expect(err).NotTo(HaveOccurred())
+
+		// Wait for the pod_client to have an IP
+		Eventually(func() string {
+			ips, _ := getClientIPs(kubeConfigFile)
+			return ips[0].IPv4
+		}, "40s", "5s").Should(ContainSubstring("10.42"), "failed getClientIPs")
+
+		clientIPs, err := getClientIPs(kubeConfigFile)
+		Expect(err).NotTo(HaveOccurred())
+		for _, ip := range clientIPs {
+			cmd := "kubectl exec svc/client-curl --kubeconfig=" + kubeConfigFile + " -- curl -m7 " + ip.IPv4 + "/name.html"
+			Eventually(func() (string, error) {
+				return e2e.RunCommand(cmd)
+			}, "20s", "3s").Should(ContainSubstring("client-deployment"), "failed cmd: "+cmd)
+		}
+	})
+	It("Verifies loadBalancer service's IP is the node-external-ip", func() {
+		_, err := e2e.DeployWorkload("loadbalancer.yaml", kubeConfigFile, *hardened)
+		Expect(err).NotTo(HaveOccurred())
+		cmd := "kubectl --kubeconfig=" + kubeConfigFile + " get svc -l k8s-app=nginx-app-loadbalancer -o=jsonpath='{range .items[*]}{.metadata.name}{.status.loadBalancer.ingress[*].ip}{end}'"
+		Eventually(func() (string, error) {
+			return e2e.RunCommand(cmd)
+		}, "20s", "3s").Should(ContainSubstring("10.100.100"), "failed cmd: "+cmd)
+	})
+})
+
+var failed bool
+var _ = AfterEach(func() {
+	failed = failed || CurrentSpecReport().Failed()
+})
+
+var _ = AfterSuite(func() {
+	if failed {
+		fmt.Println("FAILED!")
+	} else {
+		Expect(e2e.DestroyCluster()).To(Succeed())
+		Expect(os.Remove(kubeConfigFile)).To(Succeed())
+	}
+})

tests/e2e/testutils.go

@@ -39,6 +39,12 @@ type NodeError struct {
 	Err  error
 }
 
+type ObjIP struct {
+	Name string
+	IPv4 string
+	IPv6 string
+}
+
 func (ne *NodeError) Error() string {
 	return fmt.Sprintf("failed creating cluster: %s: %v", ne.Cmd, ne.Err)
 }
@@ -403,3 +409,39 @@ func UpgradeCluster(serverNodeNames []string, agentNodeNames []string) error {
 	}
 	return nil
 }
+
+// getPodIPs returns the IPs of all pods
+func GetPodIPs(kubeConfigFile string) ([]ObjIP, error) {
+	cmd := `kubectl get pods -A -o=jsonpath='{range .items[*]}{.metadata.name}{" "}{.status.podIPs[*].ip}{"\n"}{end}' --kubeconfig=` + kubeConfigFile
+	return GetObjIPs(cmd)
+}
+
+// getNodeIPs returns the IPs of all nodes
+func GetNodeIPs(kubeConfigFile string) ([]ObjIP, error) {
+	cmd := `kubectl get nodes -o jsonpath='{range .items[*]}{.metadata.name}{" "}{.status.addresses[?(@.type == "InternalIP")].address}{"\n"}{end}' --kubeconfig=` + kubeConfigFile
+	return GetObjIPs(cmd)
+}
+
+// getObjIPs executes a command to collect IPs
+func GetObjIPs(cmd string) ([]ObjIP, error) {
+	var objIPs []ObjIP
+	res, err := RunCommand(cmd)
+	if err != nil {
+		return nil, err
+	}
+	objs := strings.Split(res, "\n")
+	objs = objs[:len(objs)-1]
+
+	for _, obj := range objs {
+		fields := strings.Fields(obj)
+		if len(fields) > 2 {
+			objIPs = append(objIPs, ObjIP{Name: fields[0], IPv4: fields[1], IPv6: fields[2]})
+		} else if len(fields) > 1 {
+			objIPs = append(objIPs, ObjIP{Name: fields[0], IPv4: fields[1]})
+		} else {
+			objIPs = append(objIPs, ObjIP{Name: fields[0]})
+		}
+	}
+
+	return objIPs, nil
+}