customizable worker, fix worker and app labels

Signed-off-by: Pascal Sthamer <pascal+github@sthamer.xyz>

functions/kubernetes/charts/shuffle/templates/_helpers.tpl

@@ -27,7 +27,7 @@ Return the common name for worker components
 {{- end -}}
 
 {{/*
-Return the common name for app components
+Return the common name for app components.
 */}}
 {{- define "shuffle.app.name" -}}
   {{- printf "%s-app" (include "common.names.fullname" .) | trunc 63 -}}
@@ -60,31 +60,78 @@ app.kubernetes.io/component: orborus
 {{- end -}}
 
 {{/*
-Return the common labels for worker components deployed via helm
+Return the common labels for worker components deployed via helm.
+NOTE: Worker deployments and services use shuffle.workerInstance.labels instead.
 */}}
 {{- define "shuffle.worker.labels" -}}
+{{- include "common.labels.standard" . }}
+app.kubernetes.io/component: worker
+{{- end -}}
+
+
+{{/*
+Return the labels for a specific worker instance deployed via helm.
+Usage: 
+{{ include "shuffle.workerInstance.labels" (dict "customLabels" .Values.commonLabels "context" $) -}}
+*/}}
+{{- define "shuffle.workerInstance.labels" -}}
 app.kubernetes.io/name: shuffle-worker
-helm.sh/chart: {{ include "common.names.chart" . }}
-app.kubernetes.io/instance: {{ .Release.Name }}
-app.kubernetes.io/managed-by: {{ .Release.Service }}
+helm.sh/chart: {{ include "common.names.chart" .context }}
+app.kubernetes.io/instance: {{ .context.Release.Name }}
+app.kubernetes.io/managed-by: {{ .context.Release.Service }}
 app.kubernetes.io/part-of: shuffle
-{{- with .Chart.AppVersion }}
+{{- with .context.Chart.AppVersion }}
 app.kubernetes.io/version: {{ . | replace "+" "_" | quote }}
 {{- end -}}
+{{- range $key, $value := .customLabels }}
+{{ $key }}: {{ $value }}
+{{- end }}
 {{- end -}}
 
 {{/*
-Return the common labels for app components deployed via helm
+Return the common labels for app components deployed via helm.
+NOTE: App deployments and services use shuffle.appInstance.labels instead.
 */}}
 {{- define "shuffle.app.labels" -}}
-app.kubernetes.io/name: shuffle-app
-helm.sh/chart: {{ include "common.names.chart" . }}
-app.kubernetes.io/instance: {{ .Release.Name }}
-app.kubernetes.io/managed-by: {{ .Release.Service }}
-app.kubernetes.io/part-of: shuffle
-{{- with .Chart.AppVersion }}
-app.kubernetes.io/version: {{ . | replace "+" "_" | quote }}
+{{- include "common.labels.standard" . }}
+app.kubernetes.io/component: app
 {{- end -}}
