feat: ✨ add job command override support

Author: Falltrades

charts/dso-ansible-job/templates/cronjob.yaml

@@ -1,8 +1,8 @@
 apiVersion: v2
-name: cpn-ansible-job
-description: Creates Job for Socle services post-configuration.
+name: cpn-job
+description: Creates Job in Kubernetes cluster.
 type: application
-version: 1.6.0
+version: 1.0.0
 appVersion: 1.1.0
 maintainers:
   - name: cloud-pi-native

charts/dso-ansible-job/templates/job.yaml

@@ -1,8 +1,8 @@
-# cpn-ansible-job
+# cpn-job
 
-![Version: 1.6.0](https://img.shields.io/badge/Version-1.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0](https://img.shields.io/badge/AppVersion-1.1.0-informational?style=flat-square)
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0](https://img.shields.io/badge/AppVersion-1.1.0-informational?style=flat-square)
 
-Creates Job for Socle services post-configuration.
+Creates Job in Kubernetes cluster.
 
 ## Maintainers
 
@@ -14,27 +14,25 @@ Creates Job for Socle services post-configuration.
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
+| cronJob.command | list | `[]` | Command to run in the job container. |
 | cronJob.create | bool | `false` | Create a cronJob. |
-| cronJob.name | string | `""` | Playbook name if different from job. |
 | cronJob.schedule | string | `"0 */6 * * *"` | CronJob schedule. |
 | fullnameOverride | string | `""` | String to fully override the default application name. |
 | global.platform | string | `"kubernetes"` | For security context depending of the cluster distribution. |
 | job.activeDeadlineSeconds | string | `nil` | Optional maximum time in seconds before de Pod is killed (no matter of the backoffLimit). |
 | job.annotations | object | `{"argocd.argoproj.io/hook":"PostSync","argocd.argoproj.io/hook-delete-policy":"HookSucceeded"}` | Kubernetes annotations to apply to the job resource. |
 | job.backoffLimit | int | `6` | Number of retries before setting de Job status to failed. |
-| job.dscName | string | `nil` | Name of the DsoSocleConfig to use as source-of-truth. |
+| job.command | list | `[]` | Command to run in the job container. |
 | job.extraEnv | Optional | `[]` | Extra environment variables to pass to the job container. |
 | job.extraVolumeMounts | Optional | `[]` | Extra volume mounts for the job container. |
 | job.extraVolumes | Optional | `[]` | Extra volumes to mount into the job container. |
 | job.image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the job image. |
-| job.image.repository | string | `"ghcr.io/cloud-pi-native/git-ansible"` | Repository to use for the job. |
+| job.image.repository | string | `""` | Repository to use for the job. |
 | job.image.tag | string | `""` | Tag to use for the job. # Overrides the image tag whose default is the chart appVersion. |
-| job.name | string | `"example-playbook"` | Playbook name. |
 | job.restartPolicy | string | `"OnFailure"` | Job restart policy (e.g., Never or OnFailure). |
 | job.serviceAccount.annotations | object | `{}` | Annotations applied to created service account. |
 | job.serviceAccount.create | bool | `true` | Create a service account for the job. |
 | job.serviceAccount.name | string | `""` | Service account name. |
-| job.targetRevision | string | `"main"` | Git branch or tag to checkout before applying the Ansible playbook. |
 | nameOverride | string | `""` | Provide a name in place of the default application name. |
 
 ----------------------------------------------

charts/dso-ansible-job/Chart.yaml charts/dso-job/Chart.yamlcharts/dso-ansible-job/Chart.yaml renamed to charts/dso-job/Chart.yaml

@@ -1,15 +1,15 @@
 {{/*
 Expand the name of the chart.
 */}}
-{{- define "cpnAnsibleJob.name" -}}
+{{- define "cpnJob.name" -}}
 {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
 
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "cpnAnsibleJob.chart" -}}
+{{- define "cpnJob.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
@@ -19,7 +19,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 "cpnAnsibleJob.fullname" -}}
+{{- define "cpnJob.fullname" -}}
 {{- if .Values.fullnameOverride }}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
 {{- else }}
