[helm nats 1.x] add appProtocol to services (#762)

Signed-off-by: Caleb Lloyd <caleb@synadia.com>
nats-io · Aug 1, 2023 · 40e5fec · 40e5fec
1 parent f010926
commit 40e5fec
Show file tree

Hide file tree

Showing 6 changed files with 264 additions and 185 deletions.
diff --git a/helm/charts/nats/files/headless-service.yaml b/helm/charts/nats/files/headless-service.yaml
@@ -14,6 +14,13 @@ spec:
   {{- range $protocol := list "nats" "leafnodes" "websocket" "mqtt" "cluster" "gateway" "monitor" "profiling" }}
   {{- $configProtocol := get $.Values.config $protocol }}
   {{- if or (eq $protocol "nats") $configProtocol.enabled }}
-  - {{ dict "name" $protocol "port" $configProtocol.port "targetPort" $protocol | toYaml | nindent 4 }}
+  {{- $tlsEnabled := false }}
+  {{- if hasKey $configProtocol "tls" }}
+    {{- $tlsEnabled = $configProtocol.tls.enabled }}
+  {{- else if eq $protocol "monitor" }}
+    {{- $tlsEnabled = $.Values.config.nats.tls.enabled }}
+  {{- end }}
+  {{- $appProtocol := or (eq $protocol "websocket") (eq $protocol "monitor") | ternary ($tlsEnabled | ternary "https" "http") ($tlsEnabled | ternary "tls" "tcp") }}
+  - {{ dict "name" $protocol "port" $configProtocol.port "targetPort" $protocol "appProtocol" $appProtocol | toYaml | nindent 4 }}
   {{- end }}
   {{- end }}
diff --git a/helm/charts/nats/files/service.yaml b/helm/charts/nats/files/service.yaml
@@ -13,6 +13,13 @@ spec:
   {{- $configProtocol := get $.Values.config $protocol }}
   {{- $servicePort := get $.Values.service.ports $protocol }}
   {{- if and (or (eq $protocol "nats") $configProtocol.enabled) $servicePort.enabled }}
-  - {{ merge (dict "name" $protocol "targetPort" $protocol) (omit $servicePort "enabled") (dict "port" $configProtocol.port) | toYaml | nindent 4 }}
+  {{- $tlsEnabled := false }}
+  {{- if hasKey $configProtocol "tls" }}
+    {{- $tlsEnabled = $configProtocol.tls.enabled }}
+  {{- else if eq $protocol "monitor" }}
+    {{- $tlsEnabled = $.Values.config.nats.tls.enabled }}
+  {{- end }}
+  {{- $appProtocol := or (eq $protocol "websocket") (eq $protocol "monitor") | ternary ($tlsEnabled | ternary "https" "http") ($tlsEnabled | ternary "tls" "tcp") }}
+  - {{ merge (dict "name" $protocol "targetPort" $protocol "appProtocol" $appProtocol) (omit $servicePort "enabled") (dict "port" $configProtocol.port) | toYaml | nindent 4 }}
   {{- end }}
   {{- end }}
diff --git a/helm/charts/nats/test/config_test.go b/helm/charts/nats/test/config_test.go
@@ -106,19 +106,22 @@ config:
 
 	expected.HeadlessService.Value.Spec.Ports = []corev1.ServicePort{
 		{
-			Name:       "nats",
-			Port:       4222,
-			TargetPort: intstr.FromString("nats"),
+			Name:        "nats",
+			Port:        4222,
+			TargetPort:  intstr.FromString("nats"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "cluster",
-			Port:       6222,
-			TargetPort: intstr.FromString("cluster"),
+			Name:        "cluster",
+			Port:        6222,
+			TargetPort:  intstr.FromString("cluster"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "monitor",
-			Port:       8222,
-			TargetPort: intstr.FromString("monitor"),
+			Name:        "monitor",
+			Port:        8222,
+			TargetPort:  intstr.FromString("monitor"),
+			AppProtocol: &appProtocolHTTP,
 		},
 	}
 
@@ -249,19 +252,22 @@ config:
 
 	expected.HeadlessService.Value.Spec.Ports = []corev1.ServicePort{
 		{
-			Name:       "nats",
-			Port:       4222,
-			TargetPort: intstr.FromString("nats"),
+			Name:        "nats",
+			Port:        4222,
+			TargetPort:  intstr.FromString("nats"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "cluster",
-			Port:       6222,
-			TargetPort: intstr.FromString("cluster"),
+			Name:        "cluster",
+			Port:        6222,
+			TargetPort:  intstr.FromString("cluster"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "monitor",
-			Port:       8222,
-			TargetPort: intstr.FromString("monitor"),
+			Name:        "monitor",
+			Port:        8222,
+			TargetPort:  intstr.FromString("monitor"),
+			AppProtocol: &appProtocolHTTP,
 		},
 	}
 
@@ -463,62 +469,73 @@ config:
 
 	expected.HeadlessService.Value.Spec.Ports = []corev1.ServicePort{
 		{
-			Name:       "nats",
-			Port:       4222,
-			TargetPort: intstr.FromString("nats"),
+			Name:        "nats",
+			Port:        4222,
+			TargetPort:  intstr.FromString("nats"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "leafnodes",
-			Port:       7422,
-			TargetPort: intstr.FromString("leafnodes"),
+			Name:        "leafnodes",
+			Port:        7422,
+			TargetPort:  intstr.FromString("leafnodes"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "websocket",
-			Port:       8080,
-			TargetPort: intstr.FromString("websocket"),
+			Name:        "websocket",
+			Port:        8080,
+			TargetPort:  intstr.FromString("websocket"),
+			AppProtocol: &appProtocolHTTP,
 		},
 		{
-			Name:       "mqtt",
-			Port:       1883,
-			TargetPort: intstr.FromString("mqtt"),
+			Name:        "mqtt",
+			Port:        1883,
+			TargetPort:  intstr.FromString("mqtt"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "cluster",
-			Port:       6222,
-			TargetPort: intstr.FromString("cluster"),
+			Name:        "cluster",
+			Port:        6222,
+			TargetPort:  intstr.FromString("cluster"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "gateway",
-			Port:       7222,
-			TargetPort: intstr.FromString("gateway"),
+			Name:        "gateway",
+			Port:        7222,
+			TargetPort:  intstr.FromString("gateway"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "monitor",
-			Port:       8222,
-			TargetPort: intstr.FromString("monitor"),
+			Name:        "monitor",
+			Port:        8222,
+			TargetPort:  intstr.FromString("monitor"),
+			AppProtocol: &appProtocolHTTP,
 		},
 	}
 
 	expected.Service.Value.Spec.Ports = []corev1.ServicePort{
 		{
-			Name:       "nats",
-			Port:       4222,
-			TargetPort: intstr.FromString("nats"),
+			Name:        "nats",
+			Port:        4222,
+			TargetPort:  intstr.FromString("nats"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "leafnodes",
-			Port:       7422,
-			TargetPort: intstr.FromString("leafnodes"),
+			Name:        "leafnodes",
+			Port:        7422,
+			TargetPort:  intstr.FromString("leafnodes"),
+			AppProtocol: &appProtocolTCP,
 		},
 		{
-			Name:       "websocket",
-			Port:       8080,
-			TargetPort: intstr.FromString("websocket"),
+			Name:        "websocket",
+			Port:        8080,
+			TargetPort:  intstr.FromString("websocket"),
+			AppProtocol: &appProtocolHTTP,
 		},
 		{
-			Name:       "mqtt",
-			Port:       1883,
-			TargetPort: intstr.FromString("mqtt"),
+			Name:        "mqtt",
+			Port:        1883,
+			TargetPort:  intstr.FromString("mqtt"),
+			AppProtocol: &appProtocolTCP,
 		},
 	}
 
@@ -679,62 +696,73 @@ config:
 
 	expected.HeadlessService.Value.Spec.Ports = []corev1.ServicePort{
 		{
-			Name:       "nats",
-			Port:       4222,
-			TargetPort: intstr.FromString("nats"),
+			Name:        "nats",
+			Port:        4222,
+			TargetPort:  intstr.FromString("nats"),
+			AppProtocol: &appProtocolTLS,
 		},
 		{
-			Name:       "leafnodes",
-			Port:       7422,
-			TargetPort: intstr.FromString("leafnodes"),
+			Name:        "leafnodes",
+			Port:        7422,
+			TargetPort:  intstr.FromString("leafnodes"),
+			AppProtocol: &appProtocolTLS,
 		},
 		{
-			Name:       "websocket",
-			Port:       8080,
-			TargetPort: intstr.FromString("websocket"),
+			Name:        "websocket",
+			Port:        8080,
+			TargetPort:  intstr.FromString("websocket"),
+			AppProtocol: &appProtocolHTTPS,
 		},
 		{
-			Name:       "mqtt",
-			Port:       1883,
-			TargetPort: intstr.FromString("mqtt"),
+			Name:        "mqtt",
+			Port:        1883,
+			TargetPort:  intstr.FromString("mqtt"),
+			AppProtocol: &appProtocolTLS,
 		},
 		{
-			Name:       "cluster",
-			Port:       6222,
-			TargetPort: intstr.FromString("cluster"),
+			Name:        "cluster",
+			Port:        6222,
+			TargetPort:  intstr.FromString("cluster"),
+			AppProtocol: &appProtocolTLS,
 		},
 		{
-			Name:       "gateway",
-			Port:       7222,
-			TargetPort: intstr.FromString("gateway"),
+			Name:        "gateway",
+			Port:        7222,
+			TargetPort:  intstr.FromString("gateway"),
+			AppProtocol: &appProtocolTLS,
 		},
 		{
-			Name:       "monitor",
-			Port:       8222,
-			TargetPort: intstr.FromString("monitor"),
+			Name:        "monitor",
+			Port:        8222,
+			TargetPort:  intstr.FromString("monitor"),
+			AppProtocol: &appProtocolHTTPS,
 		},
 	}
 
 	expected.Service.Value.Spec.Ports = []corev1.ServicePort{
 		{
-			Name:       "nats",
-			Port:       4222,
-			TargetPort: intstr.FromString("nats"),
+			Name:        "nats",
+			Port:        4222,
+			TargetPort:  intstr.FromString("nats"),
+			AppProtocol: &appProtocolTLS,
 		},
 		{
-			Name:       "leafnodes",
-			Port:       7422,
-			TargetPort: intstr.FromString("leafnodes"),
+			Name:        "leafnodes",
+			Port:        7422,
+			TargetPort:  intstr.FromString("leafnodes"),
+			AppProtocol: &appProtocolTLS,
 		},
 		{
-			Name:       "websocket",
-			Port:       8080,
-			TargetPort: intstr.FromString("websocket"),
+			Name:        "websocket",
+			Port:        8080,
+			TargetPort:  intstr.FromString("websocket"),
+			AppProtocol: &appProtocolHTTPS,
 		},
 		{
-			Name:       "mqtt",
-			Port:       1883,
-			TargetPort: intstr.FromString("mqtt"),
+			Name:        "mqtt",
+			Port:        1883,
+			TargetPort:  intstr.FromString("mqtt"),
+			AppProtocol: &appProtocolTLS,
 		},
 	}
 
@@ -842,6 +870,7 @@ extraResources:
         - name: gateway
           port: 7222
           targetPort: gateway
+          appProtocol: tcp
 - $tplYaml: |
     apiVersion: v1
     kind: ConfigMap
@@ -863,9 +892,10 @@ extraResources:
 	expected.ExtraService.HasValue = true
 	expected.ExtraService.Value.Spec.Ports = []corev1.ServicePort{
 		{
-			Name:       "gateway",
-			Port:       7222,
-			TargetPort: intstr.FromString("gateway"),
+			Name:        "gateway",
+			Port:        7222,
+			TargetPort:  intstr.FromString("gateway"),
+			AppProtocol: &appProtocolTCP,
 		},
 	}
 

diff --git a/helm/charts/nats/test/defaults_test.go b/helm/charts/nats/test/defaults_test.go
@@ -29,7 +29,13 @@ type DynamicDefaultsGetter struct {
 	dd  DynamicDefaults
 }
 
-var ddg DynamicDefaultsGetter
+var (
+	ddg              DynamicDefaultsGetter
+	appProtocolTCP   = "tcp"
+	appProtocolTLS   = "tls"
+	appProtocolHTTP  = "http"
+	appProtocolHTTPS = "https"
+)
 
 func (d *DynamicDefaultsGetter) Get(t *testing.T) DynamicDefaults {
 	t.Helper()
@@ -159,14 +165,16 @@ func DefaultResources(t *testing.T, test *Test) *Resources {
 				Spec: corev1.ServiceSpec{
 					Ports: []corev1.ServicePort{
 						{
-							Name:       "nats",
-							Port:       4222,
-							TargetPort: intstr.FromString("nats"),
+							Name:        "nats",
+							Port:        4222,
+							TargetPort:  intstr.FromString("nats"),
+							AppProtocol: &appProtocolTCP,
 						},
 						{
-							Name:       "monitor",
-							Port:       8222,
-							TargetPort: intstr.FromString("monitor"),
+							Name:        "monitor",
+							Port:        8222,
+							TargetPort:  intstr.FromString("monitor"),
+							AppProtocol: &appProtocolHTTP,
 						},
 					},
 					Selector:                 natsSelectorLabels(),
@@ -392,9 +400,10 @@ exec sh -ec "$0"
 				Spec: corev1.ServiceSpec{
 					Ports: []corev1.ServicePort{
 						{
-							Name:       "nats",
-							Port:       4222,
-							TargetPort: intstr.FromString("nats"),
+							Name:        "nats",
+							Port:        4222,
+							TargetPort:  intstr.FromString("nats"),
+							AppProtocol: &appProtocolTCP,
 						},
 					},
 					Selector: natsSelectorLabels(),