+
+{{/*
+Return the sanitized name of a shuffle app.
+Usage:
+{{ include "shuffle.appInstance.name" $app }}
+*/}}
+{{- define "shuffle.appInstance.name -}}
+{{ .name | replace "_" | "-" | lower }}
+{{- end -}}
+
+{{/*
+Return the sanitized name of a shuffle app, including the version of the app.
+Usage:
+{{ include "shuffle.appInstance.fullname" $app }}
+*/}}
+{{- define "shuffle.appInstance.fullname -}}
+{{ printf "%s-%s" .name .version | replace "_" | "-" | lower }}
+{{- end -}}
+
+{{/*
+Return the labels for a shuffle app deployed by helm.
+Usage:
+{{ include "shuffle.appInstance.labels" (dict "app" $app "customLabels" .Values.commonLabels "context" $) }}
+*/}}
+{{- define "shuffle.appInstance.labels" -}}
+app.kubernetes.io/name: shuffle-app
+app.kubernetes.io/instance: {{ include "shuffle.appInstance.fullname" .app }}
+helm.sh/chart: {{ include "common.names.chart" .context }}
+app.kubernetes.io/instance: {{ .context.Release.Name }}
+app.kubernetes.io/managed-by: {{ .context.Release.Service }}
+app.kubernetes.io/part-of: shuffle
+app.shuffler.io/name: {{ include "shuffle.appInstance.name" .app }}
+app.shuffler.io/version: {{ .app.version | quote }}
+{{- range $key, $value := .customLabels }}
+{{ $key }}: {{ $value }}
+{{- end }}
 {{- end -}}
 
 {{/*
@@ -112,20 +159,20 @@ app.kubernetes.io/component: orborus
 {{- end -}}
 
 {{/*
-Return the match labels for worker components.
-These must match the labels of helm-deployed worker components (shuffle.worker.labels),
-as well as orborus-deployed worker components (deployk8sworker).
+Return the match labels for workers.
+These must match the labels of helm-deployed workers (shuffle.workerInstance.labels),
+as well as orborus-deployed workers (deployk8sworker).
 */}}
-{{- define "shuffle.worker.matchLabels" -}}
+{{- define "shuffle.workerInstance.matchLabels" -}}
 app.kubernetes.io/name: shuffle-worker
 {{- end -}}
 
 {{/*
-Return the match labels for app components.
-These must match the labels of helm-deployed app components (shuffle.app.labels),
-as well as worker-deployed app deployments (deployK8sApp).
+Return the match labels for apps.
+These must match the labels of helm-deployed apps (shuffle.appInstance.labels),
+as well as worker-deployed apps (deployK8sApp).
 */}}
-{{- define "shuffle.app.matchLabels" -}}
+{{- define "shuffle.appInstance.matchLabels" -}}
 app.kubernetes.io/name: shuffle-app
 {{- end -}}
 

functions/kubernetes/charts/shuffle/templates/backend/backend-network-policy.yaml

@@ -51,14 +51,14 @@ spec:
             matchLabels:
               kubernetes.io/metadata.name: {{ .Release.Namespace }}
           podSelector:
-            matchLabels: {{ include "shuffle.worker.matchLabels" . | nindent 14 }}
+            matchLabels: {{ include "shuffle.workerInstance.matchLabels" . | nindent 14 }}
 
         # Allow traffic from apps
         - namespaceSelector:
             matchLabels:
               kubernetes.io/metadata.name: {{ .Release.Namespace }}
           podSelector:
-            matchLabels: {{ include "shuffle.app.matchLabels" . | nindent 14 }}
+            matchLabels: {{ include "shuffle.appInstance.matchLabels" . | nindent 14 }}
       {{- end }}
     {{- if .Values.backend.networkPolicy.extraIngress }}
     {{- include "common.tplvalues.render" ( dict "value" .Values.backend.networkPolicy.extraIngress "context" $ ) | nindent 4 }}

functions/kubernetes/charts/shuffle/templates/orborus/orborus-network-policy.yaml

@@ -48,7 +48,7 @@ spec:
             matchLabels:
               kubernetes.io/metadata.name: {{ .Release.Namespace }}
           podSelector:
-            matchLabels: {{ include "shuffle.worker.matchLabels" . | nindent 14 }}
+            matchLabels: {{ include "shuffle.workerInstance.matchLabels" . | nindent 14 }}
     {{- if .Values.orborus.networkPolicy.extraEgress }}
     {{- include "common.tplvalues.render" ( dict "value" .Values.orborus.networkPolicy.extraEgress "context" $ ) | nindent 4 }}
     {{- end }}

functions/kubernetes/charts/shuffle/templates/shuffle-app/shuffle-app-network-policy.yaml

@@ -11,7 +11,7 @@ metadata:
 spec:
   {{- $podLabels := include "common.tplvalues.merge" ( dict "values" ( list .Values.app.podLabels .Values.commonLabels ) "context" . ) }}
   podSelector:
-    matchLabels: {{- include "shuffle.app.matchLabels" ( dict "customLabels" $podLabels "context" $ ) | nindent 6 }}
+    matchLabels: {{- include "shuffle.appInstance.matchLabels" ( dict "customLabels" $podLabels "context" $ ) | nindent 6 }}
   policyTypes:
     - Ingress
     - Egress
@@ -48,7 +48,7 @@ spec:
             matchLabels:
               kubernetes.io/metadata.name: {{ .Release.Namespace }}
           podSelector:
-            matchLabels: {{ include "shuffle.worker.matchLabels" . | nindent 14 }}
+            matchLabels: {{ include "shuffle.workerInstance.matchLabels" . | nindent 14 }}
     {{- if .Values.app.networkPolicy.extraEgress }}
     {{- include "common.tplvalues.render" ( dict "value" .Values.app.networkPolicy.extraEgress "context" $ ) | nindent 4 }}
     {{- end }}
@@ -64,7 +64,7 @@ spec:
             matchLabels:
               kubernetes.io/metadata.name: {{ .Release.Namespace }}
           podSelector:
-            matchLabels: {{ include "shuffle.worker.matchLabels" . | nindent 14 }}
+            matchLabels: {{ include "shuffle.workerInstance.matchLabels" . | nindent 14 }}
       {{- end }}
     {{- if .Values.app.networkPolicy.extraIngress }}
     {{- include "common.tplvalues.render" ( dict "value" .Values.app.networkPolicy.extraIngress "context" $ ) | nindent 4 }}

functions/kubernetes/charts/shuffle/templates/shuffle-worker/shuffle-worker-dpl.yaml

@@ -4,7 +4,7 @@ kind: Deployment
 metadata:
   name: {{ template "shuffle.worker.name" . }}
   namespace: {{ include "common.names.namespace" . | quote }}
-  labels: {{- include "shuffle.worker.labels" ( dict "customLabels" .Values.commonLabels "context" $ ) | nindent 4 }}
+  labels: {{- include "shuffle.workerInstance.labels" ( dict "customLabels" .Values.commonLabels "context" $ ) | nindent 4 }}
   {{- if or .Values.worker.deploymentAnnotations .Values.commonAnnotations }}
   {{- $annotations := include "common.tplvalues.merge" (dict "values" (list .Values.worker.deploymentAnnotations .Values.commonAnnotations) "context" .) }}
   annotations: {{- include "common.tplvalues.render" ( dict "value" $annotations "context" $ ) | nindent 4 }}
@@ -18,13 +18,13 @@ spec:
   {{- end }}
   {{- $podLabels := include "common.tplvalues.merge" (dict "values" (list .Values.worker.podLabels .Values.commonLabels) "context" .) }}
   selector:
-    matchLabels: {{- include "shuffle.worker.matchLabels" ( dict "customLabels" $podLabels "context" $ ) | nindent 6 }}
+    matchLabels: {{- include "shuffle.workerInstance.matchLabels" ( dict "customLabels" $podLabels "context" $ ) | nindent 6 }}
   template:
     metadata:
       {{- if .Values.worker.podAnnotations }}
       annotations: {{- include "common.tplvalues.render" (dict "value" .Values.worker.podAnnotations "context" $) | nindent 8 }}
       {{- end }}
-      labels: {{- include "shuffle.worker.labels" ( dict "customLabels" $podLabels "context" $ ) | nindent 8 }}
+      labels: {{- include "shuffle.workerInstance.labels" ( dict "customLabels" $podLabels "context" $ ) | nindent 8 }}
     spec:
       {{- include "shuffle.worker.imagePullSecrets" . | nindent 6 }}
       serviceAccountName: {{ template "shuffle.worker.serviceAccount.name" . }}
@@ -101,6 +101,7 @@ spec:
               value: {{ .Values.app.exposedContainerPort | quote }}
             - name: WORKER_HOSTNAME
               value: {{ include "shuffle.worker.name" }}.{{ .Release.Namespace }}.svc.cluster.local
+            # TODO: If manageAppDeployments is set, we need to add some variables!
             {{- if .Values.worker.extraEnvVars }}
             {{- include "common.tplvalues.render" (dict "value" .Values.worker.extraEnvVars "context" $) | nindent 12 }}
             {{- end }}

functions/kubernetes/charts/shuffle/templates/shuffle-worker/shuffle-worker-network-policy.yaml

@@ -11,7 +11,7 @@ metadata:
 spec:
   {{- $podLabels := include "common.tplvalues.merge" ( dict "values" ( list .Values.worker.podLabels .Values.commonLabels ) "context" . ) }}
   podSelector:
-    matchLabels: {{- include "shuffle.worker.matchLabels" ( dict "customLabels" $podLabels "context" $ ) | nindent 6 }}
+    matchLabels: {{- include "shuffle.workerInstance.matchLabels" ( dict "customLabels" $podLabels "context" $ ) | nindent 6 }}
   policyTypes:
     - Ingress
     - Egress
@@ -35,7 +35,7 @@ spec:
             matchLabels:
               kubernetes.io/metadata.name: {{ .Release.Namespace }}
           podSelector:
-            matchLabels: {{ include "shuffle.app.matchLabels" . | nindent 14 }}
+            matchLabels: {{ include "shuffle.appInstance.matchLabels" . | nindent 14 }}
     {{- if .Values.worker.networkPolicy.extraEgress }}
     {{- include "common.tplvalues.render" ( dict "value" .Values.worker.networkPolicy.extraEgress "context" $ ) | nindent 4 }}
     {{- end }}
@@ -57,7 +57,7 @@ spec:
             matchLabels:
               kubernetes.io/metadata.name: {{ .Release.Namespace }}
           podSelector:
-            matchLabels: {{ include "shuffle.app.matchLabels" . | nindent 14 }}
+            matchLabels: {{ include "shuffle.appInstance.matchLabels" . | nindent 14 }}
       {{- end }}
     {{- if .Values.worker.networkPolicy.extraIngress }}
     {{- include "common.tplvalues.render" ( dict "value" .Values.worker.networkPolicy.extraIngress "context" $ ) | nindent 4 }}

functions/kubernetes/charts/shuffle/templates/shuffle-worker/shuffle-worker-svc.yaml

@@ -0,0 +1,21 @@
+{{- if .Values.worker.enableHelmDeployment }}
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ template "shuffle.worker.name" . }}
+  namespace: {{ include "common.names.namespace" . | quote }}
+  {{- $serviceLabels := include "common.tplvalues.merge" (dict "values" (list .Values.worker.service.labels .Values.commonLabels) "context" .) }}
+  labels: {{- include "shuffle.workerInstance.labels" (dict "customLabels" $serviceLabels "context" $) | nindent 4 }}
+  {{- if .Values.commonAnnotations }}
+  annotations: {{- include "common.tplvalues.render" (dict "value" .Values.commonAnnotations "context" $) | nindent 4 }}
+  {{- end }}
+spec:
+  type: ClusterIP
+  ports:
+    - name: http
+      port: 33333
+      targetPort: 33333
+      protocol: TCP
+      appProtocol: http
+  selector: {{- include "shuffle.workerInstance.matchLabels" $ | nindent 4 }}
+{{- end }}