feat(helm): add support for controlplane deployment annotations (#7959)

Signed-off-by: slavogiez <stephane.lavogiez@gmail.com> Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Mike Beaumont <mjboamail@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kumahq · Oct 13, 2023 · e80604b · e80604b
1 parent 55696b8
commit e80604b
Show file tree

Hide file tree

Showing 34 changed files with 80 additions and 8 deletions.
diff --git a/api/mesh/v1alpha1/kds.proto b/api/mesh/v1alpha1/kds.proto
@@ -22,11 +22,9 @@ message KumaResource {
   google.protobuf.Any spec = 2;
 }
 
-message ZoneHealthCheckRequest {
-}
+message ZoneHealthCheckRequest {}
 
-message ZoneHealthCheckResponse {
-}
+message ZoneHealthCheckResponse {}
 
 service GlobalKDSService {
   // StreamXDSConfigs is logically a service exposed by Zone CP so Global CP can

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.cni-enabled.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.cni-enabled.golden.yaml
@@ -547,6 +547,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.cni-legacy-enabled.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.cni-legacy-enabled.golden.yaml
@@ -529,6 +529,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.defaults.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.defaults.golden.yaml
@@ -6384,6 +6384,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.dump-values.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.dump-values.yaml
@@ -51,7 +51,10 @@ controlPlane:
   # -- Minimum number of seconds for which a newly created pod should be ready for it to be considered available.
   minReadySeconds: 0
 
-  # -- Control Plane Pod Annotations
+  # -- Annotations applied only to the `Deployment` resource
+  deploymentAnnotations: {}
+
+  # -- Annotations applied only to the `Pod` resource
   podAnnotations: {}
 
   # Horizontal Pod Autoscaling configuration

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present-not-enabled.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present-not-enabled.yaml
@@ -6384,6 +6384,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present.yaml
@@ -6590,6 +6590,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.global-universal-on-k8s.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.global-universal-on-k8s.golden.yaml
@@ -92,6 +92,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.global.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.global.golden.yaml
@@ -349,6 +349,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.override-env-vars.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.override-env-vars.golden.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.overrides.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.overrides.golden.yaml
@@ -335,6 +335,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.registry.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.registry.golden.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/...l/cmd/install/testdata/install-control-plane.tproxy-ebpf-experimental-enabled.golden.yaml b/...l/cmd/install/testdata/install-control-plane.tproxy-ebpf-experimental-enabled.golden.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.with-egress.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.with-egress.golden.yaml
@@ -364,6 +364,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.with-helm-set.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.with-helm-set.yaml
@@ -6446,6 +6446,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.with-helm-values.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.with-helm-values.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 2
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.with-ingress.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.with-ingress.golden.yaml
@@ -364,6 +364,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.zone-universal-on-k8s.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.zone-universal-on-k8s.golden.yaml
@@ -76,6 +76,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.zone.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.zone.golden.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/doNotChangeTlsChecksum.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/doNotChangeTlsChecksum.golden.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/empty.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/empty.golden.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/fix4485.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/fix4485.golden.yaml
@@ -355,6 +355,8 @@ metadata:
     "foo": "baz"
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/fix4496.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/fix4496.golden.yaml
@@ -374,6 +374,8 @@ metadata:
     "foo": "bar"
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/fix4935.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/fix4935.golden.yaml
@@ -617,6 +617,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/fix5978.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/fix5978.golden.yaml
@@ -395,6 +395,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/fix7724.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/fix7724.golden.yaml
@@ -336,6 +336,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/fix7824.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/fix7824.golden.yaml
@@ -410,6 +410,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/minReadySeconds.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/minReadySeconds.golden.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 10

diff --git a/app/kumactl/cmd/install/testdata/install-cp-helm/securityContext.golden.yaml b/app/kumactl/cmd/install/testdata/install-cp-helm/securityContext.golden.yaml
@@ -333,6 +333,8 @@ metadata:
     app: kuma-control-plane
     app.kubernetes.io/name: kuma
     app.kubernetes.io/instance: kuma
+  annotations: 
+
 spec:
   replicas: 1
   minReadySeconds: 0

diff --git a/deployments/charts/kuma/README.md b/deployments/charts/kuma/README.md
@@ -27,7 +27,8 @@ A Helm chart for the Kuma Control Plane
 | controlPlane.kdsGlobalAddress | string | `""` | Only used in `zone` mode |
 | controlPlane.replicas | int | `1` | Number of replicas of the Kuma CP. Ignored when autoscaling is enabled |
 | controlPlane.minReadySeconds | int | `0` | Minimum number of seconds for which a newly created pod should be ready for it to be considered available. |
-| controlPlane.podAnnotations | object | `{}` | Control Plane Pod Annotations |
+| controlPlane.deploymentAnnotations | object | `{}` | Annotations applied only to the `Deployment` resource |
+| controlPlane.podAnnotations | object | `{}` | Annotations applied only to the `Pod` resource |
 | controlPlane.autoscaling.enabled | bool | `false` | Whether to enable Horizontal Pod Autoscaling, which requires the [Metrics Server](https://github.com/kubernetes-sigs/metrics-server) in the cluster |
 | controlPlane.autoscaling.minReplicas | int | `2` | The minimum CP pods to allow |
 | controlPlane.autoscaling.maxReplicas | int | `5` | The max CP pods to scale to |

diff --git a/deployments/charts/kuma/templates/_helpers.tpl b/deployments/charts/kuma/templates/_helpers.tpl
@@ -111,6 +111,15 @@ app: {{ include "kuma.name" . }}-control-plane
 {{ include "kuma.labels" . }}
 {{- end }}
 
+{{/*
+control plane deployment annotations
+*/}}
+{{- define "kuma.cpDeploymentAnnotations" -}}
+{{- range $key, $value := $.Values.controlPlane.deploymentAnnotations }}
+{{ $key | quote }}: {{ $value | quote }}
+{{- end }}
+{{- end }}
+
 {{/*
 ingress labels
 */}}

diff --git a/deployments/charts/kuma/templates/cp-deployment.yaml b/deployments/charts/kuma/templates/cp-deployment.yaml
@@ -69,6 +69,7 @@ metadata:
   name: {{ include "kuma.name" . }}-control-plane
   namespace: {{ .Release.Namespace }}
   labels: {{ include "kuma.cpLabels" . | nindent 4 }}
+  annotations: {{ include "kuma.cpDeploymentAnnotations" . | nindent 4 }}
 spec:
   {{- if not .Values.controlPlane.autoscaling.enabled }}
   replicas: {{ .Values.controlPlane.replicas }}

diff --git a/deployments/charts/kuma/values.yaml b/deployments/charts/kuma/values.yaml
@@ -51,7 +51,10 @@ controlPlane:
   # -- Minimum number of seconds for which a newly created pod should be ready for it to be considered available.
   minReadySeconds: 0
 
-  # -- Control Plane Pod Annotations
+  # -- Annotations applied only to the `Deployment` resource
+  deploymentAnnotations: {}
+
+  # -- Annotations applied only to the `Pod` resource
   podAnnotations: {}
 
   # Horizontal Pod Autoscaling configuration

diff --git a/docs/generated/raw/helm-values.yaml b/docs/generated/raw/helm-values.yaml
@@ -51,7 +51,10 @@ controlPlane:
   # -- Minimum number of seconds for which a newly created pod should be ready for it to be considered available.
   minReadySeconds: 0
 
-  # -- Control Plane Pod Annotations
+  # -- Annotations applied only to the `Deployment` resource
+  deploymentAnnotations: {}
+
+  # -- Annotations applied only to the `Pod` resource
   podAnnotations: {}
 
   # Horizontal Pod Autoscaling configuration