@@ -36,15 +36,19 @@ If release name contains chart name it will be used as a full name.
 {{/*
 Create the name of the service account to use
 */}}
-{{- define "cpnAnsibleJob.job.serviceAccountName" -}}
-{{- default (include "cpnAnsibleJob.name" .) .Values.job.serviceAccount.name }}
+{{- define "cpnJob.job.serviceAccountName" -}}
+{{- default (include "cpnJob.name" .) .Values.job.serviceAccount.name }}
 {{- end }}
 
 
 {{/*
 Generate the common job pod spec used in both Job and CronJob templates.
+This helper accepts an optional dict to override parts of the pod spec,
+such as the command.
+Usage:
+  {{ include "cpnJob.jobPodSpec" (dict "Values" .Values "Chart" .Chart "command" .Values.cronJob.command) }}
 */}}
-{{- define "cpnAnsibleJob.jobPodSpec" -}}
+{{- define "cpnJob.jobPodSpec" -}}
 spec:
   {{- if .Values.job.activeDeadlineSeconds }}
   activeDeadlineSeconds: {{ .Values.job.activeDeadlineSeconds }}
@@ -53,26 +57,22 @@ spec:
   template:
     metadata:
       labels:
-        {{- include "cpnAnsibleJob.job.selectorLabels" . | nindent 8 }}
+        {{- include "cpnJob.job.selectorLabels" . | nindent 8 }}
         {{- with .Values.job.podLabels }}
         {{- toYaml . | nindent 8 }}
         {{- end }}
     spec:
-      serviceAccountName: {{ include "cpnAnsibleJob.job.serviceAccountName" . | default .Values.job.serviceAccount.name}}
+      serviceAccountName: {{ include "cpnJob.job.serviceAccountName" . | default .Values.job.serviceAccount.name }}
       restartPolicy: {{ .Values.job.restartPolicy }}
       containers:
-        - name: {{ .playbookName }}-post-conf
+        - name: dso-job
           image: {{ .Values.job.image.repository }}:{{ .Values.job.image.tag | default .Chart.AppVersion }}
           imagePullPolicy: {{ .Values.job.image.pullPolicy }}
+          {{- with .command | default .Values.job.command }}
           command:
-            - /bin/sh
-            - -c
-            - |
-              git clone https://github.com/cloud-pi-native/socle.git && \
-              cd socle && \
-              git checkout {{ .Values.job.targetRevision }} && \
-              ansible-playbook post-install/{{ .playbookName }}.yaml -e dsc_cr={{ .Values.job.dscName }}
-          {{- include "cpnAnsibleJob.fullSecurityContext" . | indent 10 }}
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+          {{- include "cpnJob.fullSecurityContext" . | indent 10 }}
           {{- with .Values.job.extraEnv }}
           env:
             {{- toYaml . | nindent 12 }}
@@ -91,7 +91,7 @@ spec:
 {{/*
 Add securityContext depending on platform.
 */}}
-{{- define "cpnAnsibleJob.fullSecurityContext" -}}
+{{- define "cpnJob.fullSecurityContext" -}}
 {{- if eq .Values.global.platform "kubernetes" }}
 securityContext:
   allowPrivilegeEscalation: false
@@ -110,24 +110,24 @@ securityContext:
 {{/*
 Common labels
 */}}
-{{- define "cpnAnsibleJob.common.labels" -}}
-helm.sh/chart: {{ include "cpnAnsibleJob.chart" . }}
+{{- define "cpnJob.common.labels" -}}
+helm.sh/chart: {{ include "cpnJob.chart" . }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}
 
