Scheduling jobs

You can use VMware Tanzu Scheduler to schedule execution of tasks on VMware Tanzu Operations Manager runtimes, including database migrations, emails, and batch jobs. See the following sections to learn more about creating, running, and scheduling jobs and viewing job history.

class=“note important”> Important Scheduler does not take into account the outcome of previously run jobs. It assumes that scheduled jobs are idempotent and can be re-run. Jobs that are not idempotent may cause unintended consequences even if they complete successfully.

To use the Cloud Foundry Command Line Interface (cf CLI) for managing jobs, you must install the Scheduler CLI plugin on your local machine. This plugin is packaged with the Scheduler tile on VMware Tanzu Network. For more information, see the Prerequisites section of the Using Scheduler topic.

Create a job

To execute a task related to an app, create a job by running the cf create-job APP-NAME JOB-NAME COMMAND command, where:

• APP-NAME is the app you want to execute a task against.
• JOB-NAME is the name for your job.
• COMMAND is the command you want to execute.

Example:

 $ cf create-job my-app my-job “pwd”
 Creating job my-job for my-app with command pwd in org my-org / space my-space as [e-mail]… Job Name   App Name        Command my-job     my-app          pwd OK 

By default, the job is created with the platform defaults for disk and memory limits. Use the following command flags to override the default disk and memory limits when you create a job.

• --disk LIMIT or -k LIMIT sets the task disk limit.
• --memory LIMIT or -m LIMIT sets the task memory limit.

The value of LIMIT must be an integer and be suffixed with either MB for megabytes or GB for gigabytes. For example, --memory 1024MB sets a memory limit of 1024 megabytes and --disk 5GB sets a disk limit of 5 gigabytes.

Execute a job

You can execute a job manually. This is often useful to test the configuration of a job prior to scheduling it for recurring execution.

Run cf run-job JOB-NAME. See the following example:

 $ cf run-job my-job
 Enqueuing job my-job for app my-app in org my-org / space my-space as [e-mail]… OK 

Schedule a job

You can schedule a job to execute at any time using a schedule expression. Scheduler requires Quartz cron expressions in the MIN HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK format. For more information on how to use this syntax, see Scheduler Cron Syntax.

For example, to execute a job at noon every day, run the following command:

$ cf schedule-job my-job "0 12 ? * * "

A single job can have multiple schedules. Each schedule has a GUID to distinguish it from similar schedules.

Note Scheduler does not support cron expressions with seconds or years. Scheduled jobs automatically execute in UTC.

View jobs

You can use the cf CLI to list all jobs in a space by running cf jobs. See the following example:

 $ cf jobs
 Listing jobs for org my-org / space my-space as [e-mail]… Job Name    App Name        Command my-job      my-app          pwd OK 

View schedules for jobs

You can review schedules for all jobs in a space by running cf job-schedules. See the following example:

 $ cf job-schedules
 Getting scheduled jobs for org my-org / space my-space as [e-mail]… App Name: my-app my-job        pwd    2b69e0c2-9664-46bb-4817-54afcedbb65d   0 12 ? * * OK 

View job history

You can review job history by running cf job-history JOB-NAME. See the following example:

 $ cf job-history my-job
 Getting scheduled job history for my-job in org my-org / space my-space as [e-mail]… 1 - 1 of 1 Total Results Execution GUID                     Execution State   Scheduled Time                  Execution Start Time            Execution End Time              Exit Message 8a7e808a5b883a25015b89b4a12c0001   SUCCEEDED         Mon, 10 Apr 2017 13:00:00 UTC   Mon, 10 Apr 2017 13:00:00 UTC   Mon, 10 Apr 2017 13:00:01 UTC   202 - Cloud Controller Accepted Task 

View logs

You can view logs for jobs by running cf logs APP-NAME --recent. See the following example:

 $ cf logs my-app –recent
 Connected, dumping recent logs for app my-app in org my-org / space my-space as [e-mail]… […] 2017-04-19T23:04:13.79-0600 [APP/TASK/cc6fab7f-32a9-4404-4574-b0c430a96cd9 -|- 0d30f4f0-11a4-4d6a-7e77-5e1cdc1aa5ec/0]OUT Creating container 2017-04-19T23:04:14.01-0600 [APP/TASK/cc6fab7f-32a9-4404-4574-b0c430a96cd9 -|- 0d30f4f0-11a4-4d6a-7e77-5e1cdc1aa5ec/0]OUT Successfully created container 2017-04-19T23:04:14.22-0600 [APP/TASK/cc6fab7f-32a9-4404-4574-b0c430a96cd9 -|- 0d30f4f0-11a4-4d6a-7e77-5e1cdc1aa5ec/0]OUT bin 2017-04-19T23:04:14.22-0600 [APP/TASK/cc6fab7f-32a9-4404-4574-b0c430a96cd9 -|- 0d30f4f0-11a4-4d6a-7e77-5e1cdc1aa5ec/0]OUT db 2017-04-19T23:04:14.23-0600 [APP/TASK/cc6fab7f-32a9-4404-4574-b0c430a96cd9 -|- 0d30f4f0-11a4-4d6a-7e77-5e1cdc1aa5ec/0]OUT Exit status 0 2017-04-19T23:04:14.24-0600 [APP/TASK/cc6fab7f-32a9-4404-4574-b0c430a96cd9 -|- 0d30f4f0-11a4-4d6a-7e77-5e1cdc1aa5ec/0]OUT Destroying container 2017-04-19T23:04:14.55-0600 [APP/TASK/cc6fab7f-32a9-4404-4574-b0c430a96cd9 -|- 0d30f4f0-11a4-4d6a-7e77-5e1cdc1aa5ec/0]OUT Successfully destroyed container […] 

Delete a job

You can delete a job by running cf delete-job JOB-NAME. See the following example:

 $ cf delete-job my-job
 Really delete the job my-job with command pwd and all associated schedules and history?> [yN]:y OK 

Delete a job schedule

You can delete a specific schedule by running cf delete-job-schedule JOB-NAME SCHEDULE-GUID, where JOB-NAME is the name of the job and SCHEDULE-GUID is the GUID found in the output of the cf job-schedules command. See the following example:

 $ cf delete-job-schedule my-job 2b69e0c2-9664-46bb-4817-54afcedbb65d
 Really delete the schedule 2b69e0c2-9664-46bb-4817-54afcedbb65d / 0 12 ? * * and all associated history?> [yN]: y Deleting schedule 2b69e0c2-9664-46bb-4817-54afcedbb65d for job my-job in org test / space scheduler as admin OK