mirror of https://github.com/dapr/dotnet-sdk.git
[docs] Add section for workflow (#1031)
* add section for workflow in .NET SDK docs Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com> * add initial draft Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com> * edit from Mark Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com> * quick pass and update from hal and chris Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
This commit is contained in:
Hannah Hunter
GitHub
parent
5ece9d02e0
commit
45e6e43388
|
|
@ -57,6 +57,13 @@ Put the Dapr .NET SDK to the test. Walk through the .NET quickstarts and tutoria
|
|||
<a href="{{< ref dotnet-actors >}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title"><b>Workflow</b></h5>
|
||||
<p class="card-text">Create and manage workflows that work with other Dapr APIs in .NET.</p>
|
||||
<a href="{{< ref dotnet-workflow >}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
## More information
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
type: docs
|
||||
title: "Dapr actors .NET SDK"
|
||||
linkTitle: "Actors"
|
||||
weight: 40000
|
||||
description: Get up and running with the Dapr .NET SDK
|
||||
weight: 30000
|
||||
description: Get up and running with the Dapr actors .NET SDK
|
||||
---
|
||||
|
||||
With the Dapr actor package, you can interact with Dapr virtual actors from a .NET application.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Dapr Workflow .NET SDK"
|
||||
linkTitle: "Workflow"
|
||||
weight: 40000
|
||||
description: Get up and running with Dapr Workflow and the Dapr .NET SDK
|
||||
---
|
||||
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
---
|
||||
type: docs
|
||||
title: "How to: Author and manage Dapr Workflow in the .NET SDK"
|
||||
linkTitle: "How to: Author & manage workflows"
|
||||
weight: 100000
|
||||
description: Learn how to author and manage Dapr Workflow using the .NET SDK
|
||||
---
|
||||
|
||||
Let's create a Dapr workflow and invoke it using the console. In the [provided order processing workflow example](https://github.com/dapr/dotnet-sdk/tree/master/examples/Workflow), the console prompts provide directions on how to both purchase and restock items. In this guide, you will:
|
||||
|
||||
- Create a .NET console application ([WorkflowConsoleApp](./WorkflowConsoleApp)).
|
||||
- Utilize the .NET workflow SDK and API calls to start and query workflow instances.
|
||||
|
||||
In the .NET example project:
|
||||
- The main `Program.cs` file contains the setup of the app, including the registration of the workflow and workflow activities.
|
||||
- The workflow definition is found in the `Workflows` directory.
|
||||
- The workflow activity definitions are found in the `Activities` directory.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [.NET 6+](https://dotnet.microsoft.com/download) installed
|
||||
- [Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/)
|
||||
- [Initialized Dapr environment](https://docs.dapr.io/getting-started/install-dapr-selfhost/)
|
||||
- [Dapr .NET SDK](https://github.com/dapr/dotnet-sdk/)
|
||||
|
||||
|
||||
## Set up the environment
|
||||
|
||||
Clone the [.NET SDK repo](https://github.com/dapr/dotnet-sdk).
|
||||
|
||||
```sh
|
||||
git clone https://github.com/dapr/dotnet-sdk.git
|
||||
```
|
||||
|
||||
From the .NET SDK root directory, navigate to the Dapr Workflow example.
|
||||
|
||||
```sh
|
||||
cd examples/Workflow
|
||||
```
|
||||
|
||||
## Run the application locally
|
||||
|
||||
To run the Dapr application, you need to start the .NET program and a Dapr sidecar. Navigate to the `WorkflowConsoleApp` directory.
|
||||
|
||||
```sh
|
||||
cd WorkflowConsoleApp
|
||||
```
|
||||
|
||||
Start the program.
|
||||
|
||||
```sh
|
||||
dotnet run
|
||||
```
|
||||
|
||||
In a new terminal, navigate again to the `WorkflowConsoleApp` directory and run the Dapr sidecar alongside the program.
|
||||
|
||||
```sh
|
||||
dapr run --app-id wfapp --dapr-grpc-port 4001 --dapr-http-port 3500
|
||||
```
|
||||
|
||||
> Dapr listens for HTTP requests at `http://localhost:3500` and internal workflow gRPC requests at `http://localhost:4001`.
|
||||
|
||||
## Start a workflow
|
||||
|
||||
To start a workflow, you have two options:
|
||||
|
||||
1. Follow the directions from the console prompts.
|
||||
1. Use the workflow API and send a request to Dapr directly.
|
||||
|
||||
This guide focuses on the workflow API option.
|
||||
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
- You can find the commands below in the `WorkflowConsoleApp`/`demo.http` file.
|
||||
- The body of the curl request is the purchase order information used as the input of the workflow.
|
||||
- The "1234" in the commands represents the unique identifier for the workflow and can be replaced with any identifier of your choosing.
|
||||
{{% /alert %}}
|
||||
|
||||
|
||||
Run the following command to start a workflow.
|
||||
|
||||
{{< tabs "Linux/MacOS" "Windows">}}
|
||||
|
||||
{{% codetab %}}
|
||||
|
||||
```bash
|
||||
curl -i -X POST http://localhost:3500/v1.0-alpha1/workflows/dapr/OrderProcessingWorkflow/1234/start \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{ "input" : {"Name": "Paperclips", "TotalCost": 99.95, "Quantity": 1}}'
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
|
||||
```powershell
|
||||
curl -i -X POST http://localhost:3500/v1.0-alpha1/workflows/dapr/OrderProcessingWorkflow/1234/start `
|
||||
-H "Content-Type: application/json" `
|
||||
-d '{ "input" : {"Name": "Paperclips", "TotalCost": 99.95, "Quantity": 1}}'
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
|
||||
If successful, you should see a response like the following:
|
||||
|
||||
```json
|
||||
{"instance_id":"1234"}
|
||||
```
|
||||
|
||||
Send an HTTP request to get the status of the workflow that was started:
|
||||
|
||||
```bash
|
||||
curl -i -X GET http://localhost:3500/v1.0-alpha1/workflows/dapr/OrderProcessingWorkflow/1234
|
||||
```
|
||||
|
||||
The workflow is designed to take several seconds to complete. If the workflow hasn't completed when you issue the HTTP request, you'll see the following JSON response (formatted for readability) with workflow status as `RUNNING`:
|
||||
|
||||
```json
|
||||
{
|
||||
"WFInfo": {
|
||||
"instance_id": "1234"
|
||||
},
|
||||
"start_time": "2023-02-02T23:34:53Z",
|
||||
"metadata": {
|
||||
"dapr.workflow.custom_status": "",
|
||||
"dapr.workflow.input": "{\"Name\":\"Paperclips\",\"Quantity\":1,\"TotalCost\":99.95}",
|
||||
"dapr.workflow.last_updated": "2023-02-02T23:35:07Z",
|
||||
"dapr.workflow.name": "OrderProcessingWorkflow",
|
||||
"dapr.workflow.output": "{\"Processed\":true}",
|
||||
"dapr.workflow.runtime_status": "RUNNING"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Once the workflow has completed running, you should see the following output, indicating that it has reached the `COMPLETED` status:
|
||||
|
||||
```json
|
||||
{
|
||||
"WFInfo": {
|
||||
"instance_id": "1234"
|
||||
},
|
||||
"start_time": "2023-02-02T23:34:53Z",
|
||||
"metadata": {
|
||||
"dapr.workflow.custom_status": "",
|
||||
"dapr.workflow.input": "{\"Name\":\"Paperclips\",\"Quantity\":1,\"TotalCost\":99.95}",
|
||||
"dapr.workflow.last_updated": "2023-02-02T23:35:07Z",
|
||||
"dapr.workflow.name": "OrderProcessingWorkflow",
|
||||
"dapr.workflow.output": "{\"Processed\":true}",
|
||||
"dapr.workflow.runtime_status": "COMPLETED"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
When the workflow has completed, the stdout of the workflow app should look like:
|
||||
|
||||
```log
|
||||
info: WorkflowConsoleApp.Activities.NotifyActivity[0]
|
||||
Received order 1234 for Paperclips at $99.95
|
||||
info: WorkflowConsoleApp.Activities.ReserveInventoryActivity[0]
|
||||
Reserving inventory: 1234, Paperclips, 1
|
||||
info: WorkflowConsoleApp.Activities.ProcessPaymentActivity[0]
|
||||
Processing payment: 1234, 99.95, USD
|
||||
info: WorkflowConsoleApp.Activities.NotifyActivity[0]
|
||||
Order 1234 processed successfully!
|
||||
```
|
||||
|
||||
If you have Zipkin configured for Dapr locally on your machine, then you can view the workflow trace spans in the Zipkin web UI (typically at http://localhost:9411/zipkin/).
|
||||
|
||||
## Next steps
|
||||
|
||||
- [Try the Dapr Workflow quickstart]({{< ref workflow-quickstart.md >}})
|
||||
- [Learn more about Dapr Workflow]({{< ref workflow-overview.md >}})
|
||||
Loading…
Reference in New Issue