Merge #690

690: add option to configure namespace in values.yaml r=VineethReddy02 a=VineethReddy02 1. Add option to configure namespace in `values.yaml` 2. In helm chart template files add default namespace value as `.Release.Namespace` (better practice used in community helm charts) 3. Rename `connector` to `promscale` in helm chart. 4. Add helm chart static generation check to CI i.e. PR level tests & scheduled tests. Co-authored-by: Vineeth Pothulapati <vineethpothulapati@outlook.com>
timescale · Jul 13, 2021 · a903f1d · a903f1d
2 parents 5ac4858 + 06bd9d3
commit a903f1d
Show file tree

Hide file tree

Showing 9 changed files with 59 additions and 18 deletions.
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -41,3 +41,14 @@ jobs:
     - name: Test against first supported
       run: ./scripts/end_to_end_tests.sh timescale/timescaledb:1.7.4-pg12
       shell: bash
+
+  test-helm-chart:
+    name: Test helm-chart template generation
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: Test helm chart static generation
+      run: ./scripts/generate-deploy-script.sh
diff --git a/.github/workflows/go-scheduled.yml b/.github/workflows/go-scheduled.yml
@@ -143,3 +143,14 @@ jobs:
         MULTI: ${{ matrix.test-setups.multi }}
         NIGHTLY: ${{ matrix.test-setups.nightly }}
       run: go test ./pkg/tests/end_to_end_tests/ -use-extension=$EXT -use-timescaledb=$TSDB -use-timescale2=$TSDB2 -use-multinode=$MULTI -use-timescaledb-nightly=$NIGHTLY -postgres-version-major=$PG
+
+  test-helm-chart:
+    name: Test helm-chart template generation
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: Test helm chart static generation
+      run: ./scripts/generate-deploy-script.sh
diff --git a/helm-chart/templates/_helpers.tpl b/helm-chart/templates/_helpers.tpl
@@ -3,7 +3,7 @@ Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
 If release name contains chart name it will be used as a full name.
 */}}
-{{- define "connector.fullname" -}}
+{{- define "promscale.fullname" -}}
 {{- if .Values.fullnameOverride -}}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
 {{- else -}}
@@ -19,6 +19,18 @@ If release name contains chart name it will be used as a full name.
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "connector.chart" -}}
+{{- define "promscale.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+
+{{/*
+Allow the release namespace to be overridden
+*/}}
+{{- define "promscale.namespace" -}}
+  {{- if .Values.namespaceOverride -}}
+    {{- .Values.namespaceOverride -}}
+  {{- else -}}
+    {{- .Release.Namespace -}}
+  {{- end -}}
 {{- end -}}
diff --git a/helm-chart/templates/config-maintenance.yaml b/helm-chart/templates/config-maintenance.yaml
@@ -2,10 +2,11 @@
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: {{ include "connector.fullname" . | trunc 51 }}-maintenance
+  name: {{ include "promscale.fullname" . | trunc 51 }}-maintenance
+  namespace: {{ template "promscale.namespace" . }}
   labels:
-    app: {{ template "connector.fullname" . }}
-    chart: {{ template "connector.chart" . }}
+    app: {{ template "promscale.fullname" . }}
+    chart: {{ template "promscale.chart" . }}
     release: {{ .Release.Name }}
     heritage: {{ .Release.Service }}
 data:

diff --git a/helm-chart/templates/cronjob-maintenance.yaml b/helm-chart/templates/cronjob-maintenance.yaml
@@ -2,10 +2,11 @@
 apiVersion: batch/v1beta1
 kind: CronJob
 metadata:
-  name: {{ include "connector.fullname" . | trunc 51 }}-maintenance
+  name: {{ include "promscale.fullname" . | trunc 51 }}-maintenance
+  namespace: {{ template "promscale.namespace" . }}
   labels:
-    app: {{ template "connector.fullname" . }}
-    chart: {{ template "connector.chart" . }}
+    app: {{ template "promscale.fullname" . }}
+    chart: {{ template "promscale.chart" . }}
     release: {{ .Release.Name }}
     heritage: {{ .Release.Service }}
 spec:
@@ -56,7 +57,7 @@ spec:
           volumes:
             - name: script-volume
               configMap:
-                name: {{ include "connector.fullname" . | trunc 51 }}-maintenance
+                name: {{ include "promscal.fullname" . | trunc 51 }}-maintenance
           restartPolicy: OnFailure
           {{- with .Values.maintenance.nodeSelector }}
           nodeSelector:

diff --git a/...chart/templates/deployment-connector.yaml → ...chart/templates/deployment-promscale.yaml b/...chart/templates/deployment-connector.yaml → ...chart/templates/deployment-promscale.yaml
@@ -1,10 +1,11 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: {{ template "connector.fullname" . }}
+  name: {{ template "promscale.fullname" . }}
+  namespace: {{ template "promscale.namespace" . }}
   labels:
-    app: {{ template "connector.fullname" . }}
-    chart: {{ template "connector.chart" . }}
+    app: {{ template "promscale.fullname" . }}
+    chart: {{ template "promscale.chart" . }}
     release: {{ .Release.Name }}
     heritage: {{ .Release.Service }}
 spec:
@@ -13,11 +14,11 @@ spec:
     type: {{ .Values.upgradeStrategy }}
   selector:
     matchLabels:
-      app: {{ template "connector.fullname" . }}
+      app: {{ template "promscale.fullname" . }}
   template:
     metadata:
       labels:
-        app: {{ template "connector.fullname" . }}
+        app: {{ template "promscale.fullname" . }}
       {{ if .Values.prometheus.enabled }}
       annotations: {{ .Values.prometheus.annotations | toYaml | nindent 8 }}
       {{ end }}

diff --git a/helm-chart/templates/svc-connector.yaml → helm-chart/templates/svc-promscale.yaml b/helm-chart/templates/svc-connector.yaml → helm-chart/templates/svc-promscale.yaml
@@ -1,17 +1,18 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: {{ include "connector.fullname" . | trunc 53 }}-connector
+  name: {{ include "promscale.fullname" . | trunc 53 }}-connector
+  namespace: {{ template "promscale.namespace" . }}
   labels:
-    app: {{ template "connector.fullname" . }}
-    chart: {{ template "connector.chart" . }}
+    app: {{ template "promscale.fullname" . }}
+    chart: {{ template "promscale.chart" . }}
     release: {{ .Release.Name }}
     heritage: {{ .Release.Service }}
   annotations:
 {{ .Values.service.loadBalancer.annotations | toYaml | indent 4 }}
 spec:
   selector:
-    app: {{ template "connector.fullname" . }}
+    app: {{ template "promscale.fullname" . }}
 {{- if .Values.service.loadBalancer.enabled }}
   type: LoadBalancer
 {{- else }}

diff --git a/helm-chart/values.yaml b/helm-chart/values.yaml
@@ -3,6 +3,9 @@ imagePullPolicy: IfNotPresent
 # number of connector pods to spawn
 replicaCount: 1
 
+# Override the deployment namespace
+namespaceOverride: ""
+
 # Promscale deployment upgrade strategy
 # as Promscale upgrade requires no existing Promscale
 # connected with TimescaleDB. Recreate strategy helps

diff --git a/scripts/generate-script-deploy.sh → scripts/generate-deploy-script.sh b/scripts/generate-script-deploy.sh → scripts/generate-deploy-script.sh