fix: Naming conventions pre/post install/upgrade hooks (#209)

Author: adskyiproger

.github/workflows/deploy-opencrvs.yml

@@ -14,11 +14,11 @@ on:
       core-image-tag:
         description: "Tag of the core image"
         required: true
-        default: "v1.9.1"
+        default: "v1.9.6"
       countryconfig-image-tag:
         description: "Tag of the countryconfig image"
         required: true
-        default: "v1.9.1"
+        default: "v1.9.6"
       environment:
         description: "Target environment"
         required: true

.github/workflows/k8s-reset-data.yml

@@ -82,9 +82,9 @@ jobs:
       matrix:
         job-name:
           - data-cleanup
-          - postgres-on-update-core
+          - postgres-on-deploy
           - data-migration
-          - postgres-on-update-analytics
+          - data-migration-analytics
     steps:
         - name: Download helm release values file into /tmp/opencrvs-${{ inputs.environment }}.json
           uses: actions/download-artifact@v5

charts/opencrvs-services/Chart.yaml

@@ -2,5 +2,5 @@ apiVersion: v2
 name: opencrvs-services
 description: OpenCRVS Services
 type: application
-version: 0.1.26
-appVersion: 1.9.5
+version: 0.1.28
+appVersion: 1.9.6

charts/opencrvs-services/README.md

@@ -800,3 +800,19 @@ In this example:
 - `KIBANA_SYSTEM`, `METRICBEAT`, and `APM` will use the specified usernames (`kibana_system`, `beats_system`, `apm_system`) with random passwords.
 
 The generated credentials can be accessed from the `elasticsearch-opencrvs-users` secret.
+
+# Additional information
+
+## Helm chart hooks
+
+Helm chart has following pre-install/upgrade hooks:
+- elasticsearch-on-deploy: create elasticsearch users and configure permissions, see `elasticsearch` configuration options for more details how to configure users and permissions
+- influxdb-on-deploy: create database
+- mongo-on-deploy: create databases and users with correct permissions, see `mongodb` configuration options for more details how to configure users and permissions
+- postgres-on-deploy: create database, schemas and users with correct permissions 
+
+Helm chart has following post-install/upgrade hooks:
+- data-migration: apply data migrations to postgres, mongodb, influxdb
+- data-migration-analytics: apply data migrations to postgres, this hook use Countryconfig assets docker image, see documentation on how to create own analytics dashboards.
+- data-seed: initial data seed, runs only on post-install
+- elasticsearch-reindex: reindex data after deployment

charts/opencrvs-services/files/setup-analytics.sh

@@ -1,5 +1,3 @@
-# FIXME: Feature to Temporary disable dashboards on m1
-# Defaults: dashboards.enabled = true
 {{- if .Values.dashboards.enabled }}
 ---
 apiVersion: traefik.io/v1alpha1
@@ -54,17 +52,11 @@ spec:
       initContainers:
         - name: copy-assets
           image: "{{ .Values.countryconfig.image.name }}:{{ .Values.countryconfig.image.tag }}-assets"
-          # TODO: [[ -d /assets/metabase ]]: condition was added temporary
-          # to avoid failures until PR will be shipped as part of release to everyone
-          # ETA: OpenCRVS v2.0
-          # Related PR: https://github.com/opencrvs/opencrvs-countryconfig/pull/1184
-          # Related Issue: https://github.com/opencrvs/opencrvs-core/issues/11192
           command:
             - sh
             - -c
             - >
-              [[ -d /assets/metabase ]] && cp -R /assets/metabase/* /data-assets/ ||
-              cp -R /assets/* /data-assets/;
+              cp -R /assets/metabase/* /data-assets/ && \
               chmod +x /data-assets/*.sh
           volumeMounts:
             - name: assets
@@ -140,5 +132,5 @@ spec:
 
 {{- include "pdb-helper" (dict "service_name" "dashboards" "Values" .Values) }}
 
-# FIXME: Feature to Temporary disable dashboards on m1
+
 {{- end }}

charts/opencrvs-services/templates/dashboards-deployment.yaml

@@ -1,25 +1,18 @@
 ---
-# TODO: REVIEW: Refactor job move to countryconfig assets
-#       - delete setup-analytics.sh from helm chart
-#       - remove configmap reference: postgres-on-update-script
-#       - Remove related logic
-# ETA: OpenCRVS v2.0
-# Related PR: https://github.com/opencrvs/opencrvs-countryconfig/pull/1184
-# Related Issue: https://github.com/opencrvs/opencrvs-core/issues/11192
 apiVersion: batch/v1
 kind: Job
 metadata:
   annotations:
     "helm.sh/hook": pre-install,pre-upgrade
     "helm.sh/hook-weight": "3"
   labels:
-    app: postgres-on-update-analytics
-  name: postgres-on-update-analytics
+    app: data-migration-analytics
+  name: data-migration-analytics
 spec:
   template:
     metadata:
       labels:
-        app: postgres-on-update-analytics
+        app: data-migration-analytics
     spec:
       {{- with .Values.imagePullSecrets }}
       imagePullSecrets:
@@ -32,17 +25,13 @@ spec:
             - sh
             - -c
             - >
-              [[ -d /assets/postgres/ ]] && cp -R /assets/postgres/* /data-assets/ ||
-              cp -LR /scripts/* /data-assets/;
+              cp -R /assets/postgres/* /data-assets/ &&
               chmod +x /data-assets/*.sh || true
           volumeMounts:
             - name: assets
               mountPath: /data-assets
-            # TODO: See comment at the top of this file
-            - mountPath: /scripts
-              name: postgres-on-update-script
       containers:
-        - name: postgres-on-update-analytics
+        - name: data-migration-analytics
           command: ["bash", "-c", "/data-assets/setup-analytics.sh"]
           image: postgres:17
           env:
@@ -102,11 +91,6 @@ spec:
             - name: assets
               mountPath: /data-assets
       volumes:
-        # TODO: See comment at the top of this file
-        - name: postgres-on-update-script
-          configMap:
-            name: postgres-on-update-script
-            defaultMode: 0755
         - name: assets
           emptyDir: {}
       restartPolicy: "OnFailure"

…es/postgres-on-update-analytics-job.yaml …plates/data-migration-analytics-job.yamlcharts/opencrvs-services/templates/postgres-on-update-analytics-job.yaml renamed to charts/opencrvs-services/templates/data-migration-analytics-job.yaml charts/opencrvs-services/templates/postgres-on-update-analytics-job.yaml renamed to charts/opencrvs-services/templates/data-migration-analytics-job.yaml

@@ -10,5 +10,5 @@ metadata:
   annotations:
     "helm.sh/hook": pre-install,pre-upgrade
     "helm.sh/hook-weight": "0"
-  name: mongo-on-update-script
+  name: mongo-on-deploy-script
 {{- end }}