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

Jobs API Quickstarts #1056

Closed
wants to merge 80 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
80 commits
Select commit Hold shift + click to select a range
155e606
updating Kubernetes hello quickstart to support endpoint env vars (#1…
salaboy Jun 27, 2024
829fda4
first commit
rochabr Jul 4, 2024
cf735d7
first commit
rochabr Jul 5, 2024
5d12e38
Update README.md
rochabr Jul 5, 2024
0a5f57a
Update README.md
rochabr Jul 5, 2024
26e1551
folder name, dapr.yaml
rochabr Jul 5, 2024
5627009
readme
rochabr Jul 5, 2024
6b05361
Refactoring and finishign HTTP example
rochabr Jul 12, 2024
c553abc
Including status code check for scheduler
rochabr Jul 12, 2024
a748d7b
fixing validation
rochabr Jul 12, 2024
8fcde38
Job duetime 60->30
rochabr Jul 12, 2024
cc5f184
Fixing request data type and README
rochabr Jul 12, 2024
82598bf
SDK jobs
rochabr Jul 15, 2024
a06268f
refactoring
rochabr Jul 16, 2024
05cbdf3
finishing sdk example
rochabr Jul 18, 2024
c65384e
fixing mechanical turk
rochabr Jul 19, 2024
3d678cf
refactoring, changing ports
rochabr Jul 19, 2024
94612fc
Implementing new Jobs API on HTTP
rochabr Jul 22, 2024
ccf741c
fixing tests
rochabr Jul 22, 2024
7162e7c
updating main README file
rochabr Jul 22, 2024
3f8cd5d
Fixes test failure that could happen looking at Configuration values …
paulyuk Jul 9, 2024
e479b0c
Changing Dapr runtime version to 1.13.5 to support test efforts (#1049)
paulyuk Jul 9, 2024
c0765b5
feat: upgraded springboot to 3.3.1 and bumped up other dependencies t…
amardeep2006 Jun 29, 2024
46ae1d9
fixing sdk implementation
rochabr Jul 22, 2024
9771c41
Update README.md
rochabr Jul 22, 2024
632e8f6
fixing ports on README files
rochabr Jul 23, 2024
64c14d6
Update jobs/go/http/job-service/job-service.go
rochabr Jul 23, 2024
06a5e46
Update jobs/go/sdk/job-service/job-service.go
rochabr Jul 23, 2024
9205cd2
Update jobs/go/sdk/job-service/job-service.go
rochabr Jul 23, 2024
2ee189f
Update jobs/go/sdk/job-service/job-service.go
rochabr Jul 23, 2024
af757cd
Update jobs/go/http/job-service/job-service.go
rochabr Jul 23, 2024
1ac487e
Update .github/env/global.env
rochabr Jul 23, 2024
728b228
Update .github/env/global.env
rochabr Jul 23, 2024
4a35b99
fixing README typo
rochabr Jul 23, 2024
998fb0d
Merge branch 'master' into distr-scheduler
rochabr Jul 23, 2024
e6d7aed
Increasing sleep to validate tests
rochabr Jul 23, 2024
34466b4
updating Kubernetes hello quickstart to support endpoint env vars (#1…
salaboy Jun 27, 2024
44f8432
first commit
rochabr Jul 4, 2024
d3e096b
first commit
rochabr Jul 5, 2024
b8d27f0
Update README.md
rochabr Jul 5, 2024
7dad62c
Update README.md
rochabr Jul 5, 2024
783c1f2
folder name, dapr.yaml
rochabr Jul 5, 2024
1ecb0f5
readme
rochabr Jul 5, 2024
fd1974d
Refactoring and finishign HTTP example
rochabr Jul 12, 2024
154731a
Including status code check for scheduler
rochabr Jul 12, 2024
ad4d4a7
fixing validation
rochabr Jul 12, 2024
c37986c
Job duetime 60->30
rochabr Jul 12, 2024
1436c5b
Fixing request data type and README
rochabr Jul 12, 2024
eb44b3d
SDK jobs
rochabr Jul 15, 2024
2f7c8ae
refactoring
rochabr Jul 16, 2024
092bdb4
finishing sdk example
rochabr Jul 18, 2024
d1288c7
fixing mechanical turk
rochabr Jul 19, 2024
4e001f7
refactoring, changing ports
rochabr Jul 19, 2024
d8c65ae
Implementing new Jobs API on HTTP
rochabr Jul 22, 2024
7fab465
fixing tests
rochabr Jul 22, 2024
cb12f2c
updating main README file
rochabr Jul 22, 2024
76798d4
Fixes test failure that could happen looking at Configuration values …
paulyuk Jul 9, 2024
e261786
Changing Dapr runtime version to 1.13.5 to support test efforts (#1049)
paulyuk Jul 9, 2024
cd089e1
feat: upgraded springboot to 3.3.1 and bumped up other dependencies t…
amardeep2006 Jun 29, 2024
112aa95
fixing sdk implementation
rochabr Jul 22, 2024
1bae77b
Update README.md
rochabr Jul 22, 2024
44a715a
fixing ports on README files
rochabr Jul 23, 2024
9ce907b
Update jobs/go/http/job-service/job-service.go
rochabr Jul 23, 2024
cf42714
Update jobs/go/sdk/job-service/job-service.go
rochabr Jul 23, 2024
cf6d433
Update jobs/go/sdk/job-service/job-service.go
rochabr Jul 23, 2024
5f2de03
Update jobs/go/sdk/job-service/job-service.go
rochabr Jul 23, 2024
587ca43
Update jobs/go/http/job-service/job-service.go
rochabr Jul 23, 2024
428d07d
Update .github/env/global.env
rochabr Jul 23, 2024
aef0b47
Update .github/env/global.env
rochabr Jul 23, 2024
5c706f4
fixing README typo
rochabr Jul 23, 2024
10d61e0
Changing Dapr runtime version to 1.13.5 to support test efforts (#1049)
paulyuk Jul 9, 2024
4e1fccf
Update tutorials pub-sub csharp-subscriber image to dotnet 8.0 (#1001)
antontroshin Jul 22, 2024
6dabd02
Increasing sleep to validate tests
rochabr Jul 23, 2024
c03a040
Merge branch 'distr-scheduler' of https://github.com/rochabr/quicksta…
rochabr Jul 23, 2024
1e6d676
Merge branch 'distr-scheduler' of https://github.com/rochabr/quicksta…
rochabr Jul 23, 2024
c9c0c9a
Merge branch 'distr-scheduler' of https://github.com/rochabr/quicksta…
rochabr Jul 23, 2024
e39cd2b
Merge branch 'master' into distr-scheduler
rochabr Jul 23, 2024
7f8cebd
Update jobs/go/http/README.md
rochabr Jul 23, 2024
58a2a26
Fixing merge conflict
rochabr Jul 24, 2024
0427e3f
Adding timers between calls
rochabr Jul 24, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/env/global.env
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
DAPR_CLI_VERSION: 1.13.0
DAPR_RUNTIME_VERSION: 1.13.5
DAPR_INSTALL_URL: https://raw.githubusercontent.com/dapr/cli/v${DAPR_CLI_VERSION}/install/
DAPR_DEFAULT_IMAGE_REGISTRY: ghcr
MACOS_PYTHON_VERSION: 3.10
DAPR_CLI_VERSION: 1.14.0-rc.6
DAPR_RUNTIME_VERSION: 1.14.0-rc.5
DAPR_INSTALL_URL: https://raw.githubusercontent.com/dapr/cli/v${DAPR_CLI_VERSION}/install/
DAPR_DEFAULT_IMAGE_REGISTRY: ghcr
MACOS_PYTHON_VERSION: 3.10
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Pick a building block API (for example, PubSub, state management, etc) and rapid
| [Cryptography](./cryptography) | Perform cryptographic operations without exposing keys to your application |
| [Resiliency](./resiliency) | Define and apply fault-tolerant policies (retries/back-offs, timeouts and circuit breakers) to your Dapr API requests |
| [Workflow](./workflows) | Dapr Workflow enables you to create long running, fault-tolerant, stateful applications |
| [Jobs](./jobs) | Dapr Jobs enable you to manage and schedule tasks |

### Tutorials

Expand Down
152 changes: 152 additions & 0 deletions jobs/go/http/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# Dapr Jobs

In this quickstart, you'll schedule, get, and delete a job using Dapr's Job API. This API is responsible for scheduling and running jobs at a specific time or interval.

Visit [this](https://v1-14.docs.dapr.io/developing-applications/building-blocks/jobs/) link for more information about Dapr and the Jobs API.
rochabr marked this conversation as resolved.
Show resolved Hide resolved

> **Note:** This example leverages HTTP `requests` only. If you are looking for the example using the Dapr Client SDK (recommended) [click here](../sdk/).

This quickstart includes two apps:

- `job-scheduler.go`, responsible for scheduling, retrieving and deleting jobs.
- `job-service.go`, responsible for handling the triggered jobs.

## Run the app with the template file

This section shows how to run both applications at once using [multi-app run template files](https://docs.dapr.io/developing-applications/local-development/multi-app-dapr-run/multi-app-overview/) with `dapr run -f .`. This enables to you test the interactions between multiple applications and will `schedule`, `run`, `get`, and `delete` jobs within a single process.

Open a new terminal window and run the multi app run template:

<!-- STEP
name: Run multi app run template
expected_stdout_lines:
- '== APP - job-service == Received job request...'
- '== APP - job-service == Executing maintenance job: Oil Change'
- '== APP - job-scheduler == Job Scheduled: C-3PO'
- '== APP - job-service == Received job request...'
- '== APP - job-service == Executing maintenance job: Limb Calibration'
expected_stderr_lines:
output_match_mode: substring
match_order: none
background: true
sleep: 60
timeout_seconds: 120
-->

```bash
dapr run -f .
```

The terminal console output should look similar to this, where:

- The `R2-D2` job is being scheduled.
- The `R2-D2` job is being executed after 2 seconds.
- The `C-3PO` job is being scheduled.
- The `C-3PO` job is being retrieved.

```text
== APP - job-scheduler == Job Scheduled: R2-D2
== APP - job-service == Received job request...
== APP - job-service == Starting droid: R2-D2
== APP - job-service == Executing maintenance job: Oil Change
== APP - job-scheduler == Job Scheduled: C-3PO
== APP - job-scheduler == Job details: {"name":"C-3PO", "dueTime":"30s", "data":{"@type":"ttype.googleapis.com/google.protobuf.StringValue", "expression":"C-3PO:Limb Calibration"}}
```

After 30 seconds, the terminal output should present the `C-3PO` job being processed:

```text
== APP - job-service == Received job request...
== APP - job-service == Starting droid: C-3PO
== APP - job-service == Executing maintenance job: Limb Calibration
```

2. Stop and clean up application processes

```bash
dapr stop -f .
```

<!-- END_STEP -->

## Run the Jobs APIs individually

### Schedule Jobs

1. Open a terminal and run the `job-service` app:

```bash
dapr run --app-id job-service --app-port 6200 --dapr-http-port 6280 -- go run .
```

2. On a new terminal window, schedule the `R2-D2` Job using the Jobs API.

```bash
curl -X POST \
http://localhost:6280/v1.0-alpha1/jobs/jobforjabba \
-H "Content-Type: application/json" \
-d '{
"data": {
"@type": "type.googleapis.com/google.protobuf.StringValue",
"value": "R2-D2:Oil Change"
},
"dueTime": "2s"
}'
```

Back at the `job-service` app terminal window, the output should be:

```text
== APP - job-app == Received job request...
== APP - job-app == Starting droid: R2-D2
== APP - job-app == Executing maintenance job: Oil Change
```

3. On the same terminal window, schedule the `C-3PO` Job using the Jobs API.

```bash
curl -X POST \
http://localhost:6280/v1.0-alpha1/jobs/c-3po \
-H "Content-Type: application/json" \
-d '{
"data": {
"@type": "type.googleapis.com/google.protobuf.StringValue",
"value": "C-3PO:Limb Calibration"
},
"dueTime": "30s"
}'
```

### Get a scheduled job

1. On the same terminal window, run the command below to get the recently scheduled `C-3PO` job.

```bash
curl -X GET http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"
```

You should see the following:

```text
{"name":"C-3PO", "dueTime":"30s", "data":{"@type":"type.googleapis.com/google.protobuf.StringValue", "expression":"C-3PO:Limb Calibration"}}
```

### Delete a scheduled job

1. On the same terminal window, run the command below to deleted the recently scheduled `C-3PO` job.

```bash
curl -X DELETE http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"
```

2. Run the command below to attempt to retrieve the deleted job:

```bash
curl -X GET http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"
```

Back at the `job-service` app terminal window, the output should be:

```text
ERRO[0249] Error getting job c-3po due to: rpc error: code = Unknown desc = job not found: app||default||job-service||c-3po instance=diagrid.local scope=dapr.api type=log ver=1.14.0-rc.2
```
12 changes: 12 additions & 0 deletions jobs/go/http/dapr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 1
apps:
- appDirPath: ./job-service/
appID: job-service
appPort: 6200
daprHTTPPort: 6280
command: ["go", "run", "."]
- appDirPath: ./job-scheduler/
appID: job-scheduler
appPort: 6300
daprHTTPPort: 6380
command: ["go", "run", "."]
3 changes: 3 additions & 0 deletions jobs/go/http/job-scheduler/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module job-scheduler

go 1.21
Empty file.
113 changes: 113 additions & 0 deletions jobs/go/http/job-scheduler/job-scheduler.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
package main

import (
"fmt"
"io"
"log"
"net/http"
"os"
"strings"
"time"
)

var c3poJobBody = `{
"data": {
"@type": "type.googleapis.com/google.protobuf.StringValue",
"value": "C-3PO:Limb Calibration"
},
"dueTime": "30s"
}`

var r2d2JobBody = `{
"data": {
"@type": "type.googleapis.com/google.protobuf.StringValue",
"value": "R2-D2:Oil Change"
},
"dueTime": "2s"
}`

func main() {
//Sleep for 5 seconds to wait for job-service to start
time.Sleep(5 * time.Second)

daprHost := os.Getenv("DAPR_HOST")
if daprHost == "" {
daprHost = "http://localhost"
}

schedulerDaprHttpPort := "6280"

client := http.Client{
Timeout: 15 * time.Second,
}

// Schedule a job using the Dapr Jobs API with short dueTime
jobName := "R2-D2"
reqURL := daprHost + ":" + schedulerDaprHttpPort + "/v1.0-alpha1/jobs/" + jobName

req, err := http.NewRequest("POST", reqURL, strings.NewReader(r2d2JobBody))
if err != nil {
log.Fatal(err.Error())
}

req.Header.Set("Content-Type", "application/json")

// Schedule a job using the Dapr Jobs API
res, err := client.Do(req)
if err != nil {
log.Fatal(err)
}

if res.StatusCode != http.StatusNoContent {
log.Fatalf("failed to register job event handler. status code: %v", res.StatusCode)
}

defer res.Body.Close()

fmt.Println("Job Scheduled:", jobName)

time.Sleep(5 * time.Second)

// Schedule a job using the Dapr Jobs API with long dueTime
jobName = "C-3PO"

reqURL = daprHost + ":" + schedulerDaprHttpPort + "/v1.0-alpha1/jobs/" + jobName

req, err = http.NewRequest("POST", reqURL, strings.NewReader(c3poJobBody))
if err != nil {
log.Fatal(err.Error())
}

req.Header.Set("Content-Type", "application/json")

// Schedule a job using the Dapr Jobs API
res, err = client.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()

fmt.Println("Job Scheduled:", jobName)

time.Sleep(5 * time.Second)

// Gets a job using the Dapr Jobs API
jobName = "C-3PO"
reqURL = daprHost + ":" + schedulerDaprHttpPort + "/v1.0-alpha1/jobs/" + jobName

res, err = http.Get(reqURL)
if err != nil {
log.Fatal(err.Error())
}
defer res.Body.Close()

resBody, err := io.ReadAll(res.Body)
if err != nil {
log.Fatal(err.Error())

}

fmt.Println("Job details:", string(resBody))

time.Sleep(5 * time.Second)
}
3 changes: 3 additions & 0 deletions jobs/go/http/job-service/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module job-service

go 1.21
Empty file.
Loading