Skip to content

Commit

Permalink
docs: explain why docker-compose.jobs.yml exists
Browse files Browse the repository at this point in the history
Based on:
#642 (comment)
  • Loading branch information
kdmccormick authored and regisb committed May 3, 2023
1 parent 6771732 commit 2e276cb
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions tutor/templates/local/docker-compose.jobs.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# Tutor provides the `tutor MODE do JOB ...` CLI as a consistent way to execute jobs
# across the dev, local, and k8s modes. To support jobs in the docker-compose modes
# (dev and local), we must define a `-job` variant service in which jobs could be run.

# When `tutor local do JOB ...` is invoked, we `docker-compose run` each of JOB's
# tasks against the appropriate `-job` services, as defined here.
# When `tutor dev do JOB ...` is invoked, we do the same, but also include any
# compose overrides in ../dev/docker-compose.jobs.yml.

# Note that these services will all be `run` rather than `start`ed and `exec`ed.
# This is because jobs are often used for initialization tasks, which may need to
# happen before the service can be successfully `start`ed.

version: "{{ DOCKER_COMPOSE_VERSION }}"
services:

Expand Down

0 comments on commit 2e276cb

Please sign in to comment.