Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.98 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.98 KB
Raw

Jobs

Jobs and microservices for routine maintenance and reporting.

Testing and development

Jobs should preferentially be developed to be run in the below platform order. There are only very minor differences. In fact, just containerize them (i.e. include a Dockerfile), and they can also be taken anywhere else.
The preference below is mostly for best security / availability / cost tracking reasons.

  • Sage's Service Catalog
  • Github Actions
  • Some other platform

General contribution flow for a new job

  1. Create a branch off main with prefix feat/.
  2. Create a new directory for the job/service and put the script(s), Dockerfile, and (recommended) the job-specific README there.
  3. Add a workflow file to build an image (copy and adapt from current .github/worflows).
  • Change on.paths so that the Docker build will build specifically for the job
  • In the very last step, make sure to update context to the new job directory
  1. (Optional) In your final commit, add [pre-build] in commit message if you want to provide a test image for the reviewers in the PR.
  2. Make PR against main and add reviewer.

Contributions to existing jobs

Create a branch off main with prefix patch/, fix/, etc. Ignore steps 2-4 because the directory and workflow will already exist.

Testing

Here is how a job image is usually tested:

  1. (a) cd into the job directory and build the image or (b) pull the image if it has been pre-built, e.g. with [pre-build] option mentioned above

  2. Prepare an env-file with the required secrets and variables mentioned in the job's README, e.g.:

SCHEDULED_JOB_SECRETS={"SYNAPSE_AUTH_TOKEN":"xxxxxxxxxxxxxxxxxxxxxxxxxxxx"}
SCHEDULE=weekly
SLACK=https://hooks.slack.com/services/xxxxxxxxxxxxxxxxxxxxxxxxxxxx
  1. Run the containerized job: docker run --env-file envfile ghcr.io/nf-osi/jobs-some-job

Depending on the job, there may be additional commands to run. Refer to the job's README.