Seed Scheduler documentation¶
The Seed Scheduler is one of the microservices in the Seed Stack.
The Scheduler has the following key responsibilities:
- Allow other services to create scheduled callbacks via the API.
- At the scheduled time, call the configured URLs with the configured payload.
Getting started¶
The following resources are provided to help you get started running or developing the Seed Scheduler:
- Learn about the Requirements for running the service and basic Setup instructions.
- Read about the Data Models used by the service.
- Read about the Authorization requirements.
- Browse the API Documentation for the available endpoints and parameters.
- Learn about what is required when running the service in Production
How the task scheduling works¶
The Seed Scheduler uses Celery and the django-celery integration package to handle the scheduling of the periodic tasks.
The schedules are kept in tables in the PostgreSQL database that a Celery beat worker processes and then hands off actual task execution to another Celery worker process.
When a new Schedule object is created via the Seed Scheduler API, a corresponding django-celery PeriodicTask object is created for that schedule.