Skip to content

Latest commit

 

History

History
197 lines (179 loc) · 7.86 KB

jobs.md

File metadata and controls

197 lines (179 loc) · 7.86 KB
Raw

Jobs reference

Job-exec

This job is executed inside a running container. Similar to docker exec

Parameters

  • Schedule *
    • description: When the job should be executed. E.g. every 10 seconds or every night at 1 AM.
    • value: String, see Scheduling format of the Go implementation of cron. E.g. @every 10s or 0 0 1 * * * (every night at 1 AM). Note: the format starts with seconds, instead of minutes.
    • default: Required field, no default.
  • Command *
    • description: Command you want to run inside the container.
    • value: String, e.g. touch /tmp/example
    • default: Required field, no default.
  • Container *
    • description: Name of the container you want to execute the command in.
    • value: String, e.g. nginx-proxy
    • default: Required field, no default.
  • User
    • description: User as which the command should be executed, similar to docker exec --user <user>
    • value: String, e.g. www-data
    • default: root
  • tty
    • description: Allocate a pseudo-tty, similar to docker exec -t. See this Stack Overflow answer for more info.
    • value: Boolean, either false or true
    • default: false

INI-file example

[job-exec "flush-nginx-logs"]
schedule = @hourly
container = nginx-proxy
command = /bin/bash /flush-logs.sh
user = www-data
tty = false

Docker labels example

docker run -it --rm \
    --label ofelia.enabled=true \
    --label ofelia.job-exec.flush-nginx-logs.schedule="@hourly" \
    --label ofelia.job-exec.flush-nginx-logs.command="/bin/bash /flush-logs.sh" \
    --label ofelia.job-exec.flush-nginx-logs.user="www-data" \
    --label ofelia.job-exec.flush-nginx-logs.tty="false" \
        nginx

Job-run

This job can be used in 2 situations:

  1. To run a command inside of a new container, using a specific image. Similar to docker run
  2. To start a stopped container, similar to docker start

Parameters

  • Schedule * (1,2)
    • description: When the job should be executed. E.g. every 10 seconds or every night at 1 AM.
    • value: String, see Scheduling format of the Go implementation of cron. E.g. @every 10s or 0 0 1 * * * (every night at 1 AM). Note: the format starts with seconds, instead of minutes.
    • default: Required field, no default.
  • Command (1)
    • description: Command you want to run inside the container.
    • value: String, e.g. touch /tmp/example
    • default: Default container command
  • Image * (1)
    • description: Image you want to use for the job.
    • value: String, e.g. nginx:latest
    • default: No default. If left blank, Ofelia assumes you will specify a container to start (situation 2).
  • User (1)
    • description: User as which the command should be executed, similar to docker run --user <user>
    • value: String, e.g. www-data
    • default: root
  • Network (1)
    • description: Connect the container to this network
    • value: String, e.g. backend-proxy
    • default: Optional field, no default.
  • Delete (1)
    • description: Delete the container after the job is finished. Similar to docker run --rm
    • value: Boolean, either true or false
    • default: true
  • Container (2)
    • description: Name of the container you want to start.
    • value: String, e.g. nginx-proxy
    • default: Required field in case parameter image is not specified, no default.
  • tty (1,2)
    • description: Allocate a pseudo-tty, similar to docker exec -t. See this Stack Overflow answer for more info.
    • value: Boolean, either true or false
    • default: false

INI-file example

[job-run "sync-rclone"]
schedule = @daily
image = rclone:latest
command = sync remote
user = rclone-user

[job-run "update-ddns"]
schedule = @every 15m
container = ddns-updater

Docker labels example

docker run -it --rm \
    --label ofelia.enabled=true \
    --label ofelia.job-run.sync-rclone.schedule="@daily" \
    --label ofelia.job-run.sync-rclone.command="sync remote" \
    --label ofelia.job-run.sync-rclone.user="rclone-user" \
        rclone:latest

Job-local

Runs the command on the host running Ofelia.

Note: In case Ofelia is running inside a container, the command is executed inside the container. Not on the Docker host.

Parameters

  • Schedule *
    • description: When the job should be executed. E.g. every 10 seconds or every night at 1 AM.
    • value: String, see Scheduling format of the Go implementation of cron. E.g. @every 10s or 0 0 1 * * * (every night at 1 AM). Note: the format starts with seconds, instead of minutes.
    • default: Required field, no default.
  • Command *
    • description: Command you want to run on the host.
    • value: String, e.g. touch test.txt
    • default: Required field, no default.
  • Dir
    • description: Base directory to execute the command.
    • value: String, e.g. /tmp/sandbox/
    • default: Current directory
  • Environment (Broken?)
    • description: List of environment variables
    • value: String, e.g. FILE=test.txt
    • default: Optional field, no default.

INI-file example

[job-run "touch-test-file"]
schedule = @every 15s
command = touch test.txt
dir = /tmp/sandbox/

Job-service-run

This job can be used in 2 situations:

  1. To run a command inside a new "run-once" service, for running inside a swarm.
  2. To run a command inside an existing service, for running inside a swarm.

Parameters

  • Schedule * (1,2)
    • description: When the job should be executed. E.g. every 10 seconds or every night at 1 AM.
    • value: String, see Scheduling format of the Go implementation of cron. E.g. @every 10s or 0 0 1 * * * (every night at 1 AM). Note: the format starts with seconds, instead of minutes.
    • default: Required field, no default.
  • Command (1, 2)
    • description: Command you want to run inside the container.
    • value: String, e.g. touch /tmp/example
    • default: Default container command
  • Image * (1)
    • description: Image you want to use for the job.
    • value: String, e.g. nginx:latest
    • default: No default. If left blank, Ofelia assumes you will specify a container to start (situation 2).
  • Network (1)
    • description: Connect the container to this network
    • value: String, e.g. backend-proxy
    • default: Optional field, no default.
  • delete (1)
    • description: Delete the container after the job is finished.
    • value: Boolean, either true or false
    • default: true
  • Service (2)
    • description: Name of the service you want to run the command in.
    • value: String, e.g. nginx-proxy
    • default: If not specified, Ofelia creates a new service for this job
  • User (1,2)
    • description: User as which the command should be executed.
    • value: String, e.g. www-data
    • default: root
  • tty (1,2)
    • description: Allocate a pseudo-tty, similar to docker exec -t. See this Stack Overflow answer for more info.
    • value: Boolean, either true or false
    • default: false

INI-file example

[job-service-run "service-executed-on-new-container"]
schedule = 0,20,40 * * * *
image = ubuntu
network = swarm_network
command =  touch /tmp/example

[job-service-run "job-executed-on-existing-service"]
schedule = 0,20,40 * * * *
service =  my-service