diff --git a/daprdocs/content/en/concepts/building-blocks-concept.md b/daprdocs/content/en/concepts/building-blocks-concept.md index ca3d7b955ff..a66ba848a24 100644 --- a/daprdocs/content/en/concepts/building-blocks-concept.md +++ b/daprdocs/content/en/concepts/building-blocks-concept.md @@ -22,7 +22,7 @@ Dapr provides the following building blocks: |----------------|----------|-------------| | [**Service-to-service invocation**]({{< ref "service-invocation-overview.md" >}}) | `/v1.0/invoke` | Service invocation enables applications to communicate with each other through well-known endpoints in the form of http or gRPC messages. Dapr provides an endpoint that acts as a combination of a reverse proxy with built-in service discovery, while leveraging built-in distributed tracing and error handling. | [**Publish and subscribe**]({{< ref "pubsub-overview.md" >}}) | `/v1.0/publish` `/v1.0/subscribe`| Pub/Sub is a loosely coupled messaging pattern where senders (or publishers) publish messages to a topic, to which subscribers subscribe. Dapr supports the pub/sub pattern between applications. -| [**Workflows**]({{< ref "workflow-overview.md" >}}) | `/v1.0-beta1/workflow` | The Workflow API enables you to define long running, persistent processes or data flows that span multiple microservices using Dapr workflows or workflow components. The Workflow API can be combined with other Dapr API building blocks. For example, a workflow can call another service with service invocation or retrieve secrets, providing flexibility and portability. +| [**Workflows**]({{< ref "workflow-overview.md" >}}) | `/v1.0/workflow` | The Workflow API enables you to define long running, persistent processes or data flows that span multiple microservices using Dapr workflows or workflow components. The Workflow API can be combined with other Dapr API building blocks. For example, a workflow can call another service with service invocation or retrieve secrets, providing flexibility and portability. | [**State management**]({{< ref "state-management-overview.md" >}}) | `/v1.0/state` | Application state is anything an application wants to preserve beyond a single session. Dapr provides a key/value-based state and query APIs with pluggable state stores for persistence. | [**Bindings**]({{< ref "bindings-overview.md" >}}) | `/v1.0/bindings` | A binding provides a bi-directional connection to an external cloud/on-premise service or system. Dapr allows you to invoke the external service through the Dapr binding API, and it allows your application to be triggered by events sent by the connected service. | [**Actors**]({{< ref "actors-overview.md" >}}) | `/v1.0/actors` | An actor is an isolated, independent unit of compute and state with single-threaded execution. Dapr provides an actor implementation based on the virtual actor pattern which provides a single-threaded programming model and where actors are garbage collected when not in use. diff --git a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-bulk.md b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-bulk.md index 89ca63fe8ca..5131d9080d4 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-bulk.md +++ b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-bulk.md @@ -336,14 +336,13 @@ Status | Description `RETRY` | Message to be retried by Dapr `DROP` | Warning is logged and message is dropped -Please refer [Expected HTTP Response for Bulk Subscribe]({{< ref pubsub_api.md >}}) for further insights on response. +Refer to [Expected HTTP Response for Bulk Subscribe]({{< ref pubsub_api.md >}}) for further insights on response. ### Example -Please refer following code samples for how to use Bulk Subscribe: - -{{< tabs "Java" "JavaScript" ".NET" >}} +The following code examples demonstrate how to use Bulk Subscribe. +{{< tabs "Java" "JavaScript" ".NET" "Python" >}} {{% codetab %}} ```java @@ -471,7 +470,50 @@ public class BulkMessageController : ControllerBase {{% /codetab %}} +{{% codetab %}} +Currently, you can only bulk subscribe in Python using an HTTP client. + +```python +import json +from flask import Flask, request, jsonify + +app = Flask(__name__) + +@app.route('/dapr/subscribe', methods=['GET']) +def subscribe(): + # Define the bulk subscribe configuration + subscriptions = [{ + "pubsubname": "pubsub", + "topic": "TOPIC_A", + "route": "/checkout", + "bulkSubscribe": { + "enabled": True, + "maxMessagesCount": 3, + "maxAwaitDurationMs": 40 + } + }] + print('Dapr pub/sub is subscribed to: ' + json.dumps(subscriptions)) + return jsonify(subscriptions) + + +# Define the endpoint to handle incoming messages +@app.route('/checkout', methods=['POST']) +def checkout(): + messages = request.json + print(messages) + for message in messages: + print(f"Received message: {message}") + return json.dumps({'success': True}), 200, {'ContentType': 'application/json'} + +if __name__ == '__main__': + app.run(port=5000) + +``` + +{{% /codetab %}} + {{< /tabs >}} + ## How components handle publishing and subscribing to bulk messages For event publish/subscribe, two kinds of network transfers are involved. diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md index 2b37739d15a..a12478250a0 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md @@ -821,7 +821,7 @@ func main() { ctx := context.Background() // Start workflow test - respStart, err := daprClient.StartWorkflowBeta1(ctx, &client.StartWorkflowRequest{ + respStart, err := daprClient.StartWorkflow(ctx, &client.StartWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, WorkflowName: "TestWorkflow", @@ -835,7 +835,7 @@ func main() { fmt.Printf("workflow started with id: %v\n", respStart.InstanceID) // Pause workflow test - err = daprClient.PauseWorkflowBeta1(ctx, &client.PauseWorkflowRequest{ + err = daprClient.PauseWorkflow(ctx, &client.PauseWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -844,7 +844,7 @@ func main() { log.Fatalf("failed to pause workflow: %v", err) } - respGet, err := daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err := daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -859,7 +859,7 @@ func main() { fmt.Printf("workflow paused\n") // Resume workflow test - err = daprClient.ResumeWorkflowBeta1(ctx, &client.ResumeWorkflowRequest{ + err = daprClient.ResumeWorkflow(ctx, &client.ResumeWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -868,7 +868,7 @@ func main() { log.Fatalf("failed to resume workflow: %v", err) } - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -886,7 +886,7 @@ func main() { // Raise Event Test - err = daprClient.RaiseEventWorkflowBeta1(ctx, &client.RaiseEventWorkflowRequest{ + err = daprClient.RaiseEventWorkflow(ctx, &client.RaiseEventWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, EventName: "testEvent", @@ -904,7 +904,7 @@ func main() { fmt.Printf("stage: %d\n", stage) - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -915,7 +915,7 @@ func main() { fmt.Printf("workflow status: %v\n", respGet.RuntimeStatus) // Purge workflow test - err = daprClient.PurgeWorkflowBeta1(ctx, &client.PurgeWorkflowRequest{ + err = daprClient.PurgeWorkflow(ctx, &client.PurgeWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -923,7 +923,7 @@ func main() { log.Fatalf("failed to purge workflow: %v", err) } - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -936,7 +936,7 @@ func main() { fmt.Printf("stage: %d\n", stage) // Terminate workflow test - respStart, err = daprClient.StartWorkflowBeta1(ctx, &client.StartWorkflowRequest{ + respStart, err = daprClient.StartWorkflow(ctx, &client.StartWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, WorkflowName: "TestWorkflow", @@ -950,7 +950,7 @@ func main() { fmt.Printf("workflow started with id: %s\n", respStart.InstanceID) - err = daprClient.TerminateWorkflowBeta1(ctx, &client.TerminateWorkflowRequest{ + err = daprClient.TerminateWorkflow(ctx, &client.TerminateWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -958,7 +958,7 @@ func main() { log.Fatalf("failed to terminate workflow: %v", err) } - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -971,12 +971,12 @@ func main() { fmt.Println("workflow terminated") - err = daprClient.PurgeWorkflowBeta1(ctx, &client.PurgeWorkflowRequest{ + err = daprClient.PurgeWorkflow(ctx, &client.PurgeWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md index 162ec4a4102..8aeeab0b0ff 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md @@ -324,7 +324,7 @@ Manage your workflow using HTTP calls. The example below plugs in the properties To start your workflow with an ID `12345678`, run: ```http -POST http://localhost:3500/v1.0-beta1/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 +POST http://localhost:3500/v1.0/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 ``` Note that workflow instance IDs can only contain alphanumeric characters, underscores, and dashes. @@ -334,7 +334,7 @@ Note that workflow instance IDs can only contain alphanumeric characters, unders To terminate your workflow with an ID `12345678`, run: ```http -POST http://localhost:3500/v1.0-beta1/workflows/dapr/12345678/terminate +POST http://localhost:3500/v1.0/workflows/dapr/12345678/terminate ``` ### Raise an event @@ -342,7 +342,7 @@ POST http://localhost:3500/v1.0-beta1/workflows/dapr/12345678/terminate For workflow components that support subscribing to external events, such as the Dapr Workflow engine, you can use the following "raise event" API to deliver a named event to a specific workflow instance. ```http -POST http://localhost:3500/v1.0-beta1/workflows///raiseEvent/ +POST http://localhost:3500/v1.0/workflows///raiseEvent/ ``` > An `eventName` can be any function. @@ -352,13 +352,13 @@ POST http://localhost:3500/v1.0-beta1/workflows//}}). diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md index ba3ab432f1b..24db5b49252 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md @@ -647,7 +647,7 @@ The Dapr workflow HTTP API supports the asynchronous request-reply pattern out-o The following `curl` commands illustrate how the workflow APIs support this pattern. ```bash -curl -X POST http://localhost:3500/v1.0-beta1/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 -d '{"Name":"Paperclips","Quantity":1,"TotalCost":9.95}' +curl -X POST http://localhost:3500/v1.0/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 -d '{"Name":"Paperclips","Quantity":1,"TotalCost":9.95}' ``` The previous command will result in the following response JSON: @@ -659,7 +659,7 @@ The previous command will result in the following response JSON: The HTTP client can then construct the status query URL using the workflow instance ID and poll it repeatedly until it sees the "COMPLETE", "FAILURE", or "TERMINATED" status in the payload. ```bash -curl http://localhost:3500/v1.0-beta1/workflows/dapr/12345678 +curl http://localhost:3500/v1.0/workflows/dapr/12345678 ``` The following is an example of what an in-progress workflow status might look like. @@ -1365,7 +1365,7 @@ func raiseEvent() { if err != nil { log.Fatalf("failed to initialize the client") } - err = daprClient.RaiseEventWorkflowBeta1(context.Background(), &client.RaiseEventWorkflowRequest{ + err = daprClient.RaiseEventWorkflow(context.Background(), &client.RaiseEventWorkflowRequest{ InstanceID: "instance_id", WorkflowComponent: "dapr", EventName: "approval_received", diff --git a/daprdocs/content/en/getting-started/quickstarts/actors-quickstart.md b/daprdocs/content/en/getting-started/quickstarts/actors-quickstart.md index a412cc01425..3b7ad206891 100644 --- a/daprdocs/content/en/getting-started/quickstarts/actors-quickstart.md +++ b/daprdocs/content/en/getting-started/quickstarts/actors-quickstart.md @@ -18,7 +18,7 @@ Currently, you can experience this actors quickstart using the .NET SDK. As a quick overview of the .NET actors quickstart: 1. Using a `SmartDevice.Service` microservice, you host: - - Two `SmartDectectorActor` smoke alarm objects + - Two `SmokeDetectorActor` smoke alarm objects - A `ControllerActor` object that commands and controls the smart devices 1. Using a `SmartDevice.Client` console app, the client app interacts with each actor, or the controller, to perform actions in aggregate. 1. The `SmartDevice.Interfaces` contains the shared interfaces and data types used by both the service and client apps. @@ -119,7 +119,7 @@ If you have Zipkin configured for Dapr locally on your machine, you can view the When you ran the client app, a few things happened: -1. Two `SmartDetectorActor` actors were [created in the client application](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/client/Program.cs) and initialized with object state with: +1. Two `SmokeDetectorActor` actors were [created in the client application](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/client/Program.cs) and initialized with object state with: - `ActorProxy.Create(actorId, actorType)` - `proxySmartDevice.SetDataAsync(data)` @@ -177,7 +177,7 @@ When you ran the client app, a few things happened: Console.WriteLine($"Device 2 state: {storedDeviceData2}"); ``` -1. The [`DetectSmokeAsync` method of `SmartDetectorActor 1` is called](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/service/SmokeDetectorActor.cs#L70). +1. The [`DetectSmokeAsync` method of `SmokeDetectorActor 1` is called](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/service/SmokeDetectorActor.cs#L70). ```csharp public async Task DetectSmokeAsync() @@ -216,7 +216,7 @@ When you ran the client app, a few things happened: await proxySmartDevice1.DetectSmokeAsync(); ``` -1. The [`SoundAlarm` methods](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/service/SmokeDetectorActor.cs#L78) of `SmartDetectorActor 1` and `2` are called. +1. The [`SoundAlarm` methods](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/service/SmokeDetectorActor.cs#L78) of `SmokeDetectorActor 1` and `2` are called. ```csharp storedDeviceData1 = await proxySmartDevice1.GetDataAsync(); @@ -234,9 +234,9 @@ When you ran the client app, a few things happened: For full context of the sample, take a look at the following code: -- [`SmartDetectorActor.cs`](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/service/SmokeDetectorActor.cs): Implements the smart device actors +- [`SmokeDetectorActor.cs`](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/service/SmokeDetectorActor.cs): Implements the smart device actors - [`ControllerActor.cs`](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/service/ControllerActor.cs): Implements the controller actor that manages all devices -- [`ISmartDevice`](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/interfaces/ISmartDevice.cs): The method definitions and shared data types for each `SmartDetectorActor` +- [`ISmartDevice`](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/interfaces/ISmartDevice.cs): The method definitions and shared data types for each `SmokeDetectorActor` - [`IController`](https://github.com/dapr/quickstarts/blob/master/actors/csharp/sdk/interfaces/IController.cs): The method definitions and shared data types for the `ControllerActor` {{% /codetab %}} diff --git a/daprdocs/content/en/operations/configuration/api-allowlist.md b/daprdocs/content/en/operations/configuration/api-allowlist.md index b0a02d9bf1f..dffb8db3910 100644 --- a/daprdocs/content/en/operations/configuration/api-allowlist.md +++ b/daprdocs/content/en/operations/configuration/api-allowlist.md @@ -127,7 +127,7 @@ See this list of values corresponding to the different Dapr APIs: | [Configuration]({{< ref configuration_api.md >}}) | `configuration` (`v1.0` and `v1.0-alpha1`) | `configuration` (`v1` and `v1alpha1`) | | [Distributed Lock]({{< ref distributed_lock_api.md >}}) | `lock` (`v1.0-alpha1`)
`unlock` (`v1.0-alpha1`) | `lock` (`v1alpha1`)
`unlock` (`v1alpha1`) | | [Cryptography]({{< ref cryptography_api.md >}}) | `crypto` (`v1.0-alpha1`) | `crypto` (`v1alpha1`) | -| [Workflow]({{< ref workflow_api.md >}}) | `workflows` (`v1.0-alpha1`) |`workflows` (`v1alpha1`) | +| [Workflow]({{< ref workflow_api.md >}}) | `workflows` (`v1.0`) |`workflows` (`v1`) | | [Health]({{< ref health_api.md >}}) | `healthz` (`v1.0`) | n/a | | Shutdown | `shutdown` (`v1.0`) | `shutdown` (`v1`) | diff --git a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-eks.md b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-eks.md index b6e9b774708..6a87484cc36 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-eks.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-eks.md @@ -16,6 +16,7 @@ This guide walks you through installing an Elastic Kubernetes Service (EKS) clus - [AWS CLI](https://aws.amazon.com/cli/) - [eksctl](https://eksctl.io/) - [An existing VPC and subnets](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) + - [Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) ## Deploy an EKS cluster @@ -25,20 +26,57 @@ This guide walks you through installing an Elastic Kubernetes Service (EKS) clus aws configure ``` -1. Create an EKS cluster. To use a specific version of Kubernetes, use `--version` (1.13.x or newer version required). +1. Create a new file called `cluster-config.yaml` and add the content below to it, replacing `[your_cluster_name]`, `[your_cluster_region]`, and `[your_k8s_version]` with the appropriate values: + + ```yaml + apiVersion: eksctl.io/v1alpha5 + kind: ClusterConfig + + metadata: + name: [your_cluster_name] + region: [your_cluster_region] + version: [your_k8s_version] + tags: + karpenter.sh/discovery: [your_cluster_name] + + iam: + withOIDC: true + + managedNodeGroups: + - name: mng-od-4vcpu-8gb + desiredCapacity: 2 + minSize: 1 + maxSize: 5 + instanceType: c5.xlarge + privateNetworking: true + + addons: + - name: vpc-cni + attachPolicyARNs: + - arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy + - name: coredns + version: latest + - name: kube-proxy + version: latest + - name: aws-ebs-csi-driver + wellKnownPolicies: + ebsCSIController: true + ``` + +1. Create the cluster by running the following command: ```bash - eksctl create cluster --name [your_eks_cluster_name] --region [your_aws_region] --version [kubernetes_version] --vpc-private-subnets [subnet_list_seprated_by_comma] --without-nodegroup + eksctl create cluster -f cluster.yaml ``` - - Change the values for `vpc-private-subnets` to meet your requirements. You can also add additional IDs. You must specify at least two subnet IDs. If you'd rather specify public subnets, you can change `--vpc-private-subnets` to `--vpc-public-subnets`. - -1. Verify kubectl context: + +1. Verify the kubectl context: ```bash kubectl config current-context ``` +## Add Dapr requirements for sidecar access and default storage class: + 1. Update the security group rule to allow the EKS cluster to communicate with the Dapr Sidecar by creating an inbound rule for port 4000. ```bash @@ -49,11 +87,37 @@ This guide walks you through installing an Elastic Kubernetes Service (EKS) clus --source-group [your_security_group] ``` +2. Add a default storage class if you don't have one: + + ```bash + kubectl patch storageclass gp2 -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}' + ``` + +## Install Dapr + +Install Dapr on your cluster by running: + +```bash +dapr init -k +``` + +You should see the following response: + +```bash +⌛ Making the jump to hyperspace... +ℹ️ Note: To install Dapr using Helm, see here: https://docs.dapr.io/getting-started/install-dapr-kubernetes/#install-with-helm-advanced + +ℹ️ Container images will be pulled from Docker Hub +✅ Deploying the Dapr control plane with latest version to your cluster... +✅ Deploying the Dapr dashboard with latest version to your cluster... +✅ Success! Dapr has been installed to namespace dapr-system. To verify, run `dapr status -k' in your terminal. To get started, go here: https://docs.dapr.io/getting-started +``` + ## Troubleshooting ### Access permissions -If you face any access permissions, make sure you are using the same AWS profile that was used to create the cluster. If needed, update the kubectl configuration with the correct profile: +If you face any access permissions, make sure you are using the same AWS profile that was used to create the cluster. If needed, update the kubectl configuration with the correct profile. More information [here](https://repost.aws/knowledge-center/eks-api-server-unauthorized-error): ```bash aws eks --region [your_aws_region] update-kubeconfig --name [your_eks_cluster_name] --profile [your_profile_name] diff --git a/daprdocs/content/en/operations/observability/_index.md b/daprdocs/content/en/operations/observability/_index.md index fbbd1abbeb0..4fc85c257fb 100644 --- a/daprdocs/content/en/operations/observability/_index.md +++ b/daprdocs/content/en/operations/observability/_index.md @@ -6,7 +6,7 @@ weight: 60 description: See and measure the message calls to components and between networked services --- -[The following overview video and demo](https://www.youtube.com/live/0y7ne6teHT4?si=3bmNSSyIEIVSF-Ej&t=9931) demonstrates how observability in Dapr works. +[The following overview video and demo](https://www.youtube.com/watch?v=0y7ne6teHT4&t=12652s) demonstrates how observability in Dapr works. diff --git a/daprdocs/content/en/operations/resiliency/policies.md b/daprdocs/content/en/operations/resiliency/policies.md index 73e225167e4..38dd97d832a 100644 --- a/daprdocs/content/en/operations/resiliency/policies.md +++ b/daprdocs/content/en/operations/resiliency/policies.md @@ -49,6 +49,15 @@ The following retry options are configurable: | `duration` | Determines the time interval between retries. Only applies to the `constant` policy.
Valid values are of the form `200ms`, `15s`, `2m`, etc.
Defaults to `5s`.| | `maxInterval` | Determines the maximum interval between retries to which the `exponential` back-off policy can grow.
Additional retries always occur after a duration of `maxInterval`. Defaults to `60s`. Valid values are of the form `5s`, `1m`, `1m30s`, etc | | `maxRetries` | The maximum number of retries to attempt.
`-1` denotes an unlimited number of retries, while `0` means the request will not be retried (essentially behaving as if the retry policy were not set).
Defaults to `-1`. | +| `matching.httpStatusCodes` | Optional: a comma-separated string of HTTP status codes or code ranges to retry. Status codes not listed are not retried.
Valid values: 100-599, [Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)
Format: `` or range `-`
Example: "429,501-503"
Default: empty string `""` or field is not set. Retries on all HTTP errors. | +| `matching.gRPCStatusCodes` | Optional: a comma-separated string of gRPC status codes or code ranges to retry. Status codes not listed are not retried.
Valid values: 0-16, [Reference](https://grpc.io/docs/guides/status-codes/)
Format: `` or range `-`
Example: "1,501-503"
Default: empty string `""` or field is not set. Retries on all gRPC errors. | + + +{{% alert title="httpStatusCodes and gRPCStatusCodes format" color="warning" %}} +The field values should follow the format as specified in the field description or in the "Example 2" below. +An incorrectly formatted value will produce an error log ("Could not read resiliency policy") and `daprd` startup sequence will proceed. +{{% /alert %}} + The exponential back-off window uses the following formula: @@ -77,7 +86,20 @@ spec: maxRetries: -1 # Retry indefinitely ``` +Example 2: +```yaml +spec: + policies: + retries: + retry5xxOnly: + policy: constant + duration: 5s + maxRetries: 3 + matches: + httpStatusCodes: "429,500-599" # retry the HTTP status codes in this range. All others are not retried. + gRPCStatusCodes: "1-4,8-11,13,14" # retry gRPC status codes in these ranges and separate single codes. +``` ## Circuit Breakers diff --git a/daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md b/daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md index 50dc764c849..995f622878a 100644 --- a/daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md +++ b/daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md @@ -68,6 +68,7 @@ After announcing a future breaking change, the change will happen in 2 releases | Hazelcast PubSub Component | 1.9.0 | 1.11.0 | | Twitter Binding Component | 1.10.0 | 1.11.0 | | NATS Streaming PubSub Component | 1.11.0 | 1.13.0 | +| Workflows API Alpha1 `/v1.0-alpha1/workflows` being deprecated in favor of Workflow Client | 1.15.0 | 1.17.0 | ## Related links diff --git a/daprdocs/content/en/reference/api/pubsub_api.md b/daprdocs/content/en/reference/api/pubsub_api.md index f536771083e..8fbf0f615ba 100644 --- a/daprdocs/content/en/reference/api/pubsub_api.md +++ b/daprdocs/content/en/reference/api/pubsub_api.md @@ -302,7 +302,7 @@ other | warning is logged and all messages to be retried ## Message envelope -Dapr pub/sub adheres to version 1.0 of CloudEvents. +Dapr pub/sub adheres to [version 1.0 of CloudEvents](https://github.com/cloudevents/spec/blob/v1.0/spec.md). ## Related links diff --git a/daprdocs/content/en/reference/api/workflow_api.md b/daprdocs/content/en/reference/api/workflow_api.md index 91a19d86407..9236fbfce08 100644 --- a/daprdocs/content/en/reference/api/workflow_api.md +++ b/daprdocs/content/en/reference/api/workflow_api.md @@ -17,7 +17,7 @@ Dapr provides users with the ability to interact with workflows and comes with a Start a workflow instance with the given name and optionally, an instance ID. ``` -POST http://localhost:3500/v1.0-beta1/workflows///start[?instanceID=] +POST http://localhost:3500/v1.0/workflows///start[?instanceID=] ``` Note that workflow instance IDs can only contain alphanumeric characters, underscores, and dashes. @@ -57,7 +57,7 @@ The API call will provide a response similar to this: Terminate a running workflow instance with the given name and instance ID. ``` -POST http://localhost:3500/v1.0-beta1/workflows///terminate +POST http://localhost:3500/v1.0/workflows///terminate ``` {{% alert title="Note" color="primary" %}} @@ -91,7 +91,7 @@ This API does not return any content. For workflow components that support subscribing to external events, such as the Dapr Workflow engine, you can use the following "raise event" API to deliver a named event to a specific workflow instance. ``` -POST http://localhost:3500/v1.0-beta1/workflows///raiseEvent/ +POST http://localhost:3500/v1.0/workflows///raiseEvent/ ``` {{% alert title="Note" color="primary" %}} @@ -124,7 +124,7 @@ None. Pause a running workflow instance. ``` -POST http://localhost:3500/v1.0-beta1/workflows///pause +POST http://localhost:3500/v1.0/workflows///pause ``` ### URL parameters @@ -151,7 +151,7 @@ None. Resume a paused workflow instance. ``` -POST http://localhost:3500/v1.0-beta1/workflows///resume +POST http://localhost:3500/v1.0/workflows///resume ``` ### URL parameters @@ -178,7 +178,7 @@ None. Purge the workflow state from your state store with the workflow's instance ID. ``` -POST http://localhost:3500/v1.0-beta1/workflows///purge +POST http://localhost:3500/v1.0/workflows///purge ``` {{% alert title="Note" color="primary" %}} @@ -209,7 +209,7 @@ None. Get information about a given workflow instance. ``` -GET http://localhost:3500/v1.0-beta1/workflows// +GET http://localhost:3500/v1.0/workflows// ``` ### URL parameters diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md b/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md index ee005b4dda4..be8536f7267 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md @@ -36,6 +36,8 @@ spec: value: "namespace" - name: enableEntityManagement value: "false" + - name: enableInOrderMessageDelivery + value: "false" # The following four properties are needed only if enableEntityManagement is set to true - name: resourceGroupName value: "test-rg" @@ -71,7 +73,8 @@ The above example uses secrets as plain strings. It is recommended to use a secr | `eventHub` | Y* | Input/Output | The name of the Event Hubs hub ("topic"). Required if using Microsoft Entra ID authentication or if the connection string doesn't contain an `EntityPath` value | `mytopic` | | `connectionString` | Y* | Input/Output | Connection string for the Event Hub or the Event Hub namespace.
* Mutally exclusive with `eventHubNamespace` field.
* Required when not using [Microsoft Entra ID Authentication]({{< ref "authenticating-azure.md" >}}) | `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"` or `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key}"` | `eventHubNamespace` | Y* | Input/Output | The Event Hub Namespace name.
* Mutally exclusive with `connectionString` field.
* Required when using [Microsoft Entra ID Authentication]({{< ref "authenticating-azure.md" >}}) | `"namespace"` -| `enableEntityManagement` | N | Input/Output | Boolean value to allow management of the EventHub namespace and storage account. Default: `false` | `"true", "false"` +| `enableEntityManagement` | N | Input/Output | Boolean value to allow management of the EventHub namespace and storage account. Default: `false` | `"true"`, `"false"` +| `enableInOrderMessageDelivery` | N | Input/Output | Boolean value to allow messages to be delivered in the order in which they were posted. This assumes `partitionKey` is set when publishing or posting to ensure ordering across partitions. Default: `false` | `"true"`, `"false"` | `resourceGroupName` | N | Input/Output | Name of the resource group the Event Hub namespace is part of. Required when entity management is enabled | `"test-rg"` | `subscriptionID` | N | Input/Output | Azure subscription ID value. Required when entity management is enabled | `"azure subscription id"` | `partitionCount` | N | Input/Output | Number of partitions for the new Event Hub namespace. Used only when entity management is enabled. Default: `"1"` | `"2"` diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md index 75b1b758c2b..c6f71888370 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md @@ -468,7 +468,7 @@ Apache Kafka supports the following bulk metadata options: When invoking the Kafka pub/sub, its possible to provide an optional partition key by using the `metadata` query param in the request url. -The param name is `partitionKey`. +The param name can either be `partitionKey` or `__key` Example: @@ -484,7 +484,7 @@ curl -X POST http://localhost:3500/v1.0/publish/myKafka/myTopic?metadata.partiti ### Message headers -All other metadata key/value pairs (that are not `partitionKey`) are set as headers in the Kafka message. Here is an example setting a `correlationId` for the message. +All other metadata key/value pairs (that are not `partitionKey` or `__key`) are set as headers in the Kafka message. Here is an example setting a `correlationId` for the message. ```shell curl -X POST http://localhost:3500/v1.0/publish/myKafka/myTopic?metadata.correlationId=myCorrelationID&metadata.partitionKey=key1 \ @@ -495,7 +495,51 @@ curl -X POST http://localhost:3500/v1.0/publish/myKafka/myTopic?metadata.correla } }' ``` +### Kafka Pubsub special message headers received on consumer side +When consuming messages, special message metadata are being automatically passed as headers. These are: +- `__key`: the message key if available +- `__topic`: the topic for the message +- `__partition`: the partition number for the message +- `__offset`: the offset of the message in the partition +- `__timestamp`: the timestamp for the message + +You can access them within the consumer endpoint as follows: +{{< tabs "Python (FastAPI)" >}} + +{{% codetab %}} + +```python +from fastapi import APIRouter, Body, Response, status +import json +import sys + +app = FastAPI() + +router = APIRouter() + + +@router.get('/dapr/subscribe') +def subscribe(): + subscriptions = [{'pubsubname': 'pubsub', + 'topic': 'my-topic', + 'route': 'my_topic_subscriber', + }] + return subscriptions + +@router.post('/my_topic_subscriber') +def my_topic_subscriber( + key: Annotated[str, Header(alias="__key")], + offset: Annotated[int, Header(alias="__offset")], + event_data=Body()): + print(f"key={key} - offset={offset} - data={event_data}", flush=True) + return Response(status_code=status.HTTP_200_OK) + +app.include_router(router) + +``` + +{{% /codetab %}} ## Receiving message headers with special characters The consumer application may be required to receive message headers that include special characters, which may cause HTTP protocol validation errors. diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md index 713bdb1cbb7..73db174a0da 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md @@ -33,6 +33,8 @@ spec: value: "channel1" - name: enableEntityManagement value: "false" + - name: enableInOrderMessageDelivery + value: "false" # The following four properties are needed only if enableEntityManagement is set to true - name: resourceGroupName value: "test-rg" @@ -65,11 +67,12 @@ The above example uses secrets as plain strings. It is recommended to use a secr | `connectionString` | Y* | Connection string for the Event Hub or the Event Hub namespace.
* Mutally exclusive with `eventHubNamespace` field.
* Required when not using [Microsoft Entra ID Authentication]({{< ref "authenticating-azure.md" >}}) | `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"` or `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key}"` | `eventHubNamespace` | Y* | The Event Hub Namespace name.
* Mutally exclusive with `connectionString` field.
* Required when using [Microsoft Entra ID Authentication]({{< ref "authenticating-azure.md" >}}) | `"namespace"` | `consumerID` | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). [See all of template tags you can use in your component metadata.]({{< ref "component-schema.md#templated-metadata-values" >}}) +| `enableEntityManagement` | N | Boolean value to allow management of the EventHub namespace and storage account. Default: `false` | `"true", "false"` +| `enableInOrderMessageDelivery` | N | Input/Output | Boolean value to allow messages to be delivered in the order in which they were posted. This assumes `partitionKey` is set when publishing or posting to ensure ordering across partitions. Default: `false` | `"true"`, `"false"` | `storageAccountName` | Y | Storage account name to use for the checkpoint store. |`"myeventhubstorage"` | `storageAccountKey` | Y* | Storage account key for the checkpoint store account.
* When using Microsoft Entra ID, it's possible to omit this if the service principal has access to the storage account too. | `"112233445566778899"` | `storageConnectionString` | Y* | Connection string for the checkpoint store, alternative to specifying `storageAccountKey` | `"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey="` | `storageContainerName` | Y | Storage container name for the storage account name. | `"myeventhubstoragecontainer"` -| `enableEntityManagement` | N | Boolean value to allow management of the EventHub namespace and storage account. Default: `false` | `"true", "false"` | `resourceGroupName` | N | Name of the resource group the Event Hub namespace is part of. Required when entity management is enabled | `"test-rg"` | `subscriptionID` | N | Azure subscription ID value. Required when entity management is enabled | `"azure subscription id"` | `partitionCount` | N | Number of partitions for the new Event Hub namespace. Used only when entity management is enabled. Default: `"1"` | `"2"` diff --git a/daprdocs/static/images/actors-quickstart/actors-quickstart.png b/daprdocs/static/images/actors-quickstart/actors-quickstart.png index 1ed1957140d..3769e1171a3 100644 Binary files a/daprdocs/static/images/actors-quickstart/actors-quickstart.png and b/daprdocs/static/images/actors-quickstart/actors-quickstart.png differ diff --git a/daprdocs/static/images/bindings-quickstart/bindings-quickstart.png b/daprdocs/static/images/bindings-quickstart/bindings-quickstart.png index c10bbd38eee..afc3e21cc1e 100644 Binary files a/daprdocs/static/images/bindings-quickstart/bindings-quickstart.png and b/daprdocs/static/images/bindings-quickstart/bindings-quickstart.png differ diff --git a/daprdocs/static/images/configuration-quickstart/configuration-quickstart-flow.png b/daprdocs/static/images/configuration-quickstart/configuration-quickstart-flow.png index 29dc6f44c9e..94310e1feb5 100644 Binary files a/daprdocs/static/images/configuration-quickstart/configuration-quickstart-flow.png and b/daprdocs/static/images/configuration-quickstart/configuration-quickstart-flow.png differ diff --git a/daprdocs/static/images/crypto-quickstart.png b/daprdocs/static/images/crypto-quickstart.png index e6f7fe70fc1..0d315a7d2f0 100644 Binary files a/daprdocs/static/images/crypto-quickstart.png and b/daprdocs/static/images/crypto-quickstart.png differ diff --git a/daprdocs/static/images/pubsub-quickstart/pubsub-diagram.png b/daprdocs/static/images/pubsub-quickstart/pubsub-diagram.png index 21256c81765..dca9a907abb 100644 Binary files a/daprdocs/static/images/pubsub-quickstart/pubsub-diagram.png and b/daprdocs/static/images/pubsub-quickstart/pubsub-diagram.png differ diff --git a/daprdocs/static/images/secretsmanagement-quickstart/secrets-mgmt-quickstart.png b/daprdocs/static/images/secretsmanagement-quickstart/secrets-mgmt-quickstart.png index 643af8ea260..f24c09b1727 100644 Binary files a/daprdocs/static/images/secretsmanagement-quickstart/secrets-mgmt-quickstart.png and b/daprdocs/static/images/secretsmanagement-quickstart/secrets-mgmt-quickstart.png differ diff --git a/daprdocs/static/images/service-invocation-overview.png b/daprdocs/static/images/service-invocation-overview.png index c5b2fe55400..eadef1e6162 100644 Binary files a/daprdocs/static/images/service-invocation-overview.png and b/daprdocs/static/images/service-invocation-overview.png differ diff --git a/daprdocs/static/images/state-management-quickstart.png b/daprdocs/static/images/state-management-quickstart.png index e6606ae97b9..8c07c8a52dd 100644 Binary files a/daprdocs/static/images/state-management-quickstart.png and b/daprdocs/static/images/state-management-quickstart.png differ diff --git a/daprdocs/static/images/workflow-quickstart-overview.png b/daprdocs/static/images/workflow-quickstart-overview.png index d616f210622..7a8ea3e2292 100644 Binary files a/daprdocs/static/images/workflow-quickstart-overview.png and b/daprdocs/static/images/workflow-quickstart-overview.png differ