Schedule Cron Jobs with Terminus

The Terminus Scheduled Jobs Plugin allows customers to schedule and automate specific cron jobs according to their requirements. You can specify the desired frequency (e.g., daily, weekly, monthly, hourly), and the actions to be performed. The system then executes the scheduled jobs automatically based on the provided instructions.

Requirements

• Terminus

Installation

To install this plugin, run the following:

terminus self:plugin:install pantheon-systems/terminus-scheduled-jobs-plugin

For more information about installing Terminus Plugins, see Install Plugins in our Terminus Guide.

Usage

The plugin uses the following syntax:

terminus scheduledjobs:<command>:<subcommand> <site>.<env> "<job name>" "<cron command>" "<cron schedule>"

Where:

• <command>:<subcommand>: the Scheduled Jobs Plugin command and subcommand. See the Commands section for details.

• <site>.<env>: the site name or UUID. Use terminus site:list to retrieve a list of site names and UUIDs.

• <job name>: a brief description of the job.

• <cron command>: the cron command you are scheduling. The following commands cannot be used:

  • Outbound email via sendmail or localhost SMTP is not permitted. Email can still be sent via integrations with third party email providers either via their SMTP servers or API integrations.
  • New Relic

• <cron schedule>: the schedule for the job. See this Wikipedia page for more information about cron schedules.

Jobs "Budget"

Each site has a fixed allocated budget of 300 minutes per day. This is calculated as the sum of all job durations, from the moment the job has started until it finished.

There are currently no restrictions around the number of schedules that can be created for any given site. If the daily budget is exhausted, running jobs are given a 15 minute grace period after which a timeout signal will be issued. No other jobs will be created that day until midnight UTC when all budgets are reset. In calculating the budget, partial minutes are rounded up.

Job Timeouts

Timeouts are dynamic and dependent on the remaining budget plus the 15 minute grace period. For instance, the daily available budget at the start of the day is 300 minutes, which means the first job's timeout is 315 minutes. When a job is launched throughout the day and the remaining budget is 60 minutes, the timeout will be calculated to 75 minutes.

Commands

These commands may require the following variables, indicated by <variable name>.

• <site>.<env>: the site name or UUID. Use terminus site:list to retrieve a list of site names and UUIDs.

• <job name>: a brief description of the job.

• <cron command>: the cron command you are scheduling. The following commands cannot be used:

• <cron schedule>: the schedule for the job. See this Wikipedia page for more information about cron schedules.

• <job ID>: The unique ID of the job, which you can find using the jobs:list command.

• <schedule ID>: the unique ID of the schedule, which you can find using the schedule:list command.

budget:info

View your current budget status.

terminus scheduledjobs:budget:info <site>.<env>

---------------------- ------------------------ -----------
 Daily Budget Elapsed   Daily Budget Remaining   Resets In
---------------------- ------------------------ -----------
 100m                   200m                     16h11m29s
---------------------- ------------------------ -----------

jobs:list

Returns a list of all active jobs.

terminus scheduledjobs:job:list <site>.<env> 

-------------------------------------- ------------------------------- ------------------------------- ---------
 ID                                     Start Time                      End Time                        Status
-------------------------------------- ------------------------------- ------------------------------- ---------
 ca93e729-58e8-489f-805b-f73d4102c5c0   2023-05-26 07:00:03 +0000 UTC   2023-05-26 07:01:57 +0000 UTC   SUCCESS
 808a3a84-b1c6-42cf-92c8-f0b6afe959c8   2023-05-26 06:00:03 +0000 UTC   2023-05-26 06:01:51 +0000 UTC   SUCCESS
 e0a74a62-6705-4f0c-830c-0190f57dc1c0   2023-05-26 05:00:00 +0000 UTC   2023-05-26 05:01:34 +0000 UTC   SUCCESS
 7effda3b-be2e-42b9-9093-cd373b7b3079   2023-05-26 04:00:00 +0000 UTC   2023-05-26 04:01:33 +0000 UTC   SUCCESS
 54c39e63-fcf5-41f0-81ec-4163fc1f498b   2023-05-26 03:00:00 +0000 UTC   2023-05-26 03:01:54 +0000 UTC   SUCCESS
 fdf2cf55-88f5-44a1-8a7e-d422291f625a   2023-05-26 02:00:02 +0000 UTC   2023-05-26 02:01:51 +0000 UTC   SUCCESS
-------------------------------------- ------------------------------- ------------------------------- ---------

jobs:logs

View logs associated with a job ID.

terminus scheduledjobs:job:logs <site>.<env> <job ID>

schedule:create

Creates a new scheduled job.

terminus scheduledjobs:schedule:create <site>.<env> "<job name>" "<cron command>" "<cron schedule>"

schedule:delete

Delete an existing schedule.

terminus scheduledjobs:schedule:delete <site>.<env> <schedule ID>

schedule:list

Generates a list of all schedules for the specified site environment.

terminus scheduledjobs:schedule:list <site>.<env> 

-------------------------------------- --------------------------- ------------- ---------------------------------- --------- ----------------------
 ID                                     Name                        Schedule      Command                            Status    Created At (UTC)
-------------------------------------- --------------------------- ------------- ---------------------------------- --------- ----------------------
 d178dd16-b0e3-47dc-a446-1bf4343f7fff   test-scheduled-job-hourly   0 * * * *     ls -la /files && drush -vvv cron   ENABLED   2023-05-19T07:34:26Z
-------------------------------------- --------------------------- ------------- ---------------------------------- --------- ----------------------

schedule:pause

Pause a schedule.

terminus scheduledjobs:schedule:pause <site>.<env> <schedule ID>

schedule:resume

Resume a paused schedule.

terminus scheduledjobs:schedule:resume <site>.<env> <schedule ID>