control-service: Update helm template license headers (#1670)

### What Update helm template license headers to use template-style comments Ignore helm templates in pre-commit yaml license hook Create new pre-commit license hook to add template-style comments to helm templates ### Why Regular yaml comments at the top of files break parsing for helm charts This breaks control-service deployments ### How was this tested Tested installing the charts on a local k8s cluster using helm Ran `helm upgrade --install --debug --wait --timeout 10m0s cicd-control-service .` on the chart, which gave me the same output as the failing pipeline. Edited the comments until the apiVersion error disappeared. ``` Error: UPGRADE FAILED: error validating "": error validating data: apiVersion not set ``` https://gitlab.com/vmware-analytics/versatile-data-kit/-/jobs/3813924321 Signed-off-by: Dilyan Marinov <[email protected]>
vmware · Feb 24, 2023 · 1516bcb · 1516bcb
1 parent fefa259
commit 1516bcb
Show file tree

Hide file tree

Showing 23 changed files with 97 additions and 42 deletions.
diff --git a/.gitignore b/.gitignore
@@ -63,3 +63,6 @@ tests.xml
 temp
 gradlew
 gradlew.bat
+
+# Ignore downloaded helm charts
+projects/control-service/projects/helm_charts/pipelines-control-service/charts/*
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -113,10 +113,20 @@ repos:
           - /*| *| */
       - id: insert-license
         files: (\.yaml$|\.yml$)
+        # exclude control service helm chart templates as they require template-style comments
+        exclude: ^projects/control-service/projects/helm_charts/pipelines-control-service/templates
         args:
           - --use-current-year
           - --license-filepath
           - NOTICE.txt
+      - id: insert-license
+        files: (^projects/control-service/projects/helm_charts/pipelines-control-service/templates/.+\.yaml$|^projects/control-service/projects/helm_charts/pipelines-control-service/templates/.+\.yml$)
+        args:
+          - --use-current-year
+          - --license-filepath
+          - NOTICE.txt
+          - --comment-style
+          - '{{- /*| | */}}'
       - id: insert-license
         files: \.py$
         args:

diff --git a/...ects/helm_charts/pipelines-control-service/templates/configmap_datajob_template_file.yaml b/...ects/helm_charts/pipelines-control-service/templates/configmap_datajob_template_file.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.datajobTemplate.enabled }}
 apiVersion: v1

diff --git a/.../control-service/projects/helm_charts/pipelines-control-service/templates/deployment.yaml b/.../control-service/projects/helm_charts/pipelines-control-service/templates/deployment.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 apiVersion: apps/v1
 kind: Deployment

diff --git a/...ntrol-service/projects/helm_charts/pipelines-control-service/templates/fluentdconfig.yaml b/...ntrol-service/projects/helm_charts/pipelines-control-service/templates/fluentdconfig.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2023-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.fluentd.enabled }}
 apiVersion: logs.vdp.vmware.com/v1beta1

diff --git a/...vice/projects/helm_charts/pipelines-control-service/templates/fluentdconfig_datajobs.yaml b/...vice/projects/helm_charts/pipelines-control-service/templates/fluentdconfig_datajobs.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.dataJob.fluentd.enabled }}
 apiVersion: logs.vdp.vmware.com/v1beta1

diff --git a/...cts/control-service/projects/helm_charts/pipelines-control-service/templates/ingress.yaml b/...cts/control-service/projects/helm_charts/pipelines-control-service/templates/ingress.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.ingress.enabled -}}
 kind: Ingress

diff --git a/...rol-service/projects/helm_charts/pipelines-control-service/templates/prometheusrules.yaml b/...rol-service/projects/helm_charts/pipelines-control-service/templates/prometheusrules.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.alerting.enabled }}
 apiVersion: monitoring.coreos.com/v1

diff --git a/projects/control-service/projects/helm_charts/pipelines-control-service/templates/role.yaml b/projects/control-service/projects/helm_charts/pipelines-control-service/templates/role.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.rbac.create -}}
 apiVersion: rbac.authorization.k8s.io/v1

diff --git a/...ntrol-service/projects/helm_charts/pipelines-control-service/templates/role_datajobs.yaml b/...ntrol-service/projects/helm_charts/pipelines-control-service/templates/role_datajobs.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if and .Values.rbac.create .Values.rbac.datajobsDeployment.create -}}
 apiVersion: rbac.authorization.k8s.io/v1

