Using Pivotal Scheduler
This topic provides instructions for using Pivotal Scheduler.
You can interact with the service through the Cloud Foundry Command Line Interface (cf CLI), Apps Manager, and the Scheduler HTTP API to configure jobs and outbound HTTP calls and to review history. For general information, see Managing Service Instances with the cf CLI.
To start using Pivotal Scheduler, you need the following:
- A PAS deployment with Pivotal Scheduler installed and listed in the Marketplace.
- A Space Developer account.
- (Optional) The cf CLI v6.23.0 or greater and the Pivotal Scheduler CLI plugin installed on your local machine. The Pivotal Scheduler CLI plugin is packaged with the Pivotal Scheduler tile on Pivotal Network.
Every app and service in PAS is scoped to a space. This means that an app can use a service only if an instance of the service exists in the same space.
The Pivotal Scheduler service is a singleton service. Only one service instance can be created in a space.
For apps to use a service, the service must be available in the Marketplace. To confirm the availability of Pivotal Scheduler, perform the following steps:
cf marketplacefrom the command line.
If the output lists
servicecolumn, Pivotal Scheduler is available. If the service is not available, install it. See Installing and Configuring Pivotal Scheduler for more information.
$ cf marketplace Getting services from marketplace in org my-org / space my-space as firstname.lastname@example.org... OK service plans description [...] scheduler-for-pcf standard Scheduler service [...]
To create an instance of the Pivotal Scheduler service, run
cf create-service scheduler-for-pcf standard SERVICE-INSTANCE-NAME, replacing
SERVICE-INSTANCE-NAME with a name of your choice. After you create the service instance, this instance name appears under
name in the output of the
cf services command.
See the following example:
$ cf create-service scheduler-for-pcf standard my-instance
Creating service my-instance in org my-org / space my-space as email@example.com... OK
$ cf services
Getting services in org my-org / space my-space as firstname.lastname@example.org... OK name service plan bound apps last operation my-instance scheduler-for-pcf standard create succeeded
You can create only one instance in a space. If you attempt to create more than one instance in a space, you receive an error response.
For an app to use a service, you must bind it to a service instance. Do this after you push or re-push the app using
To bind an app to a Pivotal Scheduler instance, run
cf bind-service APP-NAME SERVICE-INSTANCE-NAME, replacing
APP-NAME with the name of the app you want to use the Pivotal Scheduler service for and
SERVICE-INSTANCE-NAME with the name you provided when you ran
$ cf bind-service my-app my-instance
Binding service my-instance to my-app in org my-org / space my-space as email@example.com... OK TIP: Use 'cf push' to ensure your env variable changes take effect
If you want to manage jobs and calls through the Scheduler HTTP API, see the Pivotal Scheduler API Documentation.
For information about binding Pivotal Scheduler to your app and scheduling tasks through Apps Manager, see Managing Apps and Service Instances Using Apps Manager.