mirror of https://github.com/dapr/docs.git
Merge pull request #4530 from hhunter-ms/upmerge_02-12
Upmerge - Feb 12
This commit is contained in:
Hannah Hunter
GitHub
commit
870aeac1bf
|
|
@ -20,7 +20,7 @@ Not using CloudEvents disables support for tracing, event deduplication per mess
|
|||
|
||||
To disable CloudEvent wrapping, set the `rawPayload` metadata to `true` as part of the publishing request. This allows subscribers to receive these messages without having to parse the CloudEvent schema.
|
||||
|
||||
{{< tabs curl "Python SDK" "PHP SDK">}}
|
||||
{{< tabs curl ".NET" "Python" "PHP">}}
|
||||
|
||||
{{% codetab %}}
|
||||
```bash
|
||||
|
|
@ -28,6 +28,43 @@ curl -X "POST" http://localhost:3500/v1.0/publish/pubsub/TOPIC_A?metadata.rawPay
|
|||
```
|
||||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
|
||||
```csharp
|
||||
using Dapr.Client;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
builder.Services.AddControllers().AddDapr();
|
||||
|
||||
var app = builder.Build();
|
||||
|
||||
app.MapPost("/publish", async (DaprClient daprClient) =>
|
||||
{
|
||||
var message = new Message(
|
||||
Guid.NewGuid().ToString(),
|
||||
$"Hello at {DateTime.UtcNow}",
|
||||
DateTime.UtcNow
|
||||
);
|
||||
|
||||
await daprClient.PublishEventAsync(
|
||||
"pubsub", // pubsub name
|
||||
"messages", // topic name
|
||||
message, // message data
|
||||
new Dictionary<string, string>
|
||||
{
|
||||
{ "rawPayload", "true" },
|
||||
{ "content-type", "application/json" }
|
||||
}
|
||||
);
|
||||
|
||||
return Results.Ok(message);
|
||||
});
|
||||
|
||||
app.Run();
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
```python
|
||||
from dapr.clients import DaprClient
|
||||
|
|
@ -74,9 +111,52 @@ Dapr apps are also able to subscribe to raw events coming from existing pub/sub
|
|||
|
||||
### Programmatically subscribe to raw events
|
||||
|
||||
When subscribing programmatically, add the additional metadata entry for `rawPayload` so the Dapr sidecar automatically wraps the payloads into a CloudEvent that is compatible with current Dapr SDKs.
|
||||
When subscribing programmatically, add the additional metadata entry for `rawPayload` to allow the subscriber to receive a message that is not wrapped by a CloudEvent. For .NET, this metadata entry is called `isRawPayload`.
|
||||
|
||||
{{< tabs "Python" "PHP SDK" >}}
|
||||
{{< tabs ".NET" "Python" "PHP" >}}
|
||||
|
||||
{{% codetab %}}
|
||||
|
||||
```csharp
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
var app = builder.Build();
|
||||
|
||||
app.MapGet("/dapr/subscribe", () =>
|
||||
{
|
||||
var subscriptions = new[]
|
||||
{
|
||||
new
|
||||
{
|
||||
pubsubname = "pubsub",
|
||||
topic = "messages",
|
||||
route = "/messages",
|
||||
metadata = new Dictionary<string, string>
|
||||
{
|
||||
{ "isRawPayload", "true" },
|
||||
{ "content-type", "application/json" }
|
||||
}
|
||||
}
|
||||
};
|
||||
return Results.Ok(subscriptions);
|
||||
});
|
||||
|
||||
app.MapPost("/messages", async (HttpContext context) =>
|
||||
{
|
||||
using var reader = new StreamReader(context.Request.Body);
|
||||
var json = await reader.ReadToEndAsync();
|
||||
|
||||
Console.WriteLine($"Raw message received: {json}");
|
||||
|
||||
return Results.Ok();
|
||||
});
|
||||
|
||||
app.Run();
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
|
||||
|
|
@ -151,7 +231,7 @@ spec:
|
|||
default: /dsstatus
|
||||
pubsubname: pubsub
|
||||
metadata:
|
||||
rawPayload: "true"
|
||||
isRawPayload: "true"
|
||||
scopes:
|
||||
- app1
|
||||
- app2
|
||||
|
|
@ -161,4 +241,5 @@ scopes:
|
|||
|
||||
- Learn more about [publishing and subscribing messages]({{< ref pubsub-overview.md >}})
|
||||
- List of [pub/sub components]({{< ref supported-pubsub >}})
|
||||
- Read the [API reference]({{< ref pubsub_api.md >}})
|
||||
- Read the [API reference]({{< ref pubsub_api.md >}})
|
||||
- Read the .NET sample on how to [consume Kafka messages without CloudEvents](https://github.com/dapr/samples/pubsub-raw-payload)
|
||||
|
|
@ -80,10 +80,16 @@ In production scenarios, it is recommended to use a solution such as:
|
|||
|
||||
If running on AWS EKS, you can [link an IAM role to a Kubernetes service account](https://docs.aws.amazon.com/eks/latest/userguide/create-service-account-iam-policy-and-role.html), which your pod can use.
|
||||
|
||||
All of these solutions solve the same problem: They allow the Dapr runtime process (or sidecar) to retrive credentials dynamically, so that explicit credentials aren't needed. This provides several benefits, such as automated key rotation, and avoiding having to manage secrets.
|
||||
All of these solutions solve the same problem: They allow the Dapr runtime process (or sidecar) to retrieve credentials dynamically, so that explicit credentials aren't needed. This provides several benefits, such as automated key rotation, and avoiding having to manage secrets.
|
||||
|
||||
Both Kiam and Kube2IAM work by intercepting calls to the [instance metadata service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html).
|
||||
|
||||
### Setting Up Dapr with AWS EKS Pod Identity
|
||||
|
||||
EKS Pod Identities provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances. Instead of creating and distributing your AWS credentials to the containers or using the Amazon EC2 instance’s role, you associate an IAM role with a Kubernetes service account and configure your Pods to use the service account.
|
||||
|
||||
To see a comprehensive example on how to authorize pod access to AWS Secrets Manager from EKS using AWS EKS Pod Identity, [follow the sample in this repository](https://github.com/dapr/samples/tree/master/dapr-eks-podidentity).
|
||||
|
||||
### Use an instance profile when running in stand-alone mode on AWS EC2
|
||||
|
||||
If running Dapr directly on an AWS EC2 instance in stand-alone mode, you can use instance profiles.
|
||||
|
|
@ -130,7 +136,6 @@ On Windows, the environment variable needs to be set before starting the `dapr`
|
|||
|
||||
{{< /tabs >}}
|
||||
|
||||
|
||||
### Authenticate to AWS if using AWS SSO based profiles
|
||||
|
||||
If you authenticate to AWS using [AWS SSO](https://aws.amazon.com/single-sign-on/), some AWS SDKs (including the Go SDK) don't yet support this natively. There are several utilities you can use to "bridge the gap" between AWS SSO-based credentials and "legacy" credentials, such as:
|
||||
|
|
@ -157,7 +162,7 @@ AWS_PROFILE=myprofile awshelper daprd...
|
|||
<!-- windows -->
|
||||
{{% codetab %}}
|
||||
|
||||
On Windows, the environment variable needs to be set before starting the `awshelper` command, doing it inline (like in Linxu/MacOS) is not supported.
|
||||
On Windows, the environment variable needs to be set before starting the `awshelper` command; doing it inline (like in Linux/MacOS) is not supported.
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
|
|
@ -169,4 +174,7 @@ On Windows, the environment variable needs to be set before starting the `awshel
|
|||
|
||||
## Related links
|
||||
|
||||
For more information, see [how the AWS SDK (which Dapr uses) handles credentials](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials).
|
||||
- For more information, see [how the AWS SDK (which Dapr uses) handles credentials](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials).
|
||||
- [EKS Pod Identity Documentation](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html)
|
||||
- [AWS SDK Credentials Configuration](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials)
|
||||
- [Set up an Elastic Kubernetes Service (EKS) cluster](https://docs.dapr.io/operations/hosting/kubernetes/cluster/setup-eks/)
|
||||
|
|
|
|||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
type: docs
|
||||
title: "How to: Integrate using Testcontainers Dapr Module"
|
||||
linkTitle: "Dapr Testcontainers"
|
||||
weight: 3000
|
||||
description: "Use the Dapr Testcontainer module from your Java application"
|
||||
---
|
||||
|
||||
You can use the Testcontainers Dapr Module provided by Diagrid to set up Dapr locally for your Java applications. Simply add the following dependency to your Maven project:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>io.diagrid.dapr</groupId>
|
||||
<artifactId>testcontainers-dapr</artifactId>
|
||||
<version>0.10.x</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
[If you're using Spring Boot, you can also use the Spring Boot Starter.](https://github.com/diagridio/spring-boot-starter-dapr)
|
||||
|
||||
{{< button text="Use the Testcontainers Dapr Module" link="https://github.com/diagridio/testcontainers-dapr" >}}
|
||||
|
|
@ -442,13 +442,11 @@ app.MapPost("/orders", (Order order) =>
|
|||
In the Program.cs file for the `checkout` service, you'll notice there's no need to rewrite your app code to use Dapr's service invocation. You can enable service invocation by simply adding the `dapr-app-id` header, which specifies the ID of the target service.
|
||||
|
||||
```csharp
|
||||
var client = new HttpClient();
|
||||
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
|
||||
var client = DaprClient.CreateInvokeHttpClient(appId: "order-processor");
|
||||
var cts = new CancellationTokenSource();
|
||||
|
||||
client.DefaultRequestHeaders.Add("dapr-app-id", "order-processor");
|
||||
|
||||
var response = await client.PostAsync($"{baseURL}/orders", content);
|
||||
Console.WriteLine("Order passed: " + order);
|
||||
var response = await client.PostAsJsonAsync("/orders", order, cts.Token);
|
||||
Console.WriteLine("Order passed: " + order);
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
|
@ -1092,13 +1090,11 @@ dapr run --app-id checkout --app-protocol http --dapr-http-port 3500 -- dotnet r
|
|||
In the Program.cs file for the `checkout` service, you'll notice there's no need to rewrite your app code to use Dapr's service invocation. You can enable service invocation by simply adding the `dapr-app-id` header, which specifies the ID of the target service.
|
||||
|
||||
```csharp
|
||||
var client = new HttpClient();
|
||||
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
|
||||
var client = DaprClient.CreateInvokeHttpClient(appId: "order-processor");
|
||||
var cts = new CancellationTokenSource();
|
||||
|
||||
client.DefaultRequestHeaders.Add("dapr-app-id", "order-processor");
|
||||
|
||||
var response = await client.PostAsync($"{baseURL}/orders", content);
|
||||
Console.WriteLine("Order passed: " + order);
|
||||
var response = await client.PostAsJsonAsync("/orders", order, cts.Token);
|
||||
Console.WriteLine("Order passed: " + order);
|
||||
```
|
||||
|
||||
### Step 5: Use with Multi-App Run
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ This guide walks you through installing an Elastic Kubernetes Service (EKS) clus
|
|||
1. Create the cluster by running the following command:
|
||||
|
||||
```bash
|
||||
eksctl create cluster -f cluster.yaml
|
||||
eksctl create cluster -f cluster-config.yaml
|
||||
```
|
||||
|
||||
1. Verify the kubectl context:
|
||||
|
|
|
|||
|
|
@ -198,6 +198,44 @@ Entity management is only possible when using [Microsoft Entra ID Authentication
|
|||
|
||||
> Dapr passes the name of the consumer group to the Event Hub, so this is not supplied in the metadata.
|
||||
|
||||
## Receiving custom properties
|
||||
|
||||
By default, Dapr does not forward [custom properties](https://learn.microsoft.com/azure/event-hubs/add-custom-data-event). However, by setting the subscription metadata `requireAllProperties` to `"true"`, you can receive custom properties as HTTP headers.
|
||||
|
||||
```yaml
|
||||
apiVersion: dapr.io/v2alpha1
|
||||
kind: Subscription
|
||||
metadata:
|
||||
name: order-pub-sub
|
||||
spec:
|
||||
topic: orders
|
||||
routes:
|
||||
default: /checkout
|
||||
pubsubname: order-pub-sub
|
||||
metadata:
|
||||
requireAllProperties: "true"
|
||||
```
|
||||
|
||||
The same can be achieved using the Dapr SDK:
|
||||
|
||||
{{< tabs ".NET" >}}
|
||||
|
||||
{{% codetab %}}
|
||||
|
||||
```csharp
|
||||
[Topic("order-pub-sub", "orders")]
|
||||
[TopicMetadata("requireAllProperties", "true")]
|
||||
[HttpPost("checkout")]
|
||||
public ActionResult Checkout(Order order, [FromHeader] int priority)
|
||||
{
|
||||
return Ok();
|
||||
}
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
|
||||
## Subscribing to Azure IoT Hub Events
|
||||
|
||||
Azure IoT Hub provides an [endpoint that is compatible with Event Hubs](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-read-builtin#read-from-the-built-in-endpoint), so the Azure Event Hubs pubsub component can also be used to subscribe to Azure IoT Hub events.
|
||||
|
|
|
|||
Loading…
Reference in New Issue