Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Distributed Scheduler API building block docs #3915

Closed
13 tasks done
Tracked by #7862
hhunter-ms opened this issue Dec 20, 2023 · 5 comments · Fixed by #4256
Closed
13 tasks done
Tracked by #7862

Distributed Scheduler API building block docs #3915

hhunter-ms opened this issue Dec 20, 2023 · 5 comments · Fixed by #4256
Assignees
Labels
area/scheduler content/missing-information More information requested or needed P0
Milestone

Comments

@hhunter-ms
Copy link
Collaborator

hhunter-ms commented Dec 20, 2023

Work involved

Jobs pt 1 PR

merged #4164

  • Overview for Jobs API
  • Add to conceptual overview
  • Add to building blocks concepts
  • Update preview feature doc
  • Update list of Alpha APIs
  • Add API reference doc
  • Diagrams
  • Update dapr init doc to include Scheduler service as included

Jobs pt 2 PR

merged #4240

  • Jobs API how-to - minor add from README in Go-SDK example PR
  • Check formatting and grammar (ie: Jobs overview)

Jobs pt 3 PR

in progress #4243

  • Screenshot of dapr init and docker ps output that shows scheduler service is running
  • Finish how-to based on future quickstart or example
  • Add how to consume a triggered job

The associated pull request from dapr/dapr, dapr/components-contrib, or other Dapr code repos
dapr/proposals#44

@hhunter-ms hhunter-ms added the content/missing-information More information requested or needed label Dec 20, 2023
@hhunter-ms hhunter-ms added this to the 1.13 milestone Dec 20, 2023
@msfussell msfussell modified the milestones: 1.13, 1.14 Jan 25, 2024
@cicoyle
Copy link
Contributor

cicoyle commented Mar 14, 2024

Note for myself: the Scheduler will also need to be documented here since its a new control plane service as well.

@hhunter-ms hhunter-ms modified the milestones: 1.14, 1.15 May 2, 2024
@cicoyle
Copy link
Contributor

cicoyle commented May 28, 2024

This is an involved update and requires updating several documents and diagrams

Let's just call this the Scheduler API, rather than Distributed Scheduler API. All of the APIs are distributed in some way and this term is redundant.

@msfussell
Copy link
Member

msfussell commented May 28, 2024

Also see this issue in QS repor - Go SDK Quickstart for Scheduler API dapr/quickstarts#1026

@cicoyle
Copy link
Contributor

cicoyle commented Jul 8, 2024

Adding a TODO here, so I don't forget- thx @olitomlinson for calling this out in discord:

The dapr docs for the new Job API do not demonstrate how to consume a triggered job in an App - the OnJobEvent bits. We should add this

@hhunter-ms
Copy link
Collaborator Author

thanks for your help, @cicoyle !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/scheduler content/missing-information More information requested or needed P0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants