Merge pull request #7 from indexdata/DEVOPS-6444-skip-enable

Make module enablement optional

Author: wafschneider

README.md

@@ -2,10 +2,13 @@
 
 This project provides Okapi deployment automation when deploying Okapi modules on Kubernetes.
 
-`okapi-hooks` is a helper container for Okapi module registration (deploy + install/uninstall + undeploy)
+`okapi-hooks` is a helper container for Okapi module registration (deploy + optional install/uninstall + undeploy)
 and a corresponding Helm chart that binds to Helm's `post-instal` and `post-upgrade`
 [lifecycle hooks](https://helm.sh/docs/topics/charts_hooks/).
 
+If a list of Okapi tenants is provided, the module will be enabled (installed)
+for each tenant in the list.
+
 While the container and the chart can be used independently, the intended use is as a subchart dependency
 in a parent Okapi module Helm chart, like so:
 
@@ -31,15 +34,13 @@ moduleDescriptor: |
     "id" : "mod-x-0.1.0",
     "name" : "X Okapi module"
   }
-tenants:
-- mytenant
-
 ```
+
 It's recommended that the module version in the ModuleDescriptor follows the parent chart version.
 
 see [values.yaml](./chart/values.yaml) for a complete list of configuration options.
 
-The parent chart is then build with:
+The parent chart is then built with:
 
 ```bash
 cd /path/to/parent/chart

chart/templates/_validate.tpl

@@ -12,7 +12,4 @@
 {{- if not .Values.moduleDescriptor -}}
 {{- fail "A valid .Values.moduleDescriptor is required!" -}}
 {{- end -}}
-{{- if empty .Values.tenants -}}
-{{- fail "A valid .Values.tenants is required!" -}}
-{{- end -}}
 {{- end -}}

chart/templates/okapi-hook-job.yaml

@@ -33,7 +33,7 @@ spec:
           - name: MODULE_URL
             value: "{{ .Values.moduleUrl }}"
           - name: OKAPI_TENANTS
-            value: "{{ join "," .Values.tenants }}"
+            value: "{{ join "," .Values.tenants | default([]) }}"
           - name: OKAPI_ADMIN_TENANT
             value: "{{ join "," .Values.supertenant }}"
           {{- range $k, $v := .Values.env }}

chart/values.yaml

@@ -12,6 +12,8 @@ moduleUrl: ""
 #ModuleDescriptor literal (JSON), NO DEFAULT
 moduleDescriptor: ""
 #Okapi tenant(s) to deploy the module to, NO DEFAULTS
+#If list is empty or undefined, module will be registered and deployed but
+#not enabled for any tenant
 tenants: []
 
 #REQUIRED values with defaults in the subchart, may be overridden by parent chart:

okapi-hooks.sh

@@ -38,19 +38,23 @@ login() {
 
 # TODO: handle that previous instance is a different version
 hook_pre_delete() {
-	for T in $OKAPI_TENANTS; do
-		echo "[{\"id\":\"${SVCID}\",\"action\":\"disable\"}]" | post -d @- $U/_/proxy/tenants/$T/install
-	done
+  if test -n "${OKAPI_TENANTS}"; then
+	  for T in $OKAPI_TENANTS; do
+		  echo "[{\"id\":\"${SVCID}\",\"action\":\"disable\"}]" | post -d @- $U/_/proxy/tenants/$T/install
+	  done
+  fi
 	delete "$U/_/discovery/modules/${SVCID}/${INSTID}"
 	delete "$U/_/proxy/modules/${SVCID}"
 }
 
 hook_post_install() {
 	echo $OKAPI_MD | post --fail-with-body -d @- $U/_/proxy/modules
 	echo "{\"srvcId\":\"$SVCID\",\"instId\":\"${INSTID}\",\"url\":\"${MODULE_URL}\"}" | post --fail-with-body -d @- $U/_/discovery/modules
-	for T in $OKAPI_TENANTS; do
-		echo "[{ \"id\":\"${SVCID}\",\"action\":\"enable\"}]" | post --fail-with-body -d @- $U/_/proxy/tenants/$T/install
-	done
+  if test -n "${OKAPI_TENANTS}"; then
+	  for T in $OKAPI_TENANTS; do
+		  echo "[{ \"id\":\"${SVCID}\",\"action\":\"enable\"}]" | post --fail-with-body -d @- $U/_/proxy/tenants/$T/install
+	  done
+  fi
 }
 
 tenants_lookup() {
@@ -86,8 +90,7 @@ tenants_lookup() {
 prepare() {
 	fail=false
 	if test -z "$OKAPI_TENANTS"; then
-		echo "OKAPI_TENANTS not set"
-		fail=true
+		echo "OKAPI_TENANTS not set, will deploy only (no enablement)"
 	fi
 	if test -z "$OKAPI_URL"; then
 		echo "OKAPI_URL not set"
@@ -118,12 +121,16 @@ prepare() {
 	OKAPI_ADMIN_TENANT=${OKAPI_ADMIN_TENANT:-supertenant}
 	SVCID=`echo $OKAPI_MD | jq -r '.id'`
 	INSTID=inst-${SVCID}
-	OKAPI_TENANTS=$(echo "$OKAPI_TENANTS" | tr ',' ' ')
+  if test -n "${OKAPI_TENANTS}"; then
+	  OKAPI_TENANTS=$(echo "$OKAPI_TENANTS" | tr ',' ' ')
+  fi
 }
 
 prepare
 login
-tenants_lookup
+if test -n "${OKAPI_TENANTS}"; then
+  tenants_lookup
+fi
 
 hook_pre_delete
 hook_post_install