-{{- define "cpnAnsibleJob.job.labels" -}}
-{{ include "cpnAnsibleJob.common.labels" . }}
-{{ include "cpnAnsibleJob.job.selectorLabels" . }}
+{{- define "cpnJob.job.labels" -}}
+{{ include "cpnJob.common.labels" . }}
+{{ include "cpnJob.job.selectorLabels" . }}
 {{- end }}
 
 
 {{/*
 Selector labels
 */}}
-{{- define "cpnAnsibleJob.job.selectorLabels" -}}
-app.kubernetes.io/name: {{ include "cpnAnsibleJob.name" . }}
+{{- define "cpnJob.job.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "cpnJob.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}

charts/dso-ansible-job/README.md charts/dso-job/README.mdcharts/dso-ansible-job/README.md renamed to charts/dso-job/README.md

@@ -0,0 +1,10 @@
+{{- if .Values.cronJob.create -}}
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: {{ include "cpnJob.fullname" . }}
+spec:
+  schedule: {{ .Values.cronJob.schedule }}
+  jobTemplate:
+{{ include "cpnJob.jobPodSpec" (dict "Values" .Values "Chart" .Chart "Release" .Release "command" .Values.cronJob.command) | indent 4 }}
+{{- end }}

…s/dso-ansible-job/templates/_helpers.tpl charts/dso-job/templates/_helpers.tplcharts/dso-ansible-job/templates/_helpers.tpl renamed to charts/dso-job/templates/_helpers.tpl charts/dso-ansible-job/templates/_helpers.tpl renamed to charts/dso-job/templates/_helpers.tpl

@@ -0,0 +1,9 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: {{ include "cpnJob.fullname" . }}
+  annotations:
+    {{- range $key, $value := .Values.job.annotations }}
+    {{ $key }}: {{ $value | quote }}
+    {{- end }}
+{{ include "cpnJob.jobPodSpec" (dict "Values" .Values "Chart" .Chart "Release" .Release) }}

charts/dso-job/templates/cronjob.yaml

@@ -2,9 +2,9 @@
 apiVersion: v1
 kind: ServiceAccount
 metadata:
-  name: {{ include "cpnAnsibleJob.job.serviceAccountName" . }}
+  name: {{ include "cpnJob.job.serviceAccountName" . }}
   labels:
-    {{- include "cpnAnsibleJob.job.labels" . | nindent 4 }}
+    {{- include "cpnJob.job.labels" . | nindent 4 }}
   {{- with .Values.job.serviceAccount.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}

charts/dso-job/templates/job.yaml

@@ -9,12 +9,6 @@ global:
 
 # Job configuration.
 job:
-  # -- Playbook name.
-  name: "example-playbook"
-  # -- (string) Name of the DsoSocleConfig to use as source-of-truth.
-  dscName: null
-  # -- Git branch or tag to checkout before applying the Ansible playbook.
-  targetRevision: "main"
   serviceAccount:
     # -- Create a service account for the job.
     create: true
@@ -30,12 +24,17 @@ job:
   backoffLimit: 6
   image:
     # -- Repository to use for the job.
-    repository: ghcr.io/cloud-pi-native/git-ansible
+    repository: ""
     # -- Tag to use for the job.
     ## Overrides the image tag whose default is the chart appVersion.
     tag: ""
     # -- Pull policy for the job image.
     pullPolicy: IfNotPresent
+  # -- Command to run in the job container.
+  command: []
+  #   - /bin/sh
+  #   - -c
+  #   - "echo hello"
   # -- Kubernetes annotations to apply to the job resource.
   annotations:
     argocd.argoproj.io/hook: PostSync
@@ -58,7 +57,11 @@ job:
 cronJob:
   # -- Create a cronJob.
   create: false
-  # -- Playbook name if different from job.
-  name: ""
   # -- CronJob schedule.
   schedule: "0 */6 * * *"
+  # -- Command to run in the job container.
+  command: []
+  #   - /bin/sh
+  #   - -c
+  #   - "echo hello"
+  # -- Kubernetes annotations to apply to the job resource.