WIP: add CronJob to run Managers data sync job

Author: tylervz

charts/thub/Chart.yaml

@@ -6,7 +6,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.10.11
+version: 1.11.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
@@ -23,7 +23,7 @@ dependencies:
   - name: keycloak-config
     version: 0.1.2
   - name: lms-data-service
-    version: 1.8.3
+    version: 1.9.0
   - name: ojt
     version: 1.7.3
   - name: user-service

charts/thub/charts/lms-data-service/Chart.yaml

@@ -7,7 +7,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.8.3
+version: 1.9.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/thub/charts/lms-data-service/templates/_helpers.tpl

@@ -215,6 +215,28 @@ Create the name of the JSON file used by the learners-scheduler-job
 {{- end }}
 {{- end }}
 
+{{/*
+Create the name of the CronJob managers-scheduler-job
+*/}}
+{{- define "lms-data-service.managersSchedulerJobName" -}}
+{{ include "lms-data-service.name" . }}-managers-scheduler-job
+{{- end }}
+
+{{/*
+Create the name of the JSON file used by the managers-scheduler-job
+*/}}
+{{- define "lms-data-service.managersSchedulerJobInputFile" -}}
+{{- if .Values.managersSchedulerJob.jsonInputFile -}}
+{{ print .Values.managersSchedulerJob.jsonInputFile }}
+{{- else if eq .Values.global.lmsType "WORKDAY" -}}
+{{ print "./temp/start-managers-web-job.json" }}
+{{- else -}}
+# The Managers data sync job should only be used by WORKDAY environments.
+# TODO: make sure a helpful error message is shown if we try to run the mangers scheduler job with SF LMS environment.
+{{ print "./temp/start-managers-job.json" }}
+{{- end }}
+{{- end }}
+
 {{/*
 Create the name of the JSON file used by the learning-history-upload-job
 */}}

charts/thub/charts/lms-data-service/templates/event-scheduler-job-input-files-configmap.yaml

@@ -74,6 +74,12 @@ data:
         "instruction": "START",
         "communicationType": "WEBSERVICE"
     }
+  start-managers-web-job.json: |
+    {
+        "type": "MANAGERS",
+        "instruction": "START",
+        "communicationType": "WEBSERVICE"
+    }
   start-rosters-web-job.json: |
     {
         "type": "ROSTERS",

charts/thub/charts/lms-data-service/templates/managers-scheduler-job.yaml

@@ -0,0 +1,71 @@
+{{- if .Values.managersSchedulerJob.enabled -}}
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: {{ include "lms-data-service.managersSchedulerJobName" . }}
+  # These labels do not also get added to the pods created by this job
+  labels:
+    {{- include "lms-data-service.labels" . | nindent 4 }}
+    jobCommonName: lms-managers-scheduler-job
+  annotations:
+    description: >
+      Sends a message to the LMS Data Service application via ActiveMQ notifying it to
+      load managers from the LMS.
+spec:
+  schedule: {{ .Values.managersSchedulerJob.schedule | quote }}
+  concurrencyPolicy: {{ .Values.managersSchedulerJob.concurrencyPolicy | quote }}
+  jobTemplate:
+    spec:
+      template:
+        metadata:
+          annotations:
+            {{- with .Values.managersSchedulerJob.podAnnotations }}
+            {{- toYaml . | nindent 12 }}
+            {{- end }}
+          labels:
+            {{- with .Values.managersSchedulerJob.podLabels }}
+            {{- toYaml . | nindent 12 }}
+            {{- end }}
+        spec:
+          containers:
+          - name: thub-event-scheduler-job
+            image: "{{ .Values.managersSchedulerJob.image.repository }}:{{ .Values.managersSchedulerJob.image.tag | default (include "thub.eventSchedulerJobTag" .) }}"
+            imagePullPolicy: {{ .Values.managersSchedulerJob.image.pullPolicy }}
+            command: ["java", "-jar", "/home/app/application.jar", "jms", "{{ include "lms-data-service.managersSchedulerJobInputFile" . }}"]
+            ports:
+            - containerPort: {{ .Values.managersSchedulerJob.port }}
+              name: http-server
+            resources:
+              {{- toYaml .Values.global.eventSchedulerResources | nindent 14 }}
+            env:
+            - name: server.port
+              value: {{ .Values.managersSchedulerJob.port | quote }}
+            - name: hclabs.scheduler.destinationQueue
+              value: {{ include "thub.sfLmsDataJobQueueName" . }}
+            - name: micronaut.jms.activemq.classic.connection-string
+              valueFrom:
+                configMapKeyRef:
+                  name: mq-broker-config
+                  key: spring.activemq.brokerUrl
+            - name: micronaut.jms.activemq.classic.username
+              valueFrom:
+                configMapKeyRef:
+                  name: mq-broker-config
+                  key: spring.activemq.user
+            - name: micronaut.jms.activemq.classic.password
+              valueFrom:
+                configMapKeyRef:
+                  name: mq-broker-config
+                  key: spring.activemq.password
+            volumeMounts:
+            - name: message-file
+              mountPath: /home/app/temp
+              readOnly: true
+          volumes:
+            - name: message-file
+              configMap:
+                # Provide the name of the ConfigMap containing the files you want
+                # to add to the container
+                name: {{ include "lms-data-service.eventSchedulerInputFilesConfigmapName" . }}
+          restartPolicy: {{ .Values.managersSchedulerJob.restartPolicy }}
+{{- end }}

charts/thub/charts/lms-data-service/values.yaml

@@ -259,6 +259,25 @@ learningHistoryUploadJob:
   podAnnotations: {}
   podLabels: {}
 
+managersSchedulerJob:
+  # TODO: ideally this would default to true if LMS is Workday.
+  #  {{- if eq .Values.global.lmsType "WORKDAY" -}}
+  enabled: false
+  # Run on the eighteenth minute of every 5th hour
+  schedule: "18 */5 * * *"
+  concurrencyPolicy: "Replace"
+  # Overrides the default JSON file used by the job
+  jsonInputFile: ""
+  image:
+    repository: 342628741687.dkr.ecr.us-west-2.amazonaws.com/thub-event-scheduler-cli-job
+    pullPolicy: IfNotPresent
+    # Overrides the image tag whose default is the helper "thub.eventSchedulerJobTag".
+    tag: ""
+  port: 8099
+  restartPolicy: Never
+  podAnnotations: {}
+  podLabels: {}
+
 rostersSchedulerJob:
   enabled: false
   # Run on the 27th minute of every hour from 14 thru 23 and 5

charts/thub/values.yaml

@@ -239,6 +239,10 @@ lms-data-service:
     enabled: true
     # Run every 33 minutes
     schedule: "*/33 * * * *"
+  managersSchedulerJob:
+    # TODO: ideally this would default to true if LMS is Workday.
+    #  {{- if eq .Values.global.lmsType "WORKDAY" -}}
+    enabled: false
 
 ojt:
   resources: {}