Run periodic jobs on the cluster from your plugin
Find a file
dependabot[bot] 9bfe1207e7
dependabot: bump actions/upload-artifact from 6 to 7 (#885)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Craig Perkins <cwperx@amazon.com>
2026-03-06 07:16:36 -05:00
.github dependabot: bump actions/upload-artifact from 6 to 7 (#885) 2026-03-06 07:16:36 -05:00
.idea/copyright Adds REST API to list jobs with an option to list them per node (#786) 2025-07-02 15:07:09 -04:00
build-tools Aggregate codecov across root + sub projects for cumulative report (#800) 2025-08-07 14:41:48 -04:00
formatter Configuring spotlessApply for Job Scheduler (#290) 2022-12-29 13:25:38 -08:00
gradle Upgrade to gradle 9.2 (#864) 2025-11-24 11:05:28 -08:00
release-notes Add release notes for 3.3.0 (#838) 2025-10-07 15:55:47 -04:00
sample-extension-plugin Switch from ARCHIVE to INTEG_TEST to always build with latest (#881) 2026-02-09 09:15:05 -05:00
scripts Uses custom plugin to publish zips to maven (#182) 2022-05-12 13:14:30 -07:00
spi Update shadow plugin usage (#884) 2026-02-14 14:57:32 -05:00
src This reverts commit db49a15 to avoid jarHell in downstream plugins. (#836) 2025-09-25 19:16:57 -04:00
.codecov.yml Job History Service (#814) 2025-08-21 10:15:03 -04:00
.gitignore Update to 3.0.0, run backwards compatibility with OpenSearch 2.4.0 (#242) 2022-09-22 11:29:54 -07:00
.lychee.excludes Add DCO workflow (#86) 2021-11-09 09:25:34 -08:00
.whitesource Add .whitesource configuration file (#116) 2022-05-09 14:44:20 -07:00
ADMINS.md Configuring spotlessApply for Job Scheduler (#290) 2022-12-29 13:25:38 -08:00
build.gradle dependabot: bump de.undercouch.download from 5.6.0 to 5.7.0 (#882) 2026-02-09 09:15:49 -05:00
CHANGELOG.md Rename CHANGELOG to CHANGELOG.md to ensure changelog_verifier workflow works (#843) 2025-12-19 19:22:34 -05:00
CODE_OF_CONDUCT.md Update licenses (#3) 2021-04-19 08:09:41 -07:00
CONTRIBUTING.md Configuring spotlessApply for Job Scheduler (#290) 2022-12-29 13:25:38 -08:00
DEVELOPER_GUIDE.md Set job-scheduler plugin 3.0.0 baseline JDK version to JDK-21 (#686) 2024-10-07 14:15:18 -04:00
gradlew Upgrade to gradle 9.2 (#864) 2025-11-24 11:05:28 -08:00
gradlew.bat Upgrade to gradle 9.2 (#864) 2025-11-24 11:05:28 -08:00
LICENSE.txt Go Public 2021-04-19 05:55:13 +00:00
MAINTAINERS.md Add @prudhvigodithi as a Maintainer (#625) 2024-05-02 09:08:16 -07:00
NOTICE Update copyright notices (#87) 2021-12-29 13:14:40 -05:00
README.md Configuring spotlessApply for Job Scheduler (#290) 2022-12-29 13:25:38 -08:00
RELEASING.md Configuring spotlessApply for Job Scheduler (#290) 2022-12-29 13:25:38 -08:00
SECURITY.md Configuring spotlessApply for Job Scheduler (#290) 2022-12-29 13:25:38 -08:00
settings.gradle Include task publishPluginZipPublicationToMavenLocal (#584) 2024-02-09 10:42:00 -08:00

Test and Build Workflow codecov PRs welcome!

OpenSearch Job Scheduler

OpenSearch JobScheduler plugin provides a framework for OpenSearch plugin developers to schedule periodical jobs running within OpenSearch nodes. You can schedule jobs by specify an interval, or using Unix Cron expression to define more flexible schedule to execute your job.

OpenSearch plugin developers can easily extend JobScheduler plugin to schedule jobs like running aggregation query against raw data and save the aggregated data into a new index every hour, or keep monitoring the shard allocation by calling OpenSearch API and post the output to a Webhook.

Getting Started

Add the following to your plugin to integrate with JobScheduler

  1. Gradle
  1. Implement the following classes
  1. Add the resource file
  • Create org.opensearch.jobscheduler.spi.JobSchedulerExtension file.

Contributing

See developer guide and how to contribute to this project.

Getting Help

If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.

For more information, see project website and documentation. If you need help and are unsure where to open an issue, try forums.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.

License

This project is licensed under the Apache v2.0 License

Copyright OpenSearch Contributors. See NOTICE for details.