From 21ebbb131d97e09b7379ad5cc60ebcfdec17e651 Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Tue, 28 May 2024 16:50:02 -0400 Subject: [PATCH] update content in overview Signed-off-by: Hannah Hunter --- .../distributed-scheduler-overview.md | 55 ++++++++++++------- 1 file changed, 34 insertions(+), 21 deletions(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/distributed-scheduler/distributed-scheduler-overview.md b/daprdocs/content/en/developing-applications/building-blocks/distributed-scheduler/distributed-scheduler-overview.md index 3fdbf8d8e..88038ef84 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/distributed-scheduler/distributed-scheduler-overview.md +++ b/daprdocs/content/en/developing-applications/building-blocks/distributed-scheduler/distributed-scheduler-overview.md @@ -6,7 +6,25 @@ weight: 1000 description: "Overview of the distributed scheduler API building block" --- +The Distributed Scheduler API works as an orchestrator for scheduling jobs in the future, either at a specific time or a specific interval. The scheduler helps you with jobs like: +- Scalable actor reminders +- Scheduling any Dapr API to run at specific times or intervals, like when: + - Sending pub/sub messages + - Calling service invocations and input bindings + - Saving state to a state store + +The Distributed Scheduler consists of two parts that work together to seamlessly schedule jobs across all of Dapr's API building blocks: +- The Distributed Scheduler building block +- [The Distributed Scheduler control plane service]({{< ref scheduler.md >}}) + +This article covers the Distributed Scheduler API building block. + +## How it works + +The Scheduler building block is a job orchestrator, not executor. The design guarantees *at least once* job execution with a bias towards durability and horizontal scaling over precision. This means: +- **Guaranteed:** A job is never invoked *before* the schedule is due. +- **Not guaranteed:** A ceiling time on when the job is invoked *after* the due time is reached. +## Try out the Distributed Scheduler -### Quickstarts and tutorials - -Want to put the Dapr API to the test? Walk through the following quickstart and tutorials to see in action: - -| Quickstart/tutorial | Description | -| ------------------- | ----------- | -| [ quickstart](link) | Description of the quickstart. | -| [ tutorial](link) | Description of the tutorial. | - -### Start using directly in your app - -Want to skip the quickstarts? Not a problem. You can try out the building block directly in your application. After [Dapr is installed](link), you can begin using the API, starting with [the how-to guide](link). - - ---> +You can try out the Distributed Scheduler building block directly in your application. After [Dapr is installed]({{< ref install-dapr-cli.md >}}), you can begin using the Distributed Scheduler API, starting with [the How-to: Set up a Scheduler guide]({{< ref howto-use-scheduler.md >}}). ## Next steps - +- [Learn how to use the distributed scheduler in your environment]({{< ref howto-use-scheduler.md >}}) +- [Learn more about the Scheduler control plane service]({{< ref scheduler.md >}}) +- [Distributed Scheduler API reference]({{< ref scheduler_api.md >}})