diff --git a/...ontrol-service/projects/helm_charts/pipelines-control-service/templates/rolebindings.yaml b/...ontrol-service/projects/helm_charts/pipelines-control-service/templates/rolebindings.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if and .Values.serviceAccount.create .Values.rbac.create }}
 apiVersion: rbac.authorization.k8s.io/v1

diff --git a/...rvice/projects/helm_charts/pipelines-control-service/templates/rolebindings_datajobs.yaml b/...rvice/projects/helm_charts/pipelines-control-service/templates/rolebindings_datajobs.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if and .Values.serviceAccount.create .Values.rbac.create .Values.rbac.datajobsDeployment.create }}
 apiVersion: rbac.authorization.k8s.io/v1

diff --git a/...control-service/projects/helm_charts/pipelines-control-service/templates/secret_jdbc.yaml b/...control-service/projects/helm_charts/pipelines-control-service/templates/secret_jdbc.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 ## Create a secret with JDBC credentials for embedded database (PostgreSQL or CockroachDB) only if externalSecretName is not supplied.
 ## If any of the fields are empty, we fall-back to defaults (f.e. local dev environment)

diff --git a/...ects/helm_charts/pipelines-control-service/templates/secret_kubernetes_authenticator.yaml b/...ects/helm_charts/pipelines-control-service/templates/secret_kubernetes_authenticator.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 ## Create a secret with Kerberos keytab for authentication if kerberos authentication flag is turned on.
 ## The keytab file contents are set from the values.yaml file and are intended to be populated by an env

diff --git a/...ervice/projects/helm_charts/pipelines-control-service/templates/secret_pull_base_img.yaml b/...ervice/projects/helm_charts/pipelines-control-service/templates/secret_pull_base_img.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.deploymentDataJobBaseImage.password }}
 apiVersion: v1

diff --git a/...ice/projects/helm_charts/pipelines-control-service/templates/secret_pull_builder_img.yaml b/...ice/projects/helm_charts/pipelines-control-service/templates/secret_pull_builder_img.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.deploymentBuilderImage.password }}
 apiVersion: v1

diff --git a/...rol-service/projects/helm_charts/pipelines-control-service/templates/secret_pull_img.yaml b/...rol-service/projects/helm_charts/pipelines-control-service/templates/secret_pull_img.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if and (eq .Values.deploymentDockerRegistryType "generic") .Values.deploymentDockerRegistryUsernameReadOnly .Values.deploymentDockerRegistryPasswordReadOnly }}
 apiVersion: v1

diff --git a/...charts/pipelines-control-service/templates/secret_pull_pipelines_control_service_img.yaml b/...charts/pipelines-control-service/templates/secret_pull_pipelines_control_service_img.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if (include "shouldCreatePipelinesControlServiceDockerRepoSecret" .) }}
 apiVersion: v1

diff --git a/...ice/projects/helm_charts/pipelines-control-service/templates/secret_pull_vdk_sdk_img.yaml b/...ice/projects/helm_charts/pipelines-control-service/templates/secret_pull_vdk_sdk_img.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if (include "shouldCreateVdkSdkDockerRepoSecret" .) }}
 apiVersion: v1

diff --git a/...cts/control-service/projects/helm_charts/pipelines-control-service/templates/secrets.yaml b/...cts/control-service/projects/helm_charts/pipelines-control-service/templates/secrets.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 apiVersion: v1
 kind: Secret

diff --git a/...cts/control-service/projects/helm_charts/pipelines-control-service/templates/service.yaml b/...cts/control-service/projects/helm_charts/pipelines-control-service/templates/service.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 apiVersion: v1
 kind: Service

diff --git a/...trol-service/projects/helm_charts/pipelines-control-service/templates/serviceaccount.yaml b/...trol-service/projects/helm_charts/pipelines-control-service/templates/serviceaccount.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if .Values.serviceAccount.create }}
 apiVersion: v1

diff --git a/...trol-service/projects/helm_charts/pipelines-control-service/templates/servicemonitor.yaml b/...trol-service/projects/helm_charts/pipelines-control-service/templates/servicemonitor.yaml
@@ -1,5 +1,7 @@
-# Copyright 2021-2023 VMware, Inc.
-# SPDX-License-Identifier: Apache-2.0
+{{- /*
+  Copyright 2021-2023 VMware, Inc.
+  SPDX-License-Identifier: Apache-2.0
+ */}}
 
 {{- if and .Values.metrics.enabled .Values.metrics.serviceMonitor.enabled }}
 apiVersion: monitoring.coreos.com/v1