Ipv6 (#257)

* Support for IPv6 endpoints.

Co-authored-by: Jay Patel <[email protected]>
Co-authored-by: jaywasd <[email protected]>

Author: 3 people

Makefile

@@ -71,6 +71,12 @@ test: manifests generate generate-mocks fmt vet goimports lint ## Run tests
 	go test ./... -coverprofile=cover.out -covermode=atomic
 
 kind-integration-suite: ## Provision and run integration tests with cleanup
+	export ADDRESS_TYPE="IPv4" && \
+	make kind-integration-setup && \
+	make kind-integration-run && \
+	make kind-integration-cleanup
+
+	export ADDRESS_TYPE="IPv6" && \
 	make kind-integration-setup && \
 	make kind-integration-run && \
 	make kind-integration-cleanup

integration/kind-test/configs/ipv6.yaml

@@ -0,0 +1,5 @@
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+networking:
+  ipFamily: ipv6
+  apiServerAddress: 127.0.0.1

integration/kind-test/scripts/dns-test.sh

@@ -1,5 +1,10 @@
 #!/usr/bin/env bash
 
+# If the IP Type env var is not set, default it to IPv4
+if [[ -z "${ADDRESS_TYPE}" ]]; then
+  ADDRESS_TYPE="IPv4"
+fi
+
 # Helper function to verify DNS results
 checkDNS() {
     dns_addresses_count=$(echo "$1" | wc -l | xargs)
@@ -31,10 +36,20 @@ $KUBECTL_BIN wait --for=condition=ready pod/dnsutils # wait until pod is deploye
 
 # Perform a dig to cluster-local CoreDNS
 # TODO: parse dig outputs for more precise verification - check specifics IPs?
-echo "performing dig for A/AAAA records..."
-addresses=$($KUBECTL_BIN exec dnsutils -- dig +all +ans $SERVICE.$NAMESPACE.svc.clusterset.local +short)
-exit_code=$?
-echo "$addresses"
+if [[ $ADDRESS_TYPE == "IPv4" ]]; then
+    echo "performing dig for A records for IPv4..."
+    addresses=$($KUBECTL_BIN exec dnsutils -- dig +all +ans $SERVICE.$NAMESPACE.svc.clusterset.local +short)
+    exit_code=$?
+    echo "$addresses"
+elif [[ $ADDRESS_TYPE == "IPv6" ]]; then
+    echo "performing dig for AAAA records for IPv6..."
+    addresses=$($KUBECTL_BIN exec dnsutils -- dig AAAA +all +ans $SERVICE.$NAMESPACE.svc.clusterset.local +short)
+    exit_code=$?
+    echo "$addresses"
+else
+    echo "ADDRESS_TYPE invalid"
+    exit 1
+fi
 
 if [ "$exit_code" -ne 0 ]; then
     echo "ERROR: Unable to dig service $SERVICE.$NAMESPACE.svc.clusterset.local"

integration/kind-test/scripts/run-helper.sh

@@ -7,8 +7,13 @@ source ./integration/kind-test/scripts/common.sh
 # create test namespace
 $KUBECTL_BIN create namespace "$NAMESPACE"
 
+# If the IP Type env var is not set, default it to IPV4
+if [[ -z "${ADDRESS_TYPE}" ]]; then
+  ADDRESS_TYPE="IPv4"
+fi
+
 # ClusterIP service test
-./integration/kind-test/scripts/run-tests.sh "$CLUSTERIP_SERVICE" "ClusterSetIP"
+./integration/kind-test/scripts/run-tests.sh "$CLUSTERIP_SERVICE" "ClusterSetIP" $ADDRESS_TYPE
 exit_code=$?
 if [ "$exit_code" -ne 0 ] ; then
     echo "ERROR: Testing $CLUSTERIP_SERVICE failed"
@@ -18,7 +23,7 @@ fi
 sleep 5
 
 # Headless service test
-./integration/kind-test/scripts/run-tests.sh "$HEADLESS_SERVICE" "Headless"
+./integration/kind-test/scripts/run-tests.sh "$HEADLESS_SERVICE" "Headless" $ADDRESS_TYPE
 exit_code=$?
 if [ "$exit_code" -ne 0 ] ; then
     echo "ERROR: Testing $HEADLESS_SERVICE failed"

integration/kind-test/scripts/run-tests.sh

@@ -5,6 +5,7 @@
 source ./integration/kind-test/scripts/common.sh
 export SERVICE=$1
 export SERVICE_TYPE=$2
+export IP_TYPE=$3
 
 # Deploy pods
 $KUBECTL_BIN apply -f "$KIND_CONFIGS/e2e-deployment.yaml"
@@ -24,7 +25,7 @@ mkdir -p "$LOGS"
 CTL_PID=$!
 echo "controller PID:$CTL_PID"
 
-go run $SCENARIOS/runner/main.go $NAMESPACE $SERVICE $CLUSTERID1 $CLUSTERSETID1 $ENDPT_PORT $SERVICE_PORT $SERVICE_TYPE "$endpts"
+go run $SCENARIOS/runner/main.go $NAMESPACE $SERVICE $CLUSTERID1 $CLUSTERSETID1 $ENDPT_PORT $SERVICE_PORT $SERVICE_TYPE $IP_TYPE "$endpts"
 exit_code=$?
 
 if [ "$exit_code" -eq 0 ] ; then
@@ -58,7 +59,7 @@ if [ "$exit_code" -eq 0 ] ; then
 fi
 
 if [ "$exit_code" -eq 0 ] ; then
-  go run $SCENARIOS/runner/main.go $NAMESPACE $SERVICE $CLUSTERID1 $CLUSTERSETID1 $ENDPT_PORT $SERVICE_PORT $SERVICE_TYPE "$updated_endpoints"
+  go run $SCENARIOS/runner/main.go $NAMESPACE $SERVICE $CLUSTERID1 $CLUSTERSETID1 $ENDPT_PORT $SERVICE_PORT $SERVICE_TYPE $IP_TYPE "$updated_endpoints"
   exit_code=$?
 fi
 

integration/kind-test/scripts/setup-kind.sh

@@ -9,7 +9,20 @@ source ./integration/kind-test/scripts/common.sh
 
 ./integration/kind-test/scripts/ensure-jq.sh
 
-$KIND_BIN create cluster --name "$KIND_SHORT" --image "$IMAGE"
+# If the IP Type env var is not set, default it to IPv4
+if [[ -z "${ADDRESS_TYPE}" ]]; then
+  ADDRESS_TYPE="IPv4"
+fi
+
+echo "ADDRESS_TYPE: $ADDRESS_TYPE"
+if [[ $ADDRESS_TYPE == "IPv4" ]]; then
+  $KIND_BIN create cluster --name "$KIND_SHORT" --image "$IMAGE"
+elif [[ $ADDRESS_TYPE == "IPv6" ]]; then
+  $KIND_BIN create cluster --name "$KIND_SHORT" --image "$IMAGE" --config=./integration/kind-test/configs/ipv6.yaml
+else
+  echo "ADDRESS_TYPE invalid"
+fi
+
 $KUBECTL_BIN config use-context "$CLUSTER"
 make install
 

integration/shared/scenarios/export_service.go

@@ -33,7 +33,7 @@ type exportServiceScenario struct {
 	expectedSvc model.Service
 }
 
-func NewExportServiceScenario(cfg *aws.Config, nsName string, svcName string, clusterId string, clusterSetId string, portStr string, servicePortStr string, serviceType string, ips string) (ExportServiceScenario, error) {
+func NewExportServiceScenario(cfg *aws.Config, nsName string, svcName string, clusterId string, clusterSetId string, portStr string, servicePortStr string, serviceType string, addressTypeStr string, ips string) (ExportServiceScenario, error) {
 	endpts := make([]*model.Endpoint, 0)
 
 	port, parseError := strconv.ParseUint(portStr, 10, 16)
@@ -44,15 +44,20 @@ func NewExportServiceScenario(cfg *aws.Config, nsName string, svcName string, cl
 	if parseError != nil {
 		return nil, parseError
 	}
+	addressType, parseError := model.GetAddressTypeFromString(addressTypeStr)
+	if parseError != nil {
+		return nil, parseError
+	}
 
 	for _, ip := range strings.Split(ips, ",") {
 		endpointPort := model.Port{
 			Port:     int32(port),
 			Protocol: string(v1.ProtocolTCP),
 		}
 		endpts = append(endpts, &model.Endpoint{
-			Id: model.EndpointIdFromIPAddressAndPort(ip, endpointPort),
-			IP: ip,
+			Id:          model.EndpointIdFromIPAddressAndPort(ip, endpointPort),
+			IP:          ip,
+			AddressType: addressType,
 			ServicePort: model.Port{
 				Port:       int32(servicePort),
 				TargetPort: portStr,

integration/shared/scenarios/runner/main.go

@@ -11,8 +11,8 @@ import (
 )
 
 func main() {
-	if len(os.Args) != 9 {
-		fmt.Println("Expected namespace, service, clusterId, clusterSetId, endpoint port, service port, serviceType, and endpoint IP list as arguments")
+	if len(os.Args) != 10 {
+		fmt.Println("Expected namespace, service, clusterId, clusterSetId, endpoint port, service port, serviceType, endpoint AddressType, and endpoint IP list as arguments")
 		os.Exit(1)
 	}
 
@@ -23,15 +23,16 @@ func main() {
 	port := os.Args[5]
 	servicePort := os.Args[6]
 	serviceType := os.Args[7]
-	ips := os.Args[8]
+	addressType := os.Args[8]
+	ips := os.Args[9]
 
-	testServiceExport(nsName, svcName, clusterId, clusterSetId, port, servicePort, serviceType, ips)
+	testServiceExport(nsName, svcName, clusterId, clusterSetId, port, servicePort, serviceType, addressType, ips)
 }
 
-func testServiceExport(nsName string, svcName string, clusterId string, clusterSetId string, port string, servicePort string, serviceType string, ips string) {
+func testServiceExport(nsName string, svcName string, clusterId string, clusterSetId string, port string, servicePort string, serviceType string, addressType string, ips string) {
 	fmt.Printf("Testing service export integration for namespace %s and service %s\n", nsName, svcName)
 
-	export, err := scenarios.NewExportServiceScenario(getAwsConfig(), nsName, svcName, clusterId, clusterSetId, port, servicePort, serviceType, ips)
+	export, err := scenarios.NewExportServiceScenario(getAwsConfig(), nsName, svcName, clusterId, clusterSetId, port, servicePort, serviceType, addressType, ips)
 	if err != nil {
 		fmt.Printf("Failed to setup service export integration test scenario: %s", err.Error())
 		os.Exit(1)

pkg/controllers/multicluster/controllers_common_test.go

@@ -96,7 +96,7 @@ func endpointSliceForTest() *discovery.EndpointSlice {
 
 func endpointSliceFromEndpointsForTest(endpts []*model.Endpoint, ports []discovery.EndpointPort) *discovery.EndpointSlice {
 	svc := k8sServiceForTest()
-	slice := CreateEndpointSliceStruct(svc, test.SvcName, test.ClusterId1)
+	slice := CreateEndpointSliceStruct(svc, test.SvcName, test.ClusterId1, endpts[0].AddressType)
 	slice.Ports = ports
 
 	testEndpoints := make([]discovery.Endpoint, 0)

pkg/controllers/multicluster/endpointslice_plan.go

@@ -39,6 +39,15 @@ type EndpointSlicePlan struct {
 	ClusterId string
 }
 
+// CheckAddressType TODO: Will need to improve how IP Type is determined when we implement dual stack.
+func (p *EndpointSlicePlan) CheckAddressType() discovery.AddressType {
+	// Peek at the first endpoint for its AddressType. All endpoints in a slice will be of the same AddressType.
+	if len(p.Desired) == 0 {
+		return discovery.AddressTypeIPv4
+	}
+	return p.Desired[0].AddressType
+}
+
 // CalculateChanges returns list of EndpointSlice Changes that need to applied
 func (p *EndpointSlicePlan) CalculateChanges() EndpointSliceChanges {
 	// populate map of desired endpoints for lookup efficiency
@@ -147,7 +156,7 @@ func (p *EndpointSlicePlan) getOrCreateUnfilledEndpointSlice(changes *EndpointSl
 	}
 
 	// No existing slices can fill new endpoint requirements so create a new slice
-	sliceToCreate := CreateEndpointSliceStruct(p.Service, p.ServiceImportName, p.ClusterId)
+	sliceToCreate := CreateEndpointSliceStruct(p.Service, p.ServiceImportName, p.ClusterId, p.CheckAddressType())
 	changes.Create = append(changes.Create, sliceToCreate)
 	return sliceToCreate, true
 }