fix: unset service externalTrafficPolicy in examples (#188)

When using ClusterIP services, such as for Ingress objects, the
LoadBalancer-specific externalTrafficPolicy setting must not be
set, so explicitly unset it for those examples.

Author: Jonathan Yu

examples/ingress/ingress.values.yaml

@@ -3,6 +3,7 @@ coderd:
   serviceSpec:
     # The Ingress will route traffic to the internal ClusterIP.
     type: ClusterIP
+    externalTrafficPolicy: ""
 
 ingress:
   enable: true

examples/kind/kind.values.yaml

@@ -3,6 +3,7 @@ coderd:
   serviceSpec:
     # Avoid provisioning a LoadBalancer
     type: ClusterIP
+    externalTrafficPolicy: ""
 
   # Reduce resource requirements for deployments using kind, which
   # we typically use for development and test purposes only.

examples/openshift/openshift.values.yaml

@@ -3,6 +3,7 @@ coderd:
 
   serviceSpec:
     type: ClusterIP
+    externalTrafficPolicy: ""
 
   # OpenShift's default "restricted" Security Context Constraint
   # requires that these be unset. OpenShift manages the runAsUser

tests/examples_test.go

@@ -18,6 +18,9 @@ func TestExamples(t *testing.T) {
 
 	chart := LoadChart(t)
 
+	exampleIngress, err := ReadValuesFileAsMap("../examples/ingress/ingress.values.yaml")
+	require.NoError(t, err, "failed to load ingress example values")
+
 	exampleOpenShift, err := ReadValuesFileAsMap("../examples/openshift/openshift.values.yaml")
 	require.NoError(t, err, "failed to load OpenShift example values")
 
@@ -29,11 +32,16 @@ func TestExamples(t *testing.T) {
 		Values                   map[string]interface{}
 		PodSecurityContext       *corev1.PodSecurityContext
 		ContainerSecurityContext *corev1.SecurityContext
-		Postgres                 *PostgresValues
+		ServiceType              corev1.ServiceType
 	}{
 		{
-			Name:   "default",
-			Values: nil,
+			Name:        "default",
+			Values:      nil,
+			ServiceType: corev1.ServiceTypeLoadBalancer,
+		}, {
+			Name:        "ingress",
+			Values:      exampleIngress,
+			ServiceType: corev1.ServiceTypeClusterIP,
 		}, {
 			Name:   "openshift",
 			Values: exampleOpenShift,
@@ -56,6 +64,7 @@ func TestExamples(t *testing.T) {
 				ProcMount:                nil,
 				SeccompProfile:           nil,
 			},
+			ServiceType: corev1.ServiceTypeClusterIP,
 		},
 		{
 			Name:   "kind",
@@ -84,6 +93,7 @@ func TestExamples(t *testing.T) {
 					LocalhostProfile: nil,
 				},
 			},
+			ServiceType: corev1.ServiceTypeClusterIP,
 		},
 	}
 
@@ -143,6 +153,18 @@ func TestExamples(t *testing.T) {
 			assert.Equal(t, test.ContainerSecurityContext, coderd.Spec.Template.Spec.Containers[0].SecurityContext,
 				"expected matching container securityContext",
 			)
+
+			service := MustFindService(t, objs, "coderd")
+			assert.Equal(t, test.ServiceType, service.Spec.Type, "service type should match")
+			switch test.ServiceType {
+			case corev1.ServiceTypeLoadBalancer:
+				assert.Empty(t, service.Spec.ExternalName, "external name should not be set")
+			case corev1.ServiceTypeClusterIP:
+				assert.Empty(t, service.Spec.ExternalName, "external name should not be set")
+				assert.Nil(t, service.Spec.LoadBalancerClass, "loadBalancerClass should not be set")
+				assert.Empty(t, service.Spec.LoadBalancerSourceRanges, "loadBalancerSourceRanges should not be set")
+				assert.Empty(t, service.Spec.ExternalTrafficPolicy, "externalTrafficPolicy should not be set")
+			}
 		})
 	}
 }

tests/utils.go

@@ -8,6 +8,23 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
+// MustFindService finds a service in the given slice of objects with the
+// given name, or fails the test.
+func MustFindService(t testing.TB, objs []runtime.Object, name string) *corev1.Service {
+	names := []string{}
+	for _, obj := range objs {
+		if service, ok := obj.(*corev1.Service); ok {
+			if service.Name == name {
+				return service
+			}
+			names = append(names, service.Name)
+		}
+	}
+
+	t.Fatalf("failed to find service %q, found %v", name, names)
+	return nil
+}
+
 // MustFindDeployment finds a deployment in the given slice of objects with the
 // given name, or fails the test.
 func MustFindDeployment(t testing.TB, objs []runtime.Object, name string) *appsv1.Deployment {