mirror of https://github.com/dapr/docs.git
Merge branch 'v1.5' into add_tls_for_kafka_pusub
* v1.5: (82 commits) Update middleware-opa.md (#1833) Add succes message for msft docs Update link_validation.yaml Localization Check in Links Validation minor spacing change cupdating for newly stable components Microsoft Docs links should be language neutral Update cosmosdbgremlinapi.md Update cosmosdbgremlinapi.md Update setup-rabbitmq.md changing some missed instances of GA to Stable Update cron.md cosmosdbgremlinapi ouput binding fixed typo in component yaml Update daprdocs/content/en/operations/components/certification-lifecycle.md Update daprdocs/content/en/operations/components/certification-lifecycle.md Update daprdocs/content/en/operations/components/certification-lifecycle.md Update daprdocs/content/en/operations/components/certification-lifecycle.md Update daprdocs/content/en/operations/components/certification-lifecycle.md Update daprdocs/content/en/operations/components/certification-lifecycle.md ... # Conflicts: # daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md
This commit is contained in:
zhangchao
commit
85f4f053fd
|
|
@ -16,6 +16,16 @@ jobs:
|
|||
PYTHON_VER: 3.7
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Check Microsoft URLs do not pin localized versions
|
||||
run: |
|
||||
localized=$(find . -name '*.md' | xargs grep -ol "\.microsoft\.com/[[:alpha:]]\{2\}-[[:alpha:]]\{2\}/") || true
|
||||
if [ -z "$localized" ]; then
|
||||
echo "All Microsoft Docs links ok."
|
||||
else
|
||||
echo "The following files contain links to Microsoft Docs that pin a localized version:"
|
||||
echo $localized
|
||||
exit 1
|
||||
fi
|
||||
- name: Set up Python ${{ env.PYTHON_VER }}
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
|
|
@ -27,3 +37,4 @@ jobs:
|
|||
- name: Check Markdown Files
|
||||
run: |
|
||||
for name in `find . -name "*.md"`; do echo -e "------\n$name" ; mm.py -l $name || exit 1 ;done
|
||||
|
||||
|
|
|
|||
25
README.md
25
README.md
|
|
@ -12,10 +12,10 @@ The Dapr docs handles branching differently than most code repositories. Instead
|
|||
|
||||
The following branches are currently maintained:
|
||||
|
||||
| Branch | Website | Description |
|
||||
|--------|---------|-------------|
|
||||
| [v1.4](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
|
||||
| [v1.5](https://github.com/dapr/docs/tree/v1.5) (pre-release) | https://v1-5.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.5+ go here.
|
||||
| Branch | Website | Description |
|
||||
| ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------ |
|
||||
| [v1.4](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
|
||||
| [v1.5](https://github.com/dapr/docs/tree/v1.5) (pre-release) | https://v1-5.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.5+ go here. |
|
||||
|
||||
For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/contributing-docs/#branch-guidance) document.
|
||||
|
||||
|
|
@ -25,7 +25,7 @@ Before making your first contribution, make sure to review the [contributing sec
|
|||
|
||||
## Overview
|
||||
|
||||
The Dapr docs are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme, hosted on an [Azure Static Web App](https://docs.microsoft.com/en-us/azure/static-web-apps/overview).
|
||||
The Dapr docs are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme, hosted on an [Azure Static Web App](https://docs.microsoft.com/azure/static-web-apps/overview).
|
||||
|
||||
The [daprdocs](./daprdocs) directory contains the hugo project, markdown files, and theme configurations.
|
||||
|
||||
|
|
@ -38,31 +38,43 @@ The [daprdocs](./daprdocs) directory contains the hugo project, markdown files,
|
|||
|
||||
1. Ensure pre-requisites are installed
|
||||
2. Clone this repository
|
||||
|
||||
```sh
|
||||
git clone https://github.com/dapr/docs.git
|
||||
```
|
||||
|
||||
3. Change to daprdocs directory:
|
||||
|
||||
```sh
|
||||
cd ./docs/daprdocs
|
||||
cd ./daprdocs
|
||||
```
|
||||
|
||||
4. Update submodules:
|
||||
|
||||
```sh
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
5. Install npm packages:
|
||||
|
||||
```sh
|
||||
npm install
|
||||
```
|
||||
|
||||
## Run local server
|
||||
|
||||
1. Make sure you're still in the `daprdocs` directory
|
||||
2. Run
|
||||
|
||||
```sh
|
||||
hugo server
|
||||
```
|
||||
|
||||
3. Navigate to `http://localhost:1313/`
|
||||
|
||||
|
||||
## Update docs
|
||||
|
||||
1. Fork repo into your account
|
||||
1. Create new branch
|
||||
1. Commit and push changes to forked branch
|
||||
|
|
@ -70,4 +82,5 @@ hugo server
|
|||
1. Staging site will automatically get created and linked to PR to review and test
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please refer to our [Dapr community code of conduct](https://github.com/dapr/community/blob/master/CODE-OF-CONDUCT.md).
|
||||
|
|
|
|||
|
|
@ -3,6 +3,22 @@ type: docs
|
|||
no_list: true
|
||||
---
|
||||
|
||||
<div class="card-deck">
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title">
|
||||
<img src="/images/daprcon.png" alt="DaprCon logo" width=40>
|
||||
<b> Watch DaprCon sessions on-demand!</b>
|
||||
</h5>
|
||||
<p class="card-text">
|
||||
The first ever DaprCon took place October 19th-20th, 2021. Read this recap and find links to all on-demand content <br></br><i><b>Learn more >></b></i>
|
||||
</p>
|
||||
<a href="https://blog.dapr.io/posts/2021/10/21/thanks-for-a-great-first-daprcon/" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<br></br>
|
||||
# <img src="/images/home-title.png" alt="Dapr Docs" width=400>
|
||||
|
||||
Welcome to the Dapr documentation site!
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ Dapr can be used from any developer framework. Here are some that have been inte
|
|||
|
||||
| Language | Frameworks | Description |
|
||||
|----------|------------|-------------|
|
||||
| [.NET]({{< ref dotnet >}}) | [ASP.NET]({{< ref dotnet-aspnet.md >}}) | Brings stateful routing controllers that respond to pub/sub events from other services. Can also take advantage of [ASP.NET Core gRPC Services](https://docs.microsoft.com/en-us/aspnet/core/grpc/).
|
||||
| [.NET]({{< ref dotnet >}}) | [ASP.NET]({{< ref dotnet-aspnet.md >}}) | Brings stateful routing controllers that respond to pub/sub events from other services. Can also take advantage of [ASP.NET Core gRPC Services](https://docs.microsoft.com/aspnet/core/grpc/).
|
||||
| [Java]({{< ref java >}}) | [Spring Boot](https://spring.io/)
|
||||
| [Python]({{< ref python >}}) | [Flask]({{< ref python-flask.md >}})
|
||||
| [Javascript](https://github.com/dapr/js-sdk) | [Express](http://expressjs.com/)
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ Dapr uses the configured authentication method to authenticate with the underlyi
|
|||
|
||||
When deploying on Kubernetes, you can use regular [Kubernetes RBAC]( https://kubernetes.io/docs/reference/access-authn-authz/rbac/) to control access to management activities.
|
||||
|
||||
When deploying on Azure Kubernetes Service (AKS), you can use [Azure Active Directory (AD) service principals]( https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals) to control access to management activities and resource management.
|
||||
When deploying on Azure Kubernetes Service (AKS), you can use [Azure Active Directory (AD) service principals]( https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals) to control access to management activities and resource management.
|
||||
|
||||
## Threat model
|
||||
Threat modeling is a process by which potential threats, such as structural vulnerabilities or the absence of appropriate safeguards, can be identified and enumerated, and mitigations can be prioritized. The Dapr threat model is below.
|
||||
|
|
|
|||
|
|
@ -18,4 +18,4 @@ This page details all of the common terms you may come across in the Dapr docs.
|
|||
| Dapr control plane | A collection of services that are part of a Dapr installation on a hosting platform such as a Kubernetes cluster. This allows Dapr-enabled applications to run on the platform and handles Dapr capabilities such as actor placement, Dapr sidecar injection, or certificate issuance/rollover. | [Self-hosted overview]({{< ref self-hosted-overview >}})<br />[Kubernetes overview]({{< ref kubernetes-overview >}})
|
||||
| Self-hosted | Windows/macOS/Linux machine(s) where you can run your applications with Dapr. Dapr provides the capability to run on machines in "self-hosted" mode. | [Self-hosted mode]({{< ref self-hosted-overview.md >}})
|
||||
| Service | A running application or binary. This can refer to your application or to a Dapr application.
|
||||
| Sidecar | A program that runs alongside your application as a separate process or container. | [Sidecar pattern](https://docs.microsoft.com/en-us/azure/architecture/patterns/sidecar)
|
||||
| Sidecar | A program that runs alongside your application as a separate process or container. | [Sidecar pattern](https://docs.microsoft.com/azure/architecture/patterns/sidecar)
|
||||
|
|
|
|||
|
|
@ -334,6 +334,8 @@ The shortcode would be:
|
|||
|
||||
To create a button in a webpage, use the `button` shortcode.
|
||||
|
||||
An optional "newtab" parameter will indicate if the page should open in a new tab. Options are "true" or "false". Default is "false", where the page will open in the same tab.
|
||||
|
||||
#### Link to an external page
|
||||
|
||||
```
|
||||
|
|
@ -346,10 +348,10 @@ To create a button in a webpage, use the `button` shortcode.
|
|||
|
||||
You can also reference pages in your button as well:
|
||||
```
|
||||
{{</* button text="My Button" page="contributing" */>}}
|
||||
{{</* button text="My Button" page="contributing" newtab="true" */>}}
|
||||
```
|
||||
|
||||
{{< button text="My Button" page="contributing" >}}
|
||||
{{< button text="My Button" page="contributing" newtab="true" >}}
|
||||
|
||||
#### Button colors
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ While your code processes a message, it can send one or more messages to other a
|
|||
|
||||
A large number of actors can execute simultaneously, and actors execute independently from each other.
|
||||
|
||||
Dapr includes a runtime that specifically implements the [Virtual Actor pattern](https://www.microsoft.com/en-us/research/project/orleans-virtual-actors/). With Dapr's implementation, you write your Dapr actors according to the Actor model, and Dapr leverages the scalability and reliability guarantees that the underlying platform provides.
|
||||
Dapr includes a runtime that specifically implements the [Virtual Actor pattern](https://www.microsoft.com/research/project/orleans-virtual-actors/). With Dapr's implementation, you write your Dapr actors according to the Actor model, and Dapr leverages the scalability and reliability guarantees that the underlying platform provides.
|
||||
|
||||
### When to use actors
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ weight: 1000
|
|||
description: "Use Dapr tracing to get visibility for distributed application"
|
||||
---
|
||||
|
||||
Dapr uses the Zipkin protocol for distributed traces and metrics collection. Due to the ubiquity of the Zipkin protocol, many backends are supported out of the box, for examples [Stackdriver](https://cloud.google.com/stackdriver), [Zipkin](https://zipkin.io), [New Relic](https://newrelic.com) and others. Combining with the OpenTelemetry Collector, Dapr can export traces to many other backends including but not limted to [Azure Monitor](https://azure.microsoft.com/en-us/services/monitor/), [Datadog](https://www.datadoghq.com), Instana, [Jaeger](https://www.jaegertracing.io/), and [SignalFX](https://www.signalfx.com/).
|
||||
Dapr uses the Zipkin protocol for distributed traces and metrics collection. Due to the ubiquity of the Zipkin protocol, many backends are supported out of the box, for examples [Stackdriver](https://cloud.google.com/stackdriver), [Zipkin](https://zipkin.io), [New Relic](https://newrelic.com) and others. Combining with the OpenTelemetry Collector, Dapr can export traces to many other backends including but not limted to [Azure Monitor](https://azure.microsoft.com/services/monitor/), [Datadog](https://www.datadoghq.com), Instana, [Jaeger](https://www.jaegertracing.io/), and [SignalFX](https://www.signalfx.com/).
|
||||
|
||||
<img src="/images/tracing.png" width=600>
|
||||
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ client.InvokeService(ctx, &pb.InvokeServiceRequest{
|
|||
|
||||
### Retrieve trace context in C#
|
||||
#### For HTTP calls
|
||||
To retrieve the trace context from HTTP response, you can use [.NET API](https://docs.microsoft.com/en-us/dotnet/api/system.net.http.headers.httpresponseheaders?view=netcore-3.1) :
|
||||
To retrieve the trace context from HTTP response, you can use [.NET API](https://docs.microsoft.com/dotnet/api/system.net.http.headers.httpresponseheaders?view=netcore-3.1) :
|
||||
|
||||
```csharp
|
||||
// client is HttpClient. req is HttpRequestMessage
|
||||
|
|
@ -75,7 +75,7 @@ var response = await call.ResponseAsync;
|
|||
var headers = await call.ResponseHeadersAsync();
|
||||
var tracecontext = headers.First(e => e.Key == "grpc-trace-bin");
|
||||
```
|
||||
Additional general details on calling gRPC services with .NET client [here](https://docs.microsoft.com/en-us/aspnet/core/grpc/client?view=aspnetcore-3.1).
|
||||
Additional general details on calling gRPC services with .NET client [here](https://docs.microsoft.com/aspnet/core/grpc/client?view=aspnetcore-3.1).
|
||||
|
||||
## How to propagate trace context in a request
|
||||
`Note: There are no helper methods exposed in Dapr SDKs to propagate and retrieve trace context. You need to use http/gRPC clients to propagate and retrieve trace headers through http headers and gRPC metadata.`
|
||||
|
|
@ -109,7 +109,7 @@ You can then continuing passing this go context `ctx` in subsequent Dapr gRPC ca
|
|||
|
||||
### Pass trace context in C#
|
||||
#### For HTTP calls
|
||||
To pass trace context in HTTP request, you can use [.NET API](https://docs.microsoft.com/en-us/dotnet/api/system.net.http.headers.httprequestheaders?view=netcore-3.1) :
|
||||
To pass trace context in HTTP request, you can use [.NET API](https://docs.microsoft.com/dotnet/api/system.net.http.headers.httprequestheaders?view=netcore-3.1) :
|
||||
|
||||
```csharp
|
||||
// client is HttpClient. req is HttpRequestMessage
|
||||
|
|
@ -127,7 +127,7 @@ var headers = new Metadata();
|
|||
headers.Add("grpc-trace-bin", tracecontext);
|
||||
using var call = client.InvokeServiceAsync(req, headers);
|
||||
```
|
||||
Additional general details on calling gRPC services with .NET client [here](https://docs.microsoft.com/en-us/aspnet/core/grpc/client?view=aspnetcore-3.1).
|
||||
Additional general details on calling gRPC services with .NET client [here](https://docs.microsoft.com/aspnet/core/grpc/client?view=aspnetcore-3.1).
|
||||
|
||||
## How to create trace context
|
||||
You can create a trace context using the recommended OpenCensus SDKs. OpenCensus supports several different programming languages.
|
||||
|
|
|
|||
|
|
@ -486,6 +486,33 @@ If you want to use your own custom CloudEvent, make sure to specify the content
|
|||
|
||||
Read about content types [here](#content-types), and about the [Cloud Events message format]({{< ref "pubsub-overview.md#cloud-events-message-format" >}}).
|
||||
|
||||
#### Example
|
||||
|
||||
{{< tabs "Dapr CLI" "HTTP API (Bash)" "HTTP API (PowerShell)">}}
|
||||
|
||||
{{% codetab %}}
|
||||
Publish a custom CloudEvent to the `deathStarStatus` topic:
|
||||
```bash
|
||||
dapr publish --publish-app-id testpubsub --pubsub pubsub --topic deathStarStatus --data '{"specversion" : "1.0", "type" : "com.dapr.cloudevent.sent", "source" : "testcloudeventspubsub", "subject" : "Cloud Events Test", "id" : "someCloudEventId", "time" : "2021-08-02T09:00:00Z", "datacontenttype" : "application/cloudevents+json", "data" : {"status": "completed"}}'
|
||||
```
|
||||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
Publish a custom CloudEvent to the `deathStarStatus` topic:
|
||||
```bash
|
||||
curl -X POST http://localhost:3500/v1.0/publish/pubsub/deathStarStatus -H "Content-Type: application/cloudevents+json" -d '{"specversion" : "1.0", "type" : "com.dapr.cloudevent.sent", "source" : "testcloudeventspubsub", "subject" : "Cloud Events Test", "id" : "someCloudEventId", "time" : "2021-08-02T09:00:00Z", "datacontenttype" : "application/cloudevents+json", "data" : {"status": "completed"}}'
|
||||
```
|
||||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
Publish a custom CloudEvent to the `deathStarStatus` topic:
|
||||
```powershell
|
||||
Invoke-RestMethod -Method Post -ContentType 'application/cloudevents+json' -Body '{"specversion" : "1.0", "type" : "com.dapr.cloudevent.sent", "source" : "testcloudeventspubsub", "subject" : "Cloud Events Test", "id" : "someCloudEventId", "time" : "2021-08-02T09:00:00Z", "datacontenttype" : "application/cloudevents+json", "data" : {"status": "completed"}}' -Uri 'http://localhost:3500/v1.0/publish/pubsub/deathStarStatus'
|
||||
```
|
||||
{{% /codetab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
|
||||
## Next steps
|
||||
|
||||
- Try the [Pub/Sub quickstart sample](https://github.com/dapr/quickstarts/tree/master/pub-sub)
|
||||
|
|
@ -494,4 +521,4 @@ Read about content types [here](#content-types), and about the [Cloud Events mes
|
|||
- Learn about [message time-to-live]({{< ref pubsub-message-ttl.md >}})
|
||||
- Learn [how to configure Pub/Sub components with multiple namespaces]({{< ref pubsub-namespaces.md >}})
|
||||
- List of [pub/sub components]({{< ref setup-pubsub >}})
|
||||
- Read the [API reference]({{< ref pubsub_api.md >}})
|
||||
- Read the [API reference]({{< ref pubsub_api.md >}})
|
||||
|
|
@ -22,7 +22,7 @@ When message time-to-live has native support in the pub/sub component, Dapr simp
|
|||
|
||||
#### Azure Service Bus
|
||||
|
||||
Azure Service Bus supports [entity level time-to-live](https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-expiration). This means that messages have a default time-to-live but can also be set with a shorter timespan at publishing time. Dapr propagates the time-to-live metadata for the message and lets Azure Service Bus handle the expiration directly.
|
||||
Azure Service Bus supports [entity level time-to-live](https://docs.microsoft.com/azure/service-bus-messaging/message-expiration). This means that messages have a default time-to-live but can also be set with a shorter timespan at publishing time. Dapr propagates the time-to-live metadata for the message and lets Azure Service Bus handle the expiration directly.
|
||||
|
||||
## Non-Dapr subscribers
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Applications can use the secrets API to access secrets from a Kubernetes secret
|
|||
|
||||
<img src="/images/secrets-overview-kubernetes-store.png" width=600>
|
||||
|
||||
In Azure Dapr can be configured to use Managed Identities to authenticate with Azure Key Vault in order to retrieve secrets. In the example below, an Azure Kubernetes Service (AKS) cluster is configured to use managed identities. Then Dapr uses [pod identities](https://docs.microsoft.com/en-us/azure/aks/operator-best-practices-identity#use-pod-identities) to retrieve secrets from Azure Key Vault on behalf of the application.
|
||||
In Azure Dapr can be configured to use Managed Identities to authenticate with Azure Key Vault in order to retrieve secrets. In the example below, an Azure Kubernetes Service (AKS) cluster is configured to use managed identities. Then Dapr uses [pod identities](https://docs.microsoft.com/azure/aks/operator-best-practices-identity#use-pod-identities) to retrieve secrets from Azure Key Vault on behalf of the application.
|
||||
|
||||
<img src="/images/secrets-overview-azure-aks-keyvault.png" width=600>
|
||||
|
||||
|
|
|
|||
|
|
@ -8,13 +8,13 @@ description: "Use Azure Cosmos DB as a backend state store"
|
|||
|
||||
Dapr doesn't transform state values while saving and retrieving states. Dapr requires all state store implementations to abide by a certain key format scheme (see [Dapr state management spec]({{< ref state_api.md >}}). You can directly interact with the underlying store to manipulate the state data, such querying states, creating aggregated views and making backups.
|
||||
|
||||
> **NOTE:** Azure Cosmos DB is a multi-modal database that supports multiple APIs. The default Dapr Cosmos DB state store implementation uses the [Azure Cosmos DB SQL API](https://docs.microsoft.com/en-us/azure/cosmos-db/sql-query-getting-started).
|
||||
> **NOTE:** Azure Cosmos DB is a multi-modal database that supports multiple APIs. The default Dapr Cosmos DB state store implementation uses the [Azure Cosmos DB SQL API](https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started).
|
||||
|
||||
## 1. Connect to Azure Cosmos DB
|
||||
|
||||
The easiest way to connect to your Cosmos DB instance is to use the Data Explorer on [Azure Management Portal](https://portal.azure.com). Alternatively, you can use [various SDKs and tools](https://docs.microsoft.com/en-us/azure/cosmos-db/mongodb-introduction).
|
||||
The easiest way to connect to your Cosmos DB instance is to use the Data Explorer on [Azure Management Portal](https://portal.azure.com). Alternatively, you can use [various SDKs and tools](https://docs.microsoft.com/azure/cosmos-db/mongodb-introduction).
|
||||
|
||||
> **NOTE:** The following samples use Cosmos DB [SQL API](https://docs.microsoft.com/en-us/azure/cosmos-db/sql-query-getting-started). When you configure an Azure Cosmos DB for Dapr, you need to specify the exact database and collection to use. The follow samples assume you've already connected to the right database and a collection named "states".
|
||||
> **NOTE:** The following samples use Cosmos DB [SQL API](https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started). When you configure an Azure Cosmos DB for Dapr, you need to specify the exact database and collection to use. The follow samples assume you've already connected to the right database and a collection named "states".
|
||||
|
||||
## 2. List keys by App ID
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,6 @@ description: "Publish APIs for Dapr services and components through Azure API Ma
|
|||
weight: 6000
|
||||
---
|
||||
|
||||
Azure API Management (APIM) is a way to create consistent and modern API gateways for back-end services, including as those built with Dapr. Dapr support can be enabled in self-hosted API Management gateways to allow them to forward requests to Dapr services, send messages to Dapr Pub/Sub topics, or trigger Dapr output bindings. For more information, read the guide on [API Management Dapr Integration policies](https://docs.microsoft.com/en-us/azure/api-management/api-management-dapr-policies) and try out the [Dapr & Azure API Management Integration Demo](https://github.com/dapr/samples/tree/master/dapr-apim-integration).
|
||||
Azure API Management (APIM) is a way to create consistent and modern API gateways for back-end services, including as those built with Dapr. Dapr support can be enabled in self-hosted API Management gateways to allow them to forward requests to Dapr services, send messages to Dapr Pub/Sub topics, or trigger Dapr output bindings. For more information, read the guide on [API Management Dapr Integration policies](https://docs.microsoft.com/azure/api-management/api-management-dapr-policies) and try out the [Dapr & Azure API Management Integration Demo](https://github.com/dapr/samples/tree/master/dapr-apim-integration).
|
||||
|
||||
{{< button text="Learn more" link="https://docs.microsoft.com/en-us/azure/api-management/api-management-dapr-policies" >}}
|
||||
{{< button text="Learn more" link="https://docs.microsoft.com/azure/api-management/api-management-dapr-policies" >}}
|
||||
|
|
|
|||
|
|
@ -206,7 +206,7 @@ Note that the value above is the ID of the **Service Principal** which is differ
|
|||
|
||||
Keep in mind that the Service Principal that was just created does not have access to any Azure resource by default. Access will need to be granted to each resource as needed, as documented in the docs for the components.
|
||||
|
||||
> Note: this step is different from the [official documentation](https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) as the short-hand commands included there create a Service Principal that has broad read-write access to all Azure resources in your subscription.
|
||||
> Note: this step is different from the [official documentation](https://docs.microsoft.com/cli/azure/create-an-azure-service-principal-azure-cli) as the short-hand commands included there create a Service Principal that has broad read-write access to all Azure resources in your subscription.
|
||||
> Not only doing that would grant our Service Principal more access than you are likely going to desire, but this also applies only to the Azure management plane (Azure Resource Manager, or ARM), which is irrelevant for Dapr anyways (all Azure components are designed to interact with the data plane of various services, and not ARM).
|
||||
|
||||
### Example usage in a Dapr component
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ description: "Learn how to build workflows using Dapr Workflows and Logic Apps"
|
|||
weight: 4000
|
||||
---
|
||||
|
||||
Dapr Workflows is a lightweight host that allows developers to run cloud-native workflows locally, on-premises or any cloud environment using the [Azure Logic Apps](https://docs.microsoft.com/en-us/azure/logic-apps/logic-apps-overview) workflow engine and Dapr.
|
||||
Dapr Workflows is a lightweight host that allows developers to run cloud-native workflows locally, on-premises or any cloud environment using the [Azure Logic Apps](https://docs.microsoft.com/azure/logic-apps/logic-apps-overview) workflow engine and Dapr.
|
||||
|
||||
## Benefits
|
||||
|
||||
|
|
@ -31,21 +31,21 @@ Once a workflow request comes in, Dapr Workflows uses the Logic Apps SDK to exec
|
|||
|
||||
### Supported actions and triggers
|
||||
|
||||
- [HTTP](https://docs.microsoft.com/en-us/azure/connectors/connectors-native-http)
|
||||
- [Schedule](https://docs.microsoft.com/en-us/azure/logic-apps/concepts-schedule-automated-recurring-tasks-workflows)
|
||||
- [Request / Response](https://docs.microsoft.com/en-us/azure/connectors/connectors-native-reqres)
|
||||
- [HTTP](https://docs.microsoft.com/azure/connectors/connectors-native-http)
|
||||
- [Schedule](https://docs.microsoft.com/azure/logic-apps/concepts-schedule-automated-recurring-tasks-workflows)
|
||||
- [Request / Response](https://docs.microsoft.com/azure/connectors/connectors-native-reqres)
|
||||
|
||||
### Supported control workflows
|
||||
|
||||
- [All control workflows](https://docs.microsoft.com/en-us/azure/connectors/apis-list#control-workflow)
|
||||
- [All control workflows](https://docs.microsoft.com/azure/connectors/apis-list#control-workflow)
|
||||
|
||||
### Supported data manipulation
|
||||
|
||||
- [All data operations](https://docs.microsoft.com/en-us/azure/connectors/apis-list#manage-or-manipulate-data)
|
||||
- [All data operations](https://docs.microsoft.com/azure/connectors/apis-list#manage-or-manipulate-data)
|
||||
|
||||
### Not supported
|
||||
|
||||
- [Managed connectors](https://docs.microsoft.com/en-us/azure/connectors/apis-list#managed-connectors)
|
||||
- [Managed connectors](https://docs.microsoft.com/azure/connectors/apis-list#managed-connectors)
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ Since Dapr supports many pluggable state stores and bindings, the workflow becom
|
|||
Prerequisites:
|
||||
|
||||
1. Install the [Dapr CLI]({{< ref install-dapr-cli.md >}})
|
||||
2. [Azure blob storage account](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-create-account-block-blob?tabs=azure-portal)
|
||||
2. [Azure blob storage account](https://docs.microsoft.com/azure/storage/blobs/storage-blob-create-account-block-blob?tabs=azure-portal)
|
||||
|
||||
### Self-hosted
|
||||
|
||||
|
|
@ -128,7 +128,7 @@ Prerequisites:
|
|||
1. Create a Config Map for the workflow:
|
||||
|
||||
```bash
|
||||
kubectl create configmap workflows --from-file ./samples/workflow1. json
|
||||
kubectl create configmap workflows --from-file ./samples/workflow1.json
|
||||
```
|
||||
|
||||
1. Create a secret containing the Azure Storage Account credentials. Replace the account name and key values below with the actual credentials:
|
||||
|
|
@ -228,4 +228,4 @@ Watch an example from the Dapr community call:
|
|||
## Additional resources
|
||||
|
||||
- [Blog announcement](https://cloudblogs.microsoft.com/opensource/2020/05/26/announcing-cloud-native-workflows-dapr-logic-apps/)
|
||||
- [Repo](https://github.com/dapr/workflows)
|
||||
- [Repo](https://github.com/dapr/workflows)
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ Welcome to the Dapr getting started guide!
|
|||
|
||||
{{% alert title="Dapr Concepts" color="primary" %}}
|
||||
If you are looking for an introductory overview of Dapr and learn more about basic Dapr terminology, it is recommended to visit the [concepts section]({{<ref concepts>}}).
|
||||
{{< button text="Learn more" page="concepts" >}}
|
||||
{{% /alert %}}
|
||||
|
||||
This guide will walk you through a series of steps to install, initialize and start using Dapr. The recommended way to get started with Dapr is to setup a local development environment (also referred to as [_self-hosted_ mode]({{< ref self-hosted >}})) which includes the Dapr CLI, Dapr sidecar binaries, and some default components that can help you start using Dapr quickly.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ To make sure a component conforms to the standards set by Dapr, there are a set
|
|||
The levels are as follows:
|
||||
- [Alpha](#alpha)
|
||||
- [Beta](#beta)
|
||||
- [General availability (GA)](#general-availability-ga)
|
||||
- [Stable](#stable)
|
||||
|
||||
### Alpha
|
||||
|
||||
|
|
@ -42,11 +42,16 @@ All components start at the Alpha stage.
|
|||
- The component contains a record of the conformance test result reviewed and approved by Dapr maintainers with specific components-contrib version
|
||||
- Recommended for only non-business-critical uses because of potential for incompatible changes in subsequent releases
|
||||
|
||||
### General Availability (GA)
|
||||
### Stable
|
||||
|
||||
- Has at least two different users using the component in production
|
||||
- A GA component has a maintainer in the Dapr community or the Dapr maintainers
|
||||
- The component is well documented, tested and maintained across multiple versions of components-contrib repo
|
||||
- The component must have component [certification tests](#certification-tests) validating functionality and resiliency
|
||||
- The component is maintained by Dapr maintainers and supported by the community
|
||||
- The component is well documented and tested
|
||||
- A maintainer will address component security, core functionality and test issues according to the Dapr support policy and issue a patch release that includes the patched stable component
|
||||
|
||||
### Previous Generally Available (GA) components
|
||||
|
||||
Any component that was previously certified as GA is allowed into Stable even if the new requirements are not met.
|
||||
|
||||
## Conformance tests
|
||||
|
||||
|
|
@ -66,24 +71,45 @@ To understand more about them see the readme [here](https://github.com/dapr/comp
|
|||
- The tests should validate the functional behavior and robustness of component based on the component specification
|
||||
- All the details needed to reproduce the tests are added as part of the component conformance test documentation
|
||||
|
||||
## Certification tests
|
||||
|
||||
Each stable component in the [components-contrib](https://github.com/dapr/components-contrib) repository must have a certification test plan and automated certification tests validating all features supported by the component via Dapr.
|
||||
|
||||
Test plan for stable components should include the following scenarios:
|
||||
|
||||
- Client reconnection: in case the client library cannot connect to the service for a moment, Dapr sidecar should not require a restart once the service is back online.
|
||||
- Authentication options: validate the component can authenticate with all the supported options.
|
||||
- Validate resource provisioning: validate if the component automatically provisions resources on initialization, if applicable.
|
||||
- All scenarios relevant to the corresponding building block and component.
|
||||
|
||||
The test plan must be approved by a Dapr maintainer and be published in a `README.md` file along with the component code.
|
||||
|
||||
### Test requirements
|
||||
|
||||
- The tests should validate the functional behavior and robustness of the component based on the component specification, reflecting the scenarios from the test plan
|
||||
- The tests must run successfully as part of the continuous integration of the [components-contrib](https://github.com/dapr/components-contrib) repository
|
||||
|
||||
|
||||
## Component certification process
|
||||
|
||||
For a component to be certified tests are run in an environment maintained by the Dapr team.
|
||||
In order for a component to be certified, tests are run in an environment maintained by the Dapr project.
|
||||
|
||||
### New component certification: Alpha->Beta or Beta->GA
|
||||
### New component certification: Alpha->Beta
|
||||
|
||||
For a new component requiring a certification change from Alpha to Beta or Beta to GA, a request for component certification follows these steps:
|
||||
- An issue is created with a request for certification of the component with the current and the new certification levels
|
||||
- A user of a component submits a PR for integrating the component to run with the defined conformance test suite
|
||||
- The user details the environment setup in the issue created, so that a Dapr maintainer can setup the service in a managed environment
|
||||
- After the environment setup is complete, Dapr maintainers review the PR and if approved merges that PR
|
||||
- Dapr maintainers review functional correctness with the test being run in an environment maintained by the Dapr team
|
||||
- Dapr maintainers update the component status document categorized by Dapr Runtime version. This is done as part of the release process in the next release of Dapr runtime
|
||||
|
||||
### Existing GA certified component
|
||||
|
||||
For an existing GA certified component, conformance test should be run against any changes made to component code or the backing service version or the client version.
|
||||
|
||||
In the scenarios where a component version is updated, the component again starts from Alpha stage and then the new component certification is followed for that.
|
||||
For a new component requiring a certification change from Alpha to Beta, a request for component certification follows these steps:
|
||||
- Requestor creates an issue in the [components-contrib](https://github.com/dapr/components-contrib) repository for certification of the component with the current and the new certification levels
|
||||
- Requestor submits a PR to integrate the component with the defined conformance test suite, if not already included
|
||||
- The user details the environment setup in the issue created, so a Dapr maintainer can setup the service in a managed environment
|
||||
- After the environment setup is complete, Dapr maintainers review the PR and if approved merges that PR
|
||||
- Requestor submits a PR in the [docs](https://github.com/dapr/docs) repository, updating the component's certification level
|
||||
|
||||
### New component certification: Beta->Stable
|
||||
|
||||
For a new component requiring a certification change from Beta to Stable, a request for component certification follows these steps:
|
||||
- Requestor creates an issue in the [components-contrib](https://github.com/dapr/components-contrib) repository for certification of the component with the current and the new certification levels
|
||||
- Requestor submits a PR for the test plan as a `README.md` file in the component's source code directory
|
||||
- The requestor details the test environment requirements in the created PR, including any manual steps or credentials needed
|
||||
- A Dapr maintainer reviews the test plan, provides feedback or approves it, and eventually merges the PR
|
||||
- Requestor submits a PR for the automated certification tests, including scripts to provision resources when applicable
|
||||
- After the test environment setup is completed and credentials provisioned, Dapr maintainers review the PR and, if approved, merges the PR
|
||||
- Requestor submits a PR in the [docs](https://github.com/dapr/docs) repository, updating the component's certification level
|
||||
|
|
|
|||
|
|
@ -12,12 +12,12 @@ description: >
|
|||
## Prerequisites
|
||||
|
||||
- [Docker](https://docs.docker.com/install/)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest)
|
||||
|
||||
## Deploy an Azure Kubernetes Service cluster
|
||||
|
||||
This guide walks you through installing an Azure Kubernetes Service cluster. If you need more information, refer to [Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using the Azure CLI](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough)
|
||||
This guide walks you through installing an Azure Kubernetes Service cluster. If you need more information, refer to [Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using the Azure CLI](https://docs.microsoft.com/azure/aks/kubernetes-walkthrough)
|
||||
|
||||
1. Login to Azure
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ description: "Setup a Google Kubernetes Engine cluster"
|
|||
|
||||
### Prerequisites
|
||||
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [Google Cloud SDK](https://cloud.google.com/sdk)
|
||||
|
||||
## Create a new cluster
|
||||
|
|
|
|||
|
|
@ -12,10 +12,10 @@ description: >
|
|||
## Prerequisites
|
||||
|
||||
- [Docker](https://docs.docker.com/install/)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [Minikube](https://minikube.sigs.k8s.io/docs/start/)
|
||||
|
||||
> Note: For Windows, enable Virtualization in BIOS and [install Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v)
|
||||
> Note: For Windows, enable Virtualization in BIOS and [install Hyper-V](https://docs.microsoft.com/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v)
|
||||
|
||||
## Start the Minikube cluster
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ For more information on what is deployed to your Kubernetes cluster read the [Ku
|
|||
## Prerequisites
|
||||
|
||||
- Install [Dapr CLI]({{< ref install-dapr-cli.md >}})
|
||||
- Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- Install [kubectl](https://kubernetes.io/docs/tasks/tools/)
|
||||
- Kubernetes cluster (see below if needed)
|
||||
|
||||
### Create cluster
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ You will need a Kubernetes cluster with Windows nodes. Many Kubernetes providers
|
|||
|
||||
1. Follow your preferred provider's instructions for setting up a cluster with Windows enabled
|
||||
|
||||
- [Setting up Windows on Azure AKS](https://docs.microsoft.com/en-us/azure/aks/windows-container-cli)
|
||||
- [Setting up Windows on Azure AKS](https://docs.microsoft.com/azure/aks/windows-container-cli)
|
||||
- [Setting up Windows on AWS EKS](https://docs.aws.amazon.com/eks/latest/userguide/windows-support.html)
|
||||
- [Setting up Windows on Google Cloud GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster-windows)
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ helm install dapr dapr/dapr --set global.daprControlPlaneOs=windows
|
|||
## Installing Dapr applications
|
||||
|
||||
### Windows applications
|
||||
In order to launch a Dapr application on Windows, you'll first need to create a Docker container with your application installed. For a step by step guide see [Get started: Prep Windows for containers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment). Once you have a docker container with your application, create a deployment YAML file with node affinity set to kubernetes.io/os: windows.
|
||||
In order to launch a Dapr application on Windows, you'll first need to create a Docker container with your application installed. For a step by step guide see [Get started: Prep Windows for containers](https://docs.microsoft.com/virtualization/windowscontainers/quick-start/set-up-environment). Once you have a docker container with your application, create a deployment YAML file with node affinity set to kubernetes.io/os: windows.
|
||||
|
||||
1. Create a deployment YAML
|
||||
|
||||
|
|
@ -162,8 +162,8 @@ helm uninstall dapr
|
|||
## Related links
|
||||
|
||||
- See the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) for examples of more advanced configuration via node affinity
|
||||
- [Get started: Prep Windows for containers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment)
|
||||
- [Setting up a Windows enabled Kubernetes cluster on Azure AKS](https://docs.microsoft.com/en-us/azure/aks/windows-container-cli)
|
||||
- [Get started: Prep Windows for containers](https://docs.microsoft.com/virtualization/windowscontainers/quick-start/set-up-environment)
|
||||
- [Setting up a Windows enabled Kubernetes cluster on Azure AKS](https://docs.microsoft.com/azure/aks/windows-container-cli)
|
||||
- [Setting up a Windows enabled Kubernetes cluster on AWS EKS](https://docs.aws.amazon.com/eks/latest/userguide/windows-support.html)
|
||||
- [Setting up Windows on Google Cloud GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster-windows)
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ Dapr works seamlessly with any user application container image, regardless of i
|
|||
|
||||
The Dapr control-plane and sidecar images come from the [daprio Docker Hub](https://hub.docker.com/u/daprio) container registry, which is a public registry.
|
||||
|
||||
For information about pulling your application images from a private registry, reference the [Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). If you are using Azure Container Registry with Azure Kubernetes Service, reference the [AKS documentation](https://docs.microsoft.com/en-us/azure/aks/cluster-container-registry-integration).
|
||||
For information about pulling your application images from a private registry, reference the [Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). If you are using Azure Container Registry with Azure Kubernetes Service, reference the [AKS documentation](https://docs.microsoft.com/azure/aks/cluster-container-registry-integration).
|
||||
|
||||
|
||||
## Quickstart
|
||||
|
|
|
|||
|
|
@ -49,14 +49,26 @@ Then proceed with the `dapr upgrade --runtime-version {{% dapr-latest-version lo
|
|||
|
||||
From version 1.0.0 onwards, upgrading Dapr using Helm is no longer a disruptive action since existing certificate values will automatically be re-used.
|
||||
|
||||
1. Upgrade Dapr from 1.0.0 (or newer) to any [NEW VERSION] > v1.0.0:
|
||||
1. Upgrade Dapr from 1.0.0 (or newer) to any [NEW VERSION] > 1.0.0:
|
||||
|
||||
*Helm does not handle upgrading CRDs, so you need to perform that manually. CRDs are backward-compatible and should only be installed forward.*
|
||||
|
||||
>Note: The Dapr version is included in the commands below.
|
||||
|
||||
For version {{% dapr-latest-version long="true" %}}:
|
||||
|
||||
```bash
|
||||
kubectl replace -f https://raw.githubusercontent.com/dapr/dapr/v{{% dapr-latest-version long="true" %}}/charts/dapr/crds/components.yaml
|
||||
kubectl replace -f https://raw.githubusercontent.com/dapr/dapr/v{{% dapr-latest-version long="true" %}}/charts/dapr/crds/configuration.yaml
|
||||
kubectl replace -f https://raw.githubusercontent.com/dapr/dapr/v{{% dapr-latest-version long="true" %}}/charts/dapr/crds/subscription.yaml
|
||||
```
|
||||
|
||||
```bash
|
||||
helm repo update
|
||||
```
|
||||
|
||||
```bash
|
||||
helm upgrade dapr dapr/dapr --version [NEW VERSION] --namespace dapr-system --wait
|
||||
helm upgrade dapr dapr/dapr --version {{% dapr-latest-version long="true" %}} --namespace dapr-system --wait
|
||||
```
|
||||
*If you're using a values file, remember to add the `--values` option when running the upgrade command.*
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ description: "How to install Fluentd, Elastic Search, and Kibana to search logs
|
|||
## Prerequisites
|
||||
|
||||
- Kubernetes (> 1.14)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [Helm 3](https://helm.sh/)
|
||||
|
||||
## Install Elastic search and Kibana
|
||||
|
|
|
|||
|
|
@ -94,7 +94,7 @@ If you are using the Azure Kubernetes Service, you can use the default OMS Agent
|
|||
|
||||
If you use [Fluentd](https://www.fluentd.org/), we recommend to using Elastic Search and Kibana. This [how-to]({{< ref fluentd.md >}}) shows how to set up Elastic Search and Kibana in your Kubernetes cluster.
|
||||
|
||||
If you are using the Azure Kubernetes Service, you can use [Azure monitor for containers](https://docs.microsoft.com/en-us/azure/azure-monitor/insights/container-insights-overview) without indstalling any additional monitoring tools. Also read [How to enable Azure Monitor for containers](https://docs.microsoft.com/en-us/azure/azure-monitor/insights/container-insights-onboard)
|
||||
If you are using the Azure Kubernetes Service, you can use [Azure monitor for containers](https://docs.microsoft.com/azure/azure-monitor/insights/container-insights-overview) without indstalling any additional monitoring tools. Also read [How to enable Azure Monitor for containers](https://docs.microsoft.com/azure/azure-monitor/insights/container-insights-onboard)
|
||||
|
||||
## References
|
||||
|
||||
|
|
|
|||
|
|
@ -8,9 +8,9 @@ description: "Enable Dapr metrics and logs with Azure Monitor for Azure Kubernet
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- [Azure Kubernetes Service](https://docs.microsoft.com/en-us/azure/aks/)
|
||||
- [Enable Azure Monitor For containers in AKS](https://docs.microsoft.com/en-us/azure/azure-monitor/insights/container-insights-overview)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- [Azure Kubernetes Service](https://docs.microsoft.com/azure/aks/)
|
||||
- [Enable Azure Monitor For containers in AKS](https://docs.microsoft.com/azure/azure-monitor/insights/container-insights-overview)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [Helm 3](https://helm.sh/)
|
||||
|
||||
## Enable Prometheus metric scrape using config map
|
||||
|
|
@ -127,6 +127,6 @@ InsightsMetrics
|
|||
|
||||
# References
|
||||
|
||||
* [Configure scraping of Prometheus metrics with Azure Monitor for containers](https://docs.microsoft.com/en-us/azure/azure-monitor/insights/container-insights-prometheus-integration)
|
||||
* [Configure agent data collection for Azure Monitor for containers](https://docs.microsoft.com/en-us/azure/azure-monitor/insights/container-insights-agent-config)
|
||||
* [Azure Monitor Query](https://docs.microsoft.com/en-us/azure/azure-monitor/log-query/query-language)
|
||||
* [Configure scraping of Prometheus metrics with Azure Monitor for containers](https://docs.microsoft.com/azure/azure-monitor/insights/container-insights-prometheus-integration)
|
||||
* [Configure agent data collection for Azure Monitor for containers](https://docs.microsoft.com/azure/azure-monitor/insights/container-insights-agent-config)
|
||||
* [Azure Monitor Query](https://docs.microsoft.com/azure/azure-monitor/log-query/query-language)
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ Once Prometheus is running, you'll be able to visit its dashboard by visiting `h
|
|||
### Prerequisites
|
||||
|
||||
- Kubernetes (> 1.14)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [Helm 3](https://helm.sh/)
|
||||
|
||||
### Install Prometheus
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ A installation of Dapr on Kubernetes.
|
|||
### Setup Application Insights
|
||||
|
||||
1. First, you'll need an Azure account. See instructions [here](https://azure.microsoft.com/free/) to apply for a **free** Azure account.
|
||||
2. Follow instructions [here](https://docs.microsoft.com/en-us/azure/azure-monitor/app/create-new-resource) to create a new Application Insights resource.
|
||||
2. Follow instructions [here](https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource) to create a new Application Insights resource.
|
||||
3. Get the Application Insights Intrumentation key from your Application Insights page.
|
||||
|
||||
### Run OpenTelemetry Collector to push to your Application Insights instance
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ The main difference between the two flows is that the `Authorization Code Grant
|
|||
|
||||
Different authorization servers provide different application registration experiences. Here are some samples:
|
||||
|
||||
* [Azure AAD](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code)
|
||||
* [Azure AAD](https://docs.microsoft.com/azure/active-directory/develop/v1-protocols-oauth-code)
|
||||
* [Facebook](https://developers.facebook.com/apps)
|
||||
* [Fitbit](https://dev.fitbit.com/build/reference/web-api/oauth2/)
|
||||
* [GitHub](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/)
|
||||
|
|
|
|||
|
|
@ -42,7 +42,9 @@ The table below shows the versions of Dapr releases that have been tested togeth
|
|||
| Jul 26th 2021 | 1.3</br> | 1.3.0 | Java 1.2.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.2.0 </br>.NET 1.3.0 | 0.7.0 | Supported |
|
||||
| Sep 14th 2021 | 1.3.1</br> | 1.3.0 | Java 1.2.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.2.0 </br>.NET 1.3.0 | 0.7.0 | Supported |
|
||||
| Sep 15th 2021 | 1.4</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported |
|
||||
| Sep 22nd 2021 | 1.4.1</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported (current) |
|
||||
| Sep 22nd 2021 | 1.4.1</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported
|
||||
| Sep 24th 2021 | 1.4.2</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported |
|
||||
| Oct 7th 2021 | 1.4.3</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported (current) |
|
||||
|
||||
## Upgrade paths
|
||||
After the 1.0 release of the runtime there may be situations where it is necessary to explicitly upgrade through an additional release to reach the desired target. For example an upgrade from v1.0 to v1.2 may need go pass through v1.1
|
||||
|
|
@ -56,16 +58,16 @@ General guidance on upgrading can be found for [self hosted mode]({{<ref self-ho
|
|||
| 1.0.0 or 1.0.1 | N/A | 1.1.2 |
|
||||
| | 1.1.2 | 1.2.2 |
|
||||
| | 1.2.2 | 1.3.1 |
|
||||
| | 1.3.1 | 1.4.1 |
|
||||
| | 1.3.1 | 1.4.3 |
|
||||
| 1.1.0 to 1.1.2 | N/A | 1.2.2 |
|
||||
| | 1.2.2 | 1.3.1 |
|
||||
| | 1.3.1 | 1.4.1 |
|
||||
| | 1.3.1 | 1.4.3 |
|
||||
| 1.2.0 to 1.2.2 | N/A | 1.3.1 |
|
||||
| | 1.3.1 | 1.4.1 |
|
||||
| | 1.3.1 | 1.4.3 |
|
||||
| 1.3.0 | N/A | 1.3.1 |
|
||||
| | 1.3.1 | 1.4.1 |
|
||||
| 1.3.1 | N/A | 1.4.1 |
|
||||
| 1.4.0 | N/A | 1.4.1 |
|
||||
| | 1.3.1 | 1.4.3 |
|
||||
| 1.3.1 | N/A | 1.4.3 |
|
||||
| 1.4.0 to 1.4.2 | N/A | 1.4.3 |
|
||||
|
||||
## Feature and deprecations
|
||||
There is a process for announcing feature deprecations. Deprecations are applied two (2) releases after the release in which they were announced. For example Feature X is announced to be deprecated in the 1.0.0 release notes and will then be removed in 1.2.0.
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ Components are implemented in the components-contrib repository and follow a `MA
|
|||
|
||||
The [components-contrib](https://github.com/dapr/components-contrib/) repo release is a flat version across all components inside. That is, a version for the components-contrib repo release is made up of all the schemas for the components inside it. A new version of Dapr does not mean there is a new release of components-contrib if there are no component changes.
|
||||
|
||||
Note: Components have a production usage lifecycle status: Alpha, Beta and GA (stable). These statuses are not related to their versioning. The tables of supported components shows both their versions and their status.
|
||||
Note: Components have a production usage lifecycle status: Alpha, Beta and Stable. These statuses are not related to their versioning. The tables of supported components shows both their versions and their status.
|
||||
* List of [state store components]({{< ref supported-state-stores.md >}})
|
||||
* List of [pub/sub components]({{< ref supported-pubsub.md >}})
|
||||
* List of [secret store components]({{< ref supported-secret-stores.md >}})
|
||||
|
|
|
|||
|
|
@ -226,3 +226,26 @@ In order for mDNS to function properly, ensure `Micorosft Content Filter` is ina
|
|||
Microsoft Content Filter is disabled when the output is "Success".
|
||||
|
||||
> Some organizations will re-enable the filter from time to time. If you repeatedly encounter app-id values missing, first check to see if the filter has been re-enabled before doing more extensive troubleshooting.
|
||||
|
||||
## Admission webhook denied the request
|
||||
|
||||
You may encounter an error similar to the one below due to admission webhook having an allowlist for service accounts to create or modify resources.
|
||||
|
||||
```
|
||||
root:[dapr]$ kubectl run -i --tty --rm debug --image=busybox --restart=Never -- sh
|
||||
Error from server: admission webhook "sidecar-injector.dapr.io" denied the request: service account 'user-xdd5l' not on the list of allowed controller accounts
|
||||
```
|
||||
|
||||
To resolve this error, you should create a `clusterrolebind` for the current user:
|
||||
|
||||
```bash
|
||||
kubectl create clusterrolebinding dapr-<name-of-user> --clusterrole=dapr-operator-admin --user <name-of-user>
|
||||
```
|
||||
|
||||
You can run the below command to get all users in your cluster:
|
||||
|
||||
```bash
|
||||
kubectl config get-users
|
||||
```
|
||||
|
||||
You may learn more about webhooks [here](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/).
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ This table is meant to help users understand the equivalent options for running
|
|||
| `--dapr-grpc-port` | `--dapr-grpc-port` | | not supported | gRPC port for the Dapr API to listen on (default "50001") |
|
||||
| `--dapr-http-port` | `--dapr-http-port` | | not supported | The HTTP port for the Dapr API |
|
||||
|` --dapr-http-max-request-size` | --dapr-http-max-request-size | | `dapr.io/http-max-request-size` | Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is `4` MB |
|
||||
| not supported | `--image` | | not supported
|
||||
| not supported | `--image` | | `dapr.io/sidecar-image` | Dapr sidecar image. Default is `daprio/daprd:latest` |
|
||||
| `--internal-grpc-port` | not supported | | not supported | gRPC port for the Dapr Internal API to listen on |
|
||||
| `--enable-metrics` | not supported | | configuration spec | Enable prometheus metric (default true) |
|
||||
| `--enable-mtls` | not supported | | configuration spec | Enables automatic mTLS for daprd to daprd communication channels |
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Flags:
|
|||
Use "dapr [command] --help" for more information about a command.
|
||||
```
|
||||
|
||||
## Command Reference
|
||||
### Command Reference
|
||||
|
||||
You can learn more about each Dapr command from the links below.
|
||||
|
||||
|
|
@ -72,6 +72,6 @@ You can learn more about each Dapr command from the links below.
|
|||
- [`dapr uninstall`]({{< ref dapr-uninstall.md >}})
|
||||
- [`dapr upgrade`]({{< ref dapr-upgrade.md >}})
|
||||
|
||||
## Environment Variables
|
||||
### Environment Variables
|
||||
|
||||
Some Dapr flags can be set via environment variables (e.g. `DAPR_NETWORK` for the `--network` flag of the `dapr init` command). Note that specifying the flag on the command line overrides any set environment variable.
|
||||
|
|
@ -5,19 +5,20 @@ linkTitle: "build-info"
|
|||
description: "Detailed build information on dapr-cli and daprd executables"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Get the version and git commit data for `dapr-cli` and `daprd` executables.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr build-info
|
||||
```
|
||||
|
||||
## Related facts
|
||||
### Related facts
|
||||
|
||||
You can get `daprd` build information directly by invoking `daprd --build-info` command.
|
||||
|
|
|
|||
|
|
@ -5,60 +5,68 @@ linkTitle: "completion"
|
|||
description: "Detailed information on the completion CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Generates shell completion scripts
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr completion [flags]
|
||||
dapr completion [command]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
|------|----------------------|---------|-------------|
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------- | -------------------- | ------- | ------------------------ |
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Installing bash completion on macOS using Homebrew
|
||||
#### Installing bash completion on macOS using Homebrew
|
||||
|
||||
If running Bash 3.2 included with macOS:
|
||||
|
||||
```bash
|
||||
brew install bash-completion
|
||||
```
|
||||
|
||||
Or, if running Bash 4.1+:
|
||||
|
||||
```bash
|
||||
brew install bash-completion@2
|
||||
```
|
||||
|
||||
Add the completion to your completion directory:
|
||||
|
||||
```bash
|
||||
dapr completion bash > $(brew --prefix)/etc/bash_completion.d/dapr
|
||||
source ~/.bash_profile
|
||||
```
|
||||
|
||||
### Installing bash completion on Linux
|
||||
#### Installing bash completion on Linux
|
||||
|
||||
If bash-completion is not installed on Linux, please install the bash-completion' package via your distribution's package manager.
|
||||
|
||||
Load the dapr completion code for bash into the current shell:
|
||||
|
||||
```bash
|
||||
source <(dapr completion bash)
|
||||
```
|
||||
|
||||
Write bash completion code to a file and source if from .bash_profile:
|
||||
|
||||
```bash
|
||||
dapr completion bash > ~/.dapr/completion.bash.inc
|
||||
printf "source '$HOME/.dapr/completion.bash.inc'" >> $HOME/.bash_profile
|
||||
source $HOME/.bash_profile
|
||||
```
|
||||
|
||||
### Installing zsh completion on macOS using homebrew
|
||||
#### Installing zsh completion on macOS using homebrew
|
||||
|
||||
If zsh-completion is not installed on macOS, please install the 'zsh-completion' package:
|
||||
|
||||
```bash
|
||||
brew install zsh-completions
|
||||
```
|
||||
|
|
@ -69,33 +77,37 @@ dapr completion zsh > "${fpath[1]}/_dapr"
|
|||
source ~/.zshrc
|
||||
```
|
||||
|
||||
### Installing zsh completion on Linux
|
||||
#### Installing zsh completion on Linux
|
||||
|
||||
If zsh-completion is not installed on Linux, please install the 'zsh-completion' package via your distribution's package manager.
|
||||
|
||||
Load the dapr completion code for zsh into the current shell:
|
||||
|
||||
```bash
|
||||
source <(dapr completion zsh)
|
||||
```
|
||||
|
||||
Set the dapr completion code for zsh[1] to autoload on startup:
|
||||
|
||||
```bash
|
||||
dapr completion zsh > "${fpath[1]}/_dapr"
|
||||
```
|
||||
|
||||
### Installing Powershell completion on Windows
|
||||
#### Installing Powershell completion on Windows
|
||||
|
||||
Create $PROFILE if it not exists:
|
||||
|
||||
```bash
|
||||
if (!(Test-Path -Path $PROFILE )){ New-Item -Type File -Path $PROFILE -Force }
|
||||
```
|
||||
|
||||
Add the completion to your profile:
|
||||
|
||||
```bash
|
||||
dapr completion powershell >> $PROFILE
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
### Available Commands
|
||||
|
||||
```txt
|
||||
bash Generates bash completion scripts
|
||||
|
|
|
|||
|
|
@ -5,30 +5,30 @@ linkTitle: "components"
|
|||
description: "Detailed information on the components CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
List all Dapr components.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr components [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | ------------------------------------------------ |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### List Kubernetes components
|
||||
```bash
|
||||
# List Kubernetes components
|
||||
dapr components -k
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,32 +5,32 @@ linkTitle: "configurations"
|
|||
description: "Detailed information on the configurations CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
List all Dapr configurations.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr configurations [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in a Kubernetes cluster
|
||||
| `--name`, `-n` | | | The configuration name to be printed (optional)
|
||||
| `--output`, `-o` | | `list`| Output format (options: json or yaml or list)
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | ---------------------------------------------------- |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in a Kubernetes cluster |
|
||||
| `--name`, `-n` | | | The configuration name to be printed (optional) |
|
||||
| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### List Kubernetes Dapr configurations
|
||||
```bash
|
||||
# List Kubernetes Dapr configurations
|
||||
dapr configurations -k
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,54 +5,47 @@ linkTitle: "dashboard"
|
|||
description: "Detailed information on the dashboard CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Start [Dapr dashboard](https://github.com/dapr/dashboard).
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr dashboard [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
|------|----------------------|---------|-------------|
|
||||
| `--address`, `-a` | | `localhost` | Address to listen on. Only accepts IP address or localhost as a value |
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The namespace where Dapr dashboard is running |
|
||||
| `--port`, `-p` | | `8080` | The local port on which to serve Dapr dashboard |
|
||||
| `--version`, `-v` | | `false` | Print the version for Dapr dashboard |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------------- | --------------------------------------------------------------------------- |
|
||||
| `--address`, `-a` | | `localhost` | Address to listen on. Only accepts IP address or localhost as a value |
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The namespace where Dapr dashboard is running |
|
||||
| `--port`, `-p` | | `8080` | The local port on which to serve Dapr dashboard |
|
||||
| `--version`, `-v` | | `false` | Print the version for Dapr dashboard |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Start dashboard locally
|
||||
```bash
|
||||
# Start dashboard locally
|
||||
dapr dashboard
|
||||
```
|
||||
|
||||
### Start dashboard service locally on a specified port
|
||||
```bash
|
||||
# Start dashboard service locally on a specified port
|
||||
dapr dashboard -p 9999
|
||||
```
|
||||
|
||||
### Port forward to dashboard service running in Kubernetes
|
||||
```bash
|
||||
# Port forward to dashboard service running in Kubernetes
|
||||
dapr dashboard -k
|
||||
```
|
||||
|
||||
### Port forward to dashboard service running in Kubernetes on all addresses on a specified port
|
||||
```bash
|
||||
# Port forward to dashboard service running in Kubernetes on all addresses on a specified port
|
||||
dapr dashboard -k -p 9999 --address 0.0.0.0
|
||||
```
|
||||
|
||||
### Port forward to dashboard service running in Kubernetes on a specified port
|
||||
```bash
|
||||
# Port forward to dashboard service running in Kubernetes on a specified port
|
||||
dapr dashboard -k -p 9999
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,18 +5,18 @@ linkTitle: "help"
|
|||
description: "Detailed information on the help CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Help provides help for any command in the application.
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr help [command] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------- | -------------------- | ------- | ------------------------ |
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
|
|
|
|||
|
|
@ -5,67 +5,70 @@ linkTitle: "init"
|
|||
description: "Detailed information on the init CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Install Dapr on supported hosting platforms.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr init [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--enable-ha` | | `false` | Enable high availability (HA) mode |
|
||||
| `--enable-mtls` | | `true` | Enable mTLS in your cluster |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster |
|
||||
| `--wait` | | `false` | Wait for Kubernetes initialization to complete |
|
||||
| `--timeout` | | `300` | The wait timeout for the Kubernetes installation |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in |
|
||||
| `--network` | `DAPR_NETWORK` | | The Docker network on which to deploy the Dapr runtime |
|
||||
| `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` |
|
||||
| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------------- | ------------------------------------------------------------------------------------ |
|
||||
| `--enable-ha` | | `false` | Enable high availability (HA) mode |
|
||||
| `--enable-mtls` | | `true` | Enable mTLS in your cluster |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster |
|
||||
| `--wait` | | `false` | Wait for Kubernetes initialization to complete |
|
||||
| `--timeout` | | `300` | The wait timeout for the Kubernetes installation |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in |
|
||||
| `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` |
|
||||
| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
#### Self-hosted environment
|
||||
|
||||
### Initialize Dapr in self-hosted mode
|
||||
```bash
|
||||
dapr init
|
||||
```
|
||||
|
||||
### Initialize Dapr in Kubernetes
|
||||
You can also specify a specific runtime version. Be default, the latest version is used.
|
||||
|
||||
```bash
|
||||
dapr init --runtime-version 1.4.0
|
||||
```
|
||||
|
||||
Dapr can also run [Slim self-hosted mode]({{< ref self-hosted-no-docker.md >}}) without Docker.
|
||||
|
||||
```bash
|
||||
dapr init -s
|
||||
```
|
||||
|
||||
#### Kubernetes environment
|
||||
|
||||
```bash
|
||||
dapr init -k
|
||||
```
|
||||
|
||||
### Initialize Dapr in Kubernetes and wait for the installation to complete
|
||||
You can wait for the installation to complete its deployment with the `--wait` flag.
|
||||
The default timeout is 300s (5 min), but can be customized with the `--timeout` flag.
|
||||
|
||||
You can wait for the installation to complete its deployment with the `--wait` flag.
|
||||
|
||||
The default timeout is 300s (5 min), but can be customized with the `--timeout` flag.
|
||||
```bash
|
||||
dapr init -k --wait --timeout 600
|
||||
```
|
||||
|
||||
### Initialize specified version of Dapr runtime in self-hosted mode
|
||||
```bash
|
||||
dapr init --runtime-version 0.10.0
|
||||
```
|
||||
You can also specify a specific runtime version.
|
||||
|
||||
### Initialize specified version of Dapr runtime in Kubernetes
|
||||
```bash
|
||||
dapr init -k --runtime-version 0.10.0
|
||||
```
|
||||
|
||||
### Initialize Dapr in [slim self-hosted mode]({{< ref self-hosted-no-docker.md >}})
|
||||
```bash
|
||||
dapr init -s
|
||||
dapr init -k --runtime-version 1.4.0
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,38 +5,37 @@ linkTitle: "invoke"
|
|||
description: "Detailed information on the invoke CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Invoke a method on a given Dapr application.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr invoke [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--app-id`, `-a` | | | The application id to invoke |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--method`, `-m` | | | The method to invoke |
|
||||
| `--data`, `-d` | | | The JSON serialized data string (optional) |
|
||||
| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional)
|
||||
| `--verb`, `-v` | | `POST` | The HTTP verb to use |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| ------------------- | -------------------- | ------- | ----------------------------------------------------- |
|
||||
| `--app-id`, `-a` | `APP_ID` | | The application id to invoke |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--method`, `-m` | | | The method to invoke |
|
||||
| `--data`, `-d` | | | The JSON serialized data string (optional) |
|
||||
| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) |
|
||||
| `--verb`, `-v` | | `POST` | The HTTP verb to use |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Invoke a sample method on target app with POST Verb
|
||||
```bash
|
||||
# Invoke a sample method on target app with POST Verb
|
||||
dapr invoke --app-id target --method sample --data '{"key":"value"}'
|
||||
```
|
||||
|
||||
### Invoke a sample method on target app with GET Verb
|
||||
```bash
|
||||
# Invoke a sample method on target app with GET Verb
|
||||
dapr invoke --app-id target --method sample --verb GET
|
||||
```
|
||||
```
|
||||
|
|
@ -5,41 +5,38 @@ linkTitle: "list"
|
|||
description: "Detailed information on the list CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
List all Dapr instances.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr list [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster |
|
||||
| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table`
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | --------------------------------------------------------------------------- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster |
|
||||
| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table` |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### List Dapr instances in self-hosted mode
|
||||
```bash
|
||||
# List Dapr instances in self-hosted mode
|
||||
dapr list
|
||||
```
|
||||
|
||||
### List Dapr instances in Kubernetes mode
|
||||
```bash
|
||||
# List Dapr instances in Kubernetes mode
|
||||
dapr list -k
|
||||
```
|
||||
|
||||
### List Dapr instances in JSON format
|
||||
```bash
|
||||
# List Dapr instances in JSON format
|
||||
dapr list -o json
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,33 +5,33 @@ linkTitle: "logs"
|
|||
description: "Detailed information on the logs CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Get Dapr sidecar logs for an application.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr logs [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--app-id`, `-a` | | | The application id for which logs are needed |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `true` | Get logs from a Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `default` | The Kubernetes namespace in which your application is deployed |
|
||||
| `--pod-name`, `-p` | | | The name of the pod in Kubernetes, in case your application has multiple pods (optional) |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | --------- | ---------------------------------------------------------------------------------------- |
|
||||
| `--app-id`, `-a` | `APP_ID` | | The application id for which logs are needed |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `true` | Get logs from a Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `default` | The Kubernetes namespace in which your application is deployed |
|
||||
| `--pod-name`, `-p` | | | The name of the pod in Kubernetes, in case your application has multiple pods (optional) |
|
||||
|
||||
### Examples
|
||||
|
||||
## Examples
|
||||
|
||||
### Get logs of sample app from target pod in custom namespace
|
||||
```bash
|
||||
# Get logs of sample app from target pod in custom namespace
|
||||
dapr logs -k --app-id sample --pod-name target --namespace custom
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,45 +5,45 @@ linkTitle: "mtls"
|
|||
description: "Detailed information on the mtls CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Check if mTLS is enabled.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr mtls [flags]
|
||||
dapr mtls [command]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Check if mTLS is enabled in a Kubernetes cluster |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | ------------------------------------------------ |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Check if mTLS is enabled in a Kubernetes cluster |
|
||||
|
||||
## Available Commands
|
||||
### Available Commands
|
||||
|
||||
```txt
|
||||
expiry Checks the expiry of the root certificate
|
||||
export Export the root CA, issuer cert and key from Kubernetes to local files
|
||||
```
|
||||
|
||||
## Command Reference
|
||||
### Command Reference
|
||||
|
||||
You can learn more about each sub command from the links below.
|
||||
|
||||
- [`dapr mtls expiry`]({{< ref dapr-mtls-expiry.md >}})
|
||||
- [`dapr mtls export`]({{< ref dapr-mtls-export.md >}})
|
||||
- [`dapr mtls expiry`]({{< ref dapr-mtls-expiry.md >}})
|
||||
- [`dapr mtls export`]({{< ref dapr-mtls-export.md >}})
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Check if mTLS is enabled
|
||||
```bash
|
||||
# Check if mTLS is enabled
|
||||
dapr mtls -k
|
||||
```
|
||||
|
|
@ -6,28 +6,29 @@ description: "Detailed information on the mtls expiry CLI command"
|
|||
weight: 2000
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Checks the expiry of the root certificate
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr mtls expiry [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | help for expiry |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------- | -------------------- | ------- | --------------- |
|
||||
| `--help`, `-h` | | | help for expiry |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Check expiry of Kubernetes certs
|
||||
```bash
|
||||
# Check expiry of Kubernetes certs
|
||||
dapr mtls expiry
|
||||
```
|
||||
|
|
|
|||
|
|
@ -6,29 +6,30 @@ description: "Detailed information on the mtls export CLI command"
|
|||
weight: 1000
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Export the root CA, issuer cert and key from Kubernetes to local files
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr mtls export [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | help for export |
|
||||
| `--out`, `-o` | | current directory | The output directory path to save the certs |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------- | -------------------- | ----------------- | ------------------------------------------- |
|
||||
| `--help`, `-h` | | | help for export |
|
||||
| `--out`, `-o` | | current directory | The output directory path to save the certs |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Check expiry of Kubernetes certs
|
||||
```bash
|
||||
# Check expiry of Kubernetes certs
|
||||
dapr mtls export -o ./certs
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,35 +5,35 @@ linkTitle: "publish"
|
|||
description: "Detailed information on the publish CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Publish a pub-sub event.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr publish [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--publish-app-id`, `-i`| | The ID that represents the app from which you are publishing
|
||||
| `--pubsub`, `-p` | | The name of the pub/sub component
|
||||
| `--topic`, `-t` | | | The topic to be published to |
|
||||
| `--data`, `-d` | | | The JSON serialized string (optional) |
|
||||
| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| ------------------------ | -------------------- | ------------------------------------------------------------ | ----------------------------------------------------- |
|
||||
| `--publish-app-id`, `-i` | | The ID that represents the app from which you are publishing |
|
||||
| `--pubsub`, `-p` | | The name of the pub/sub component |
|
||||
| `--topic`, `-t` | | | The topic to be published to |
|
||||
| `--data`, `-d` | | | The JSON serialized string (optional) |
|
||||
| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Publish to sample topic in target pubsub
|
||||
```bash
|
||||
# Publish to sample topic in target pubsub
|
||||
dapr publish --publish-app-id appId --topic sample --pubsub target --data '{"key":"value"}'
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,69 +5,59 @@ linkTitle: "run"
|
|||
description: "Detailed information on the run CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Run Dapr and (optionally) your application side by side. A full list comparing daprd arguments, CLI arguments, and Kubernetes annotations can be found [here]({{< ref arguments-annotations-overview.md >}}).
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr run [flags] [command]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--app-id`, `-a` | | | The id for your application, used for service discovery |
|
||||
| `--app-max-concurrency` | | `unlimited` | The concurrency level of the application, otherwise is unlimited |
|
||||
| `--app-port`, `-p` | | | The port your application is listening on
|
||||
| `--app-protocol`, `-P` | | `http` | The protocol (gRPC or HTTP) Dapr uses to talk to the application. Valid values are: `http` or `grpc` |
|
||||
| `--app-ssl` | | `false` | Enable https when Dapr invokes the application
|
||||
| `--components-path`, `-d` | | `Linux & Mac: $HOME/.dapr/components`, `Windows: %USERPROFILE%\.dapr\components` | The path for components directory
|
||||
| `--config`, `-c` | | `Linux & Mac: $HOME/.dapr/config.yaml`, `Windows: %USERPROFILE%\.dapr\config.yaml` | Dapr configuration file |
|
||||
| `--dapr-grpc-port` | | `50001` | The gRPC port for Dapr to listen on |
|
||||
| `--dapr-http-port` | | `3500` | The HTTP port for Dapr to listen on |
|
||||
| `--enable-profiling` | | `false` | Enable `pprof` profiling via an HTTP endpoint
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--image` | | | The image to build the code in. Input is: `repository/image` |
|
||||
| `--log-level` | | `info` | The log verbosity. Valid values are: `debug`, `info`, `warn`, `error`, `fatal`, or `panic` |
|
||||
| `--placement-host-address` | `DAPR_PLACEMENT_HOST` | `localhost` | The address of the placement service. Format is either `<hostname>` for default port (`6050` on Windows, `50005` on Linux/MacOS) or `<hostname>:<port>` for custom port |
|
||||
| `--profile-port` | | `7777` | The port for the profile server to listen on |
|
||||
| `--dapr-http-max-request-size` | | `4` | Max size of request body in MB.|
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| ------------------------------ | -------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `--app-id`, `-a` | `APP_ID` | | The id for your application, used for service discovery |
|
||||
| `--app-max-concurrency` | | `unlimited` | The concurrency level of the application, otherwise is unlimited |
|
||||
| `--app-port`, `-p` | `APP_PORT` | | The port your application is listening on |
|
||||
| `--app-protocol`, `-P` | | `http` | The protocol (gRPC or HTTP) Dapr uses to talk to the application. Valid values are: `http` or `grpc` |
|
||||
| `--app-ssl` | | `false` | Enable https when Dapr invokes the application |
|
||||
| `--components-path`, `-d` | | `Linux & Mac: $HOME/.dapr/components`, `Windows: %USERPROFILE%\.dapr\components` | The path for components directory |
|
||||
| `--config`, `-c` | | `Linux & Mac: $HOME/.dapr/config.yaml`, `Windows: %USERPROFILE%\.dapr\config.yaml` | Dapr configuration file |
|
||||
| `--dapr-grpc-port` | `DAPR_GRPC_PORT` | `50001` | The gRPC port for Dapr to listen on |
|
||||
| `--dapr-http-port` | `DAPR_HTTP_PORT` | `3500` | The HTTP port for Dapr to listen on |
|
||||
| `--enable-profiling` | | `false` | Enable `pprof` profiling via an HTTP endpoint |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--image` | | | The image to build the code in. Input is: `repository/image` |
|
||||
| `--log-level` | | `info` | The log verbosity. Valid values are: `debug`, `info`, `warn`, `error`, `fatal`, or `panic` |
|
||||
| `--metrics-port` | `DAPR_METRICS_PORT` | `9090` | The port that Dapr sends its metrics information to |
|
||||
| `--profile-port` | | `7777` | The port for the profile server to listen on |
|
||||
| `--dapr-http-max-request-size` | | `4` | Max size of request body in MB. |
|
||||
|
||||
## Examples
|
||||
|
||||
### Run a .NET application
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Run a .NET application
|
||||
dapr run --app-id myapp --app-port 5000 -- dotnet run
|
||||
```
|
||||
|
||||
### Run a Java application
|
||||
|
||||
```bash
|
||||
# Run a Java application
|
||||
dapr run --app-id myapp -- java -jar myapp.jar
|
||||
```
|
||||
|
||||
### Run a NodeJs application that listens to port 3000
|
||||
|
||||
```bash
|
||||
# Run a NodeJs application that listens to port 3000
|
||||
dapr run --app-id myapp --app-port 3000 -- node myapp.js
|
||||
```
|
||||
|
||||
### Run a Python application
|
||||
|
||||
```bash
|
||||
# Run a Python application
|
||||
dapr run --app-id myapp -- python myapp.py
|
||||
```
|
||||
|
||||
### Run sidecar only
|
||||
|
||||
```bash
|
||||
# Run sidecar only
|
||||
dapr run --app-id myapp
|
||||
|
||||
# Run a gRPC application written in Go (listening on port 3000)
|
||||
dapr run --app-id myapp --app-port 5000 --app-protocol grpc -- go run main.go
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,30 +5,30 @@ linkTitle: "status"
|
|||
description: "Detailed information on the status CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Show the health status of Dapr services.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr status -k
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Show the health status of Dapr services on Kubernetes cluster |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | ------------------------------------------------------------- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Show the health status of Dapr services on Kubernetes cluster |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Get status of Dapr services from Kubernetes
|
||||
```bash
|
||||
# Get status of Dapr services from Kubernetes
|
||||
dapr status -k
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,30 +5,30 @@ linkTitle: "stop"
|
|||
description: "Detailed information on the stop CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Stop Dapr instances and their associated apps.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr stop [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--app-id`, `-a` | | | The application id to be stopped |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| ---------------- | -------------------- | ------- | -------------------------------- |
|
||||
| `--app-id`, `-a` | `APP_ID` | | The application id to be stopped |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Stop Dapr application
|
||||
```bash
|
||||
# Stop Dapr application
|
||||
dapr stop --app-id <ID>
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,44 +5,46 @@ linkTitle: "uninstall"
|
|||
description: "Detailed information on the uninstall CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Uninstall Dapr runtime.
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr uninstall [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--all` | | `false` | Remove Redis, Zipkin containers in addition to actor placement container. Remove default dapr dir located at `$HOME/.dapr or %USERPROFILE%\.dapr\`. |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Uninstall Dapr from a Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to uninstall Dapr from |
|
||||
| `--network` | `DAPR_NETWORK` | | The Docker network from which to remove the Dapr runtime |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `--all` | | `false` | Remove Redis, Zipkin containers in addition to actor placement container. Remove default dapr dir located at `$HOME/.dapr or %USERPROFILE%\.dapr\`. |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Uninstall Dapr from a Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to uninstall Dapr from |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
#### Uninstall from self-hosted mode
|
||||
|
||||
### Uninstall from self-hosted mode
|
||||
```bash
|
||||
dapr uninstall
|
||||
```
|
||||
|
||||
### Uninstall from self-hosted mode and remove .dapr directory, Redis, Placement and Zipkin containers
|
||||
You can also use option `--all` to remove .dapr directory, Redis, Placement and Zipkin containers
|
||||
|
||||
```bash
|
||||
dapr uninstall --all
|
||||
```
|
||||
|
||||
### Uninstall from Kubernetes
|
||||
#### Uninstall from Kubernetes
|
||||
|
||||
```bash
|
||||
dapr uninstall -k
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ linkTitle: "upgrade"
|
|||
description: "Detailed information on the upgrade CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
### Description
|
||||
|
||||
Upgrade or downgrade Dapr on supported hosting platforms.
|
||||
|
||||
|
|
@ -15,41 +15,38 @@ Version steps should be done incrementally, including minor versions as you upgr
|
|||
Prior to downgrading, confirm components are backwards compatible and application code does ultilize APIs that are not supported in previous versions of Dapr.
|
||||
{{% /alert %}}
|
||||
|
||||
## Supported platforms
|
||||
### Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
dapr upgrade [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Upgrade/Downgrade Dapr in a Kubernetes cluster |
|
||||
| `--runtime-version` | | `latest` | The version of the Dapr runtime to upgrade/downgrade to, for example: `1.0.0` |
|
||||
| `--set` | | | Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | -------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Upgrade/Downgrade Dapr in a Kubernetes cluster |
|
||||
| `--runtime-version` | | `latest` | The version of the Dapr runtime to upgrade/downgrade to, for example: `1.0.0` |
|
||||
| `--set` | | | Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) |
|
||||
|
||||
## Examples
|
||||
### Examples
|
||||
|
||||
### Upgrade Dapr in Kubernetes to latest version
|
||||
```bash
|
||||
# Upgrade Dapr in Kubernetes to latest version
|
||||
dapr upgrade -k
|
||||
```
|
||||
|
||||
### Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes
|
||||
```bash
|
||||
# Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes
|
||||
dapr upgrade -k --runtime-version 1.2
|
||||
```
|
||||
|
||||
### Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes with value set
|
||||
```bash
|
||||
# Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes with value set
|
||||
dapr upgrade -k --runtime-version 1.2 --set global.logAsJson=true
|
||||
```
|
||||
|
||||
# Related links
|
||||
### Related links
|
||||
|
||||
- [Upgrade Dapr on a Kubernetes cluster]({{< ref kubernetes-upgrade.md >}})
|
||||
|
|
@ -17,7 +17,7 @@ Table captions:
|
|||
> `Status`: [Component certification]({{<ref "certification-lifecycle.md">}}) status
|
||||
- [Alpha]({{<ref "certification-lifecycle.md#alpha">}})
|
||||
- [Beta]({{<ref "certification-lifecycle.md#beta">}})
|
||||
- [GA]({{<ref "certification-lifecycle.md#general-availability-ga">}})
|
||||
- [Stable]({{<ref "certification-lifecycle.md#stable">}})
|
||||
> `Since`: defines from which Dapr Runtime version, the component is in the current status
|
||||
|
||||
> `Component version`: defines the version of the component
|
||||
|
|
@ -28,7 +28,7 @@ Table captions:
|
|||
| [Apple Push Notifications (APN)]({{< ref apns.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Cron (Scheduler)]({{< ref cron.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [GraphQL]({{< ref graghql.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
||||
| [HTTP]({{< ref http.md >}}) | | ✅ | GA | v1 | 1.0 |
|
||||
| [HTTP]({{< ref http.md >}}) | | ✅ | Stable| v1 | 1.0 |
|
||||
| [InfluxDB]({{< ref influxdb.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Kafka]({{< ref kafka.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Kubernetes Events]({{< ref "kubernetes-binding.md" >}}) | ✅ | | Alpha | v1 | 1.0 |
|
||||
|
|
@ -76,11 +76,12 @@ Table captions:
|
|||
|------|:----------------:|:-----------------:|--------| --------- | ---------- |
|
||||
| [Azure Blob Storage]({{< ref blobstorage.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Azure CosmosDB]({{< ref cosmosdb.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Azure CosmosDBGremlinAPI]({{< ref cosmosdbgremlinapi.md >}}) | | ✅ | Alpha | v1 | 1.5 |
|
||||
| [Azure Event Grid]({{< ref eventgrid.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Azure Event Hubs]({{< ref eventhubs.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Azure Service Bus Queues]({{< ref servicebusqueues.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Azure SignalR]({{< ref signalr.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Azure Storage Queues]({{< ref storagequeues.md >}}) | ✅ | ✅ | GA | v1 | 1.0 |
|
||||
| [Azure Storage Queues]({{< ref storagequeues.md >}}) | ✅ | ✅ | Stable| v1 | 1.0 |
|
||||
|
||||
### Zeebe (Camunda Cloud)
|
||||
|
||||
|
|
|
|||
|
|
@ -32,6 +32,8 @@ spec:
|
|||
value: <bool>
|
||||
- name: getBlobRetryCount
|
||||
value: <integer>
|
||||
- name: publicAccessLevel
|
||||
value: <publicAccessLevel>
|
||||
```
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
|
||||
|
|
@ -46,6 +48,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| container | Y | Output | The name of the Blob Storage container to write to | `myexamplecontainer` |
|
||||
| decodeBase64 | N | Output | Configuration to decode base64 file content before saving to Blob Storage. (In case of saving a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `true`, `false` |
|
||||
| getBlobRetryCount | N | Output | Specifies the maximum number of HTTP GET requests that will be made while reading from a RetryReader Defaults to `10` | `1`, `2`
|
||||
| publicAccessLevel | N | Output | Specifies whether data in the container may be accessed publicly and the level of access (only used if the container is created by Dapr). Defaults to `none` | `blob`, `container`, `none`
|
||||
|
||||
|
||||
## Binding support
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| collection | Y | Output | The name of the container inside the database. | `"Orders"` |
|
||||
| partitionKey | Y | Output | The name of the partitionKey to extract from the payload and is used in the container | `"OrderId"`, `"message"` |
|
||||
|
||||
For more information see [Azure Cosmos DB resource model](https://docs.microsoft.com/en-us/azure/cosmos-db/account-databases-containers-items).
|
||||
For more information see [Azure Cosmos DB resource model](https://docs.microsoft.com/azure/cosmos-db/account-databases-containers-items).
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Azure CosmosDBGremlinAPI binding spec"
|
||||
linkTitle: "Azure CosmosDBGremlinAPI"
|
||||
description: "Detailed documentation on the Azure CosmosDBGremlinAPI binding component"
|
||||
---
|
||||
|
||||
## Component format
|
||||
|
||||
To setup Azure CosmosDBGremlinAPI binding create a component of type `bindings.azure.cosmosdb.gremlinapi`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
|
||||
|
||||
|
||||
```yaml
|
||||
apiVersion: dapr.io/v1alpha1
|
||||
kind: Component
|
||||
metadata:
|
||||
name: <NAME>
|
||||
namespace: <NAMESPACE>
|
||||
spec:
|
||||
type: bindings.azure.cosmosdb.gremlinapi
|
||||
version: v1
|
||||
metadata:
|
||||
- name: url
|
||||
value: wss://******.gremlin.cosmos.azure.com:443/
|
||||
- name: masterKey
|
||||
value: *****
|
||||
- name: username
|
||||
value: *****
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
|
||||
{{% /alert %}}
|
||||
|
||||
## Spec metadata fields
|
||||
|
||||
| Field | Required | Binding support | Details | Example |
|
||||
|--------------------|:--------:|--------|---------|---------|
|
||||
| url | Y | Output | The CosmosDBGremlinAPI url | `"wss://******.gremlin.cosmos.azure.com:443/"` |
|
||||
| masterKey | Y | Output | The CosmosDBGremlinAPI account master key | `"masterKey"` |
|
||||
| database | Y | Output | The username of the CosmosDBGremlinAPI database | `"username"` |
|
||||
|
||||
For more information see [Quickstart: Azure Cosmos Graph DB using Gremlin ](https://docs.microsoft.com/azure/cosmos-db/graph/create-graph-console).
|
||||
|
||||
## Binding support
|
||||
|
||||
This component supports **output binding** with the following operations:
|
||||
|
||||
- `query`
|
||||
|
||||
## Related links
|
||||
|
||||
- [Basic schema for a Dapr component]({{< ref component-schema >}})
|
||||
- [Bindings building block]({{< ref bindings >}})
|
||||
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
|
||||
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
|
||||
- [Bindings API reference]({{< ref bindings_api.md >}})
|
||||
|
|
@ -59,6 +59,20 @@ For ease of use, the Dapr cron binding also supports few shortcuts:
|
|||
* `@every 15s` where `s` is seconds, `m` minutes, and `h` hours
|
||||
* `@daily` or `@hourly` which runs at that period from the time the binding is initialized
|
||||
|
||||
## Listen to the cron binding
|
||||
|
||||
After setting up the cron binding, all you need to do is listen on an endpoint that matches the name of your component. Assume the [NAME] is `scheduled`. This will be made as a HTTP `POST` request. The below example shows how a simple Node.js Express application can receive calls on the `/scheduled` endpoint and write a message to the console.
|
||||
|
||||
```js
|
||||
app.post('/scheduled', async function(req, res){
|
||||
console.log("scheduled endpoint called", req.body)
|
||||
res.status(200).send()
|
||||
});
|
||||
```
|
||||
|
||||
When running this code, note that the `/scheduled` endpoint is called every five minutes by the Dapr sidecar.
|
||||
|
||||
|
||||
## Binding support
|
||||
|
||||
This component supports both **input and output** binding interfaces.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ aliases:
|
|||
|
||||
To setup Azure Event Grid binding create a component of type `bindings.azure.eventgrid`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
|
||||
|
||||
See [this](https://docs.microsoft.com/en-us/azure/event-grid/) for Azure Event Grid documentation.
|
||||
See [this](https://docs.microsoft.com/azure/event-grid/) for Azure Event Grid documentation.
|
||||
|
||||
```yml
|
||||
apiVersion: dapr.io/v1alpha1
|
||||
|
|
@ -83,7 +83,7 @@ This component supports **output binding** with the following operations:
|
|||
- `create`
|
||||
## Additional information
|
||||
|
||||
Event Grid Binding creates an [event subscription](https://docs.microsoft.com/en-us/azure/event-grid/concepts#event-subscriptions) when Dapr initializes. Your Service Principal needs to have the RBAC permissions to enable this.
|
||||
Event Grid Binding creates an [event subscription](https://docs.microsoft.com/azure/event-grid/concepts#event-subscriptions) when Dapr initializes. Your Service Principal needs to have the RBAC permissions to enable this.
|
||||
|
||||
```bash
|
||||
# First ensure that Azure Resource Manager provider is registered for Event Grid
|
||||
|
|
@ -137,7 +137,7 @@ helm install nginx-ingress ingress-nginx/ingress-nginx -f ./dapr-annotations.yam
|
|||
kubectl get svc -l component=controller -o jsonpath='Public IP is: {.items[0].status.loadBalancer.ingress[0].ip}{"\n"}'
|
||||
```
|
||||
|
||||
If deploying to Azure Kubernetes Service, you can follow [the official MS documentation for rest of the steps](https://docs.microsoft.com/en-us/azure/aks/ingress-tls)
|
||||
If deploying to Azure Kubernetes Service, you can follow [the official MS documentation for rest of the steps](https://docs.microsoft.com/azure/aks/ingress-tls)
|
||||
- Add an A record to your DNS zone
|
||||
- Install cert-manager
|
||||
- Create a CA cluster issuer
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ aliases:
|
|||
|
||||
To setup Azure Event Hubs binding create a component of type `bindings.azure.eventhubs`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
|
||||
|
||||
See [this](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-dotnet-framework-getstarted-send) for instructions on how to set up an Event Hub.
|
||||
See [this](https://docs.microsoft.com/azure/event-hubs/event-hubs-dotnet-framework-getstarted-send) for instructions on how to set up an Event Hub.
|
||||
|
||||
```yaml
|
||||
apiVersion: dapr.io/v1alpha1
|
||||
|
|
@ -45,8 +45,8 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
|
||||
| Field | Required | Binding support | Details | Example |
|
||||
|--------------------|:--------:|------------|-----|---------|
|
||||
| connectionString | Y | Output | The [EventHubs connection string](https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-shared-access-signature). Note that this is the EventHub itself and not the EventHubs namespace. Make sure to use the child EventHub shared access policy connection string | `"Endpoint=sb://****"` |
|
||||
| consumerGroup | Y | Output | The name of an [EventHubs Consumer Group](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-features#consumer-groups) to listen on | `"group1"` |
|
||||
| connectionString | Y | Output | The [EventHubs connection string](https://docs.microsoft.com/azure/event-hubs/authorize-access-shared-access-signature). Note that this is the EventHub itself and not the EventHubs namespace. Make sure to use the child EventHub shared access policy connection string | `"Endpoint=sb://****"` |
|
||||
| consumerGroup | Y | Output | The name of an [EventHubs Consumer Group](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#consumer-groups) to listen on | `"group1"` |
|
||||
| storageAccountName | Y | Output | The name of the account of the Azure Storage account to persist checkpoints data on | `"accountName"` |
|
||||
| storageAccountKey | Y | Output | The account key for the Azure Storage account to persist checkpoints data on | `"accountKey"` |
|
||||
| storageContainerName | Y | Output | The name of the container in the Azure Storage account to persist checkpoints data on | `"contianerName"` |
|
||||
|
|
@ -60,17 +60,18 @@ This component supports **output binding** with the following operations:
|
|||
|
||||
## Input Binding to Azure IoT Hub Events
|
||||
|
||||
Azure IoT Hub provides an [endpoint that is compatible with Event Hubs](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin#read-from-the-built-in-endpoint), so Dapr apps can create input bindings to read Azure IoT Hub events using the Event Hubs bindings component.
|
||||
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 Dapr apps can create input bindings to read Azure IoT Hub events using the Event Hubs bindings component.
|
||||
|
||||
The device-to-cloud events created by Azure IoT Hub devices will contain additional [IoT Hub System Properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-construct#system-properties-of-d2c-iot-hub-messages), and the Azure Event Hubs binding for Dapr will return the following as part of the response metadata:
|
||||
The device-to-cloud events created by Azure IoT Hub devices will contain additional [IoT Hub System Properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-construct#system-properties-of-d2c-iot-hub-messages), and the Azure Event Hubs binding for Dapr will return the following as part of the response metadata:
|
||||
|
||||
| System Property Name | Description |
|
||||
|--------------------|:--------|
|
||||
| `iothub-connection-auth-generation-id` | The **connectionDeviceGenerationId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-connection-auth-method` | The authentication method used to authenticate the device that sent the message. |
|
||||
| `iothub-connection-device-id` | The **deviceId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-connection-module-id` | The **moduleId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-enqueuedtime` | The date and time in RFC3339 format that the device-to-cloud message was received by IoT Hub. |
|
||||
| System Property Name | Description & Routing Query Keyword |
|
||||
|----------------------|:------------------------------------|
|
||||
| `iothub-connection-auth-generation-id` | The **connectionDeviceGenerationId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-connection-auth-method` | The **connectionAuthMethod** used to authenticate the device that sent the message. |
|
||||
| `iothub-connection-device-id` | The **deviceId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-connection-module-id` | The **moduleId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-enqueuedtime` | The **enqueuedTime** in RFC3339 format that the device-to-cloud message was received by IoT Hub. |
|
||||
| `message-id` | The user-settable AMQP **messageId**. |
|
||||
|
||||
For example, the headers of a HTTP `Read()` response would contain:
|
||||
|
||||
|
|
@ -85,6 +86,7 @@ For example, the headers of a HTTP `Read()` response would contain:
|
|||
'iothub-connection-auth-method': '{"scope":"module","type":"sas","issuer":"iothub","acceptingIpFilterRule":null}',
|
||||
'iothub-connection-module-id': 'my-test-module-a',
|
||||
'iothub-enqueuedtime': '2021-07-13T22:08:09Z',
|
||||
'message-id': 'my-custom-message-id',
|
||||
'x-opt-sequence-number': '35',
|
||||
'x-opt-enqueued-time': '2021-07-13T22:08:09Z',
|
||||
'x-opt-offset': '21560',
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ spec:
|
|||
- name: namespace
|
||||
value: <NAMESPACE>
|
||||
- name: resyncPeriodInSec
|
||||
vale: "<seconds>"
|
||||
value: "<seconds>"
|
||||
```
|
||||
|
||||
## Spec metadata fields
|
||||
|
|
|
|||
|
|
@ -119,7 +119,7 @@ You can use [Helm](https://helm.sh/) to quickly create a Redis instance in our K
|
|||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
[Azure Redis](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/quickstart-create-redis)
|
||||
[Azure Redis](https://docs.microsoft.com/azure/azure-cache-for-redis/quickstart-create-redis)
|
||||
{{% /codetab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| Field | Required | Binding support | Details | Example |
|
||||
|--------------------|:--------:|------------|-----|---------|
|
||||
| connectionString | Y | Input/Output | The Service Bus connection string | `"Endpoint=sb://************"` |
|
||||
| queueName | Y | Input/Output | The Service Bus queue name | `"queuename"` |
|
||||
| queueName | Y | Input/Output | The Service Bus queue name. Queue names are case-insensitive and will always be forced to lowercase. | `"queuename"` |
|
||||
| ttlInSeconds | N | Output | Parameter to set the default message [time to live](https://docs.microsoft.com/azure/service-bus-messaging/message-expiration). If this parameter is omitted, messages will expire after 14 days. See [also](#specifying-a-ttl-per-message) | `"60"` |
|
||||
|
||||
## Binding support
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ Applications publishing to an Azure SignalR output binding should send a message
|
|||
}
|
||||
```
|
||||
|
||||
For more information on integration Azure SignalR into a solution check the [documentation](https://docs.microsoft.com/en-us/azure/azure-signalr/)
|
||||
For more information on integration Azure SignalR into a solution check the [documentation](https://docs.microsoft.com/azure/azure-signalr/)
|
||||
|
||||
## Related links
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,16 @@ aliases:
|
|||
- /developing-applications/middleware/supported-middleware/
|
||||
---
|
||||
|
||||
Table captions:
|
||||
|
||||
> `Status`: [Component certification]({{<ref "certification-lifecycle.md">}}) status
|
||||
- [Alpha]({{<ref "certification-lifecycle.md#alpha">}})
|
||||
- [Beta]({{<ref "certification-lifecycle.md#beta">}})
|
||||
- [Stable]({{<ref "certification-lifecycle.md#stable">}})
|
||||
> `Since`: defines from which Dapr Runtime version, the component is in the current status
|
||||
|
||||
> `Component version`: defines the version of the component
|
||||
|
||||
### HTTP
|
||||
|
||||
| Name | Description | Status | Component version |
|
||||
|
|
@ -18,4 +28,4 @@ aliases:
|
|||
| [OAuth2 client credentials]({{< ref middleware-oauth2clientcredentials.md >}}) | Enables the [OAuth2 Client Credentials Grant flow](https://tools.ietf.org/html/rfc6749#section-4.4) on a Web API | Alpha | v1|
|
||||
| [Bearer]({{< ref middleware-bearer.md >}}) | Verifies a [Bearer Token](https://tools.ietf.org/html/rfc6750) using [OpenID Connect](https://openid.net/connect/) on a Web API | Alpha | v1|
|
||||
| [Open Policy Agent]({{< ref middleware-opa.md >}}) | Applies [Rego/OPA Policies](https://www.openpolicyagent.org/) to incoming Dapr HTTP requests | Alpha | v1|
|
||||
| [Uppercase]({{< ref middleware-uppercase.md >}}) | Converts the body of the request to uppercase letters | GA (For local development) | v1|
|
||||
| [Uppercase]({{< ref middleware-uppercase.md >}}) | Converts the body of the request to uppercase letters | Stable(For local development) | v1|
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ This middleware supplies a [`HTTPRequest`](#httprequest) as input.
|
|||
|
||||
### HTTPRequest
|
||||
|
||||
The `HTTPRequest` input contains all the relevant information about an incoming HTTP Request except it's body.
|
||||
The `HTTPRequest` input contains all the relevant information about an incoming HTTP Request.
|
||||
|
||||
```go
|
||||
type Input struct {
|
||||
|
|
@ -123,6 +123,8 @@ type HTTPRequest struct {
|
|||
headers map[string]string
|
||||
// The request scheme (e.g. http, https)
|
||||
scheme string
|
||||
// The request body (e.g. http, https)
|
||||
body string
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -7,9 +7,17 @@ description: The supported name resolution providers that interface with Dapr se
|
|||
no_list: true
|
||||
---
|
||||
|
||||
## Supported name resolution components
|
||||
The following components provide name resolution for the service invocation building block.
|
||||
|
||||
The following components provide name resolution for the service invocation building block
|
||||
Table captions:
|
||||
|
||||
> `Status`: [Component certification]({{<ref "certification-lifecycle.md">}}) status
|
||||
- [Alpha]({{<ref "certification-lifecycle.md#alpha">}})
|
||||
- [Beta]({{<ref "certification-lifecycle.md#beta">}})
|
||||
- [Stable]({{<ref "certification-lifecycle.md#stable">}})
|
||||
> `Since`: defines from which Dapr Runtime version, the component is in the current status
|
||||
|
||||
> `Component version`: defines the version of the component
|
||||
|
||||
### Generic
|
||||
|
||||
|
|
@ -21,19 +29,10 @@ The following components provide name resolution for the service invocation buil
|
|||
|
||||
| Name | Status | Component version | Since |
|
||||
|------|:------:|:-----------------:|:-----:|
|
||||
| [mDNS]({{< ref nr-mdns.md >}}) | GA | v1 | 1.0 |
|
||||
| [mDNS]({{< ref nr-mdns.md >}}) | Stable| v1 | 1.0 |
|
||||
|
||||
### Kubernetes
|
||||
|
||||
| Name | Status | Component version | Since |
|
||||
|------------|:------:|:-----------------:|:-----:|
|
||||
| [Kubernetes]({{< ref nr-kubernetes.md >}}) | GA | v1 | 1.0 |
|
||||
|
||||
## Definitions
|
||||
|
||||
- **Status**: [component certification]({{<ref "certification-lifecycle.md">}}) status
|
||||
- [Alpha]({{<ref "certification-lifecycle.md#alpha">}})
|
||||
- [Beta]({{<ref "certification-lifecycle.md#beta">}})
|
||||
- [GA]({{<ref "certification-lifecycle.md#general-availability-ga">}})
|
||||
- **Since**: defines from which Dapr Runtime version, the component is in the current status
|
||||
- **Component version**: defines the version of the component
|
||||
| [Kubernetes]({{< ref nr-kubernetes.md >}}) | Stable| v1 | 1.0 |
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Table captions:
|
|||
> `Status`: [Component certification]({{<ref "certification-lifecycle.md">}}) status
|
||||
- [Alpha]({{<ref "certification-lifecycle.md#alpha">}})
|
||||
- [Beta]({{<ref "certification-lifecycle.md#beta">}})
|
||||
- [GA]({{<ref "certification-lifecycle.md#general-availability-ga">}})
|
||||
- [Stable]({{<ref "certification-lifecycle.md#stable">}})
|
||||
> `Since`: defines from which Dapr Runtime version, the component is in the current status
|
||||
|
||||
> `Component version`: defines the version of the component
|
||||
|
|
@ -22,15 +22,15 @@ Table captions:
|
|||
|
||||
| Name | Status | Component version | Since |
|
||||
|-------------------------------------------------------|--------| -----| ------------- |
|
||||
| [Apache Kafka]({{< ref setup-apache-kafka.md >}}) | Beta | v1 | 1.0 |
|
||||
| [Apache Kafka]({{< ref setup-apache-kafka.md >}}) | Stable | v1 | 1.5 |
|
||||
| [Hazelcast]({{< ref setup-hazelcast.md >}}) | Alpha | v1 | 1.0 |
|
||||
| [MQTT]({{< ref setup-mqtt.md >}}) | Alpha | v1 | 1.0 |
|
||||
| [NATS Streaming]({{< ref setup-nats-streaming.md >}}) | Beta | v1 | 1.0 |
|
||||
| [In Memory]({{< ref setup-inmemory.md >}}) | Alpha | v1 | 1.4 |
|
||||
| [JetStream]({{< ref setup-jetstream.md >}}) | Alpha | v1 | 1.4 |
|
||||
| [NATS Streaming]({{< ref setup-nats-streaming.md >}}) | Beta | v1 | 1.0 |
|
||||
| [In Memory]({{< ref setup-inmemory.md >}}) | Alpha | v1 | 1.4 |
|
||||
| [JetStream]({{< ref setup-jetstream.md >}}) | Alpha | v1 | 1.4 |
|
||||
| [Pulsar]({{< ref setup-pulsar.md >}}) | Alpha | v1 | 1.0 |
|
||||
| [RabbitMQ]({{< ref setup-rabbitmq.md >}}) | Alpha | v1 | 1.0 |
|
||||
| [Redis Streams]({{< ref setup-redis-pubsub.md >}}) | GA | v1 | 1.0 |
|
||||
| [Redis Streams]({{< ref setup-redis-pubsub.md >}}) | Stable | v1 | 1.0 |
|
||||
|
||||
### Amazon Web Services (AWS)
|
||||
|
||||
|
|
@ -49,4 +49,4 @@ Table captions:
|
|||
| Name | Status | Component version | Since |
|
||||
|-----------------------------------------------------------|--------| ----------------| -- |
|
||||
| [Azure Event Hubs]({{< ref setup-azure-eventhubs.md >}}) | Alpha | v1 | 1.0 |
|
||||
| [Azure Service Bus]({{< ref setup-azure-servicebus.md >}})| GA | v1 | 1.0 |
|
||||
| [Azure Service Bus]({{< ref setup-azure-servicebus.md >}})| Stable | v1 | 1.0 |
|
||||
|
|
|
|||
|
|
@ -37,6 +37,8 @@ spec:
|
|||
key: saslPasswordSecret
|
||||
- name: maxMessageBytes # Optional.
|
||||
value: 1024
|
||||
- name: consumeRetryInterval # Optional.
|
||||
value: 200ms
|
||||
```
|
||||
|
||||
## Spec metadata fields
|
||||
|
|
@ -51,6 +53,7 @@ spec:
|
|||
| saslPassword | N | The SASL password used for authentication. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). Only required if `authRequired` is set to `"true"`. | `""`, `"KeFg23!"`
|
||||
| initialOffset | N | The initial offset to use if no offset was previously committed. Should be "newest" or "oldest". Defaults to "newest". | `"oldest"`
|
||||
| maxMessageBytes | N | The maximum size in bytes allowed for a single Kafka message. Defaults to 1024. | `2048`
|
||||
| consumeRetryInterval | N | The interval between retries when attempting to consume topics. Treats numbers without suffix as milliseconds. Defaults to 100ms. | `200ms`
|
||||
| caCert | N | Certificate authority certificate, required for using TLS. Can be `secretKeyRef` to use a secret reference | `"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
|
||||
| clientCert | N | Client certificate, required for using TLS. Can be `secretKeyRef` to use a secret reference | `"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
|
||||
| clientKey | N | Client key, required for using TLS. Can be `secretKeyRef` to use a secret reference | `"-----BEGIN RSA PRIVATE KEY-----\n<base64-encoded PKCS8>\n-----END RSA PRIVATE KEY-----"`
|
||||
|
|
|
|||
|
|
@ -46,10 +46,10 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
|
||||
## Create an Azure Event Hub
|
||||
|
||||
Follow the instructions [here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-create) on setting up Azure Event Hubs.
|
||||
Since this implementation uses the Event Processor Host, you will also need an [Azure Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal). Follow the instructions [here](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage) to manage the storage account access keys.
|
||||
Follow the instructions [here](https://docs.microsoft.com/azure/event-hubs/event-hubs-create) on setting up Azure Event Hubs.
|
||||
Since this implementation uses the Event Processor Host, you will also need an [Azure Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create?tabs=azure-portal). Follow the instructions [here](https://docs.microsoft.com/azure/storage/common/storage-account-keys-manage) to manage the storage account access keys.
|
||||
|
||||
See [here](https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-shared-access-signature) on how to get the Event Hubs connection string. Note this is not the Event Hubs namespace.
|
||||
See [here](https://docs.microsoft.com/azure/event-hubs/authorize-access-shared-access-signature) on how to get the Event Hubs connection string. Note this is not the Event Hubs namespace.
|
||||
|
||||
### Create consumer groups for each subscriber
|
||||
|
||||
|
|
@ -60,17 +60,18 @@ Note: Dapr passes the name of the Consumer group to the EventHub and so this is
|
|||
|
||||
## Subscribing to Azure IoT Hub Events
|
||||
|
||||
Azure IoT Hub provides an [endpoint that is compatible with Event Hubs](https://docs.microsoft.com/en-us/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.
|
||||
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.
|
||||
|
||||
The device-to-cloud events created by Azure IoT Hub devices will contain additional [IoT Hub System Properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-construct#system-properties-of-d2c-iot-hub-messages), and the Azure Event Hubs pubsub component for Dapr will return the following as part of the response metadata:
|
||||
The device-to-cloud events created by Azure IoT Hub devices will contain additional [IoT Hub System Properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-construct#system-properties-of-d2c-iot-hub-messages), and the Azure Event Hubs pubsub component for Dapr will return the following as part of the response metadata:
|
||||
|
||||
| System Property Name | Description |
|
||||
|--------------------|:--------|
|
||||
| `iothub-connection-auth-generation-id` | The **connectionDeviceGenerationId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-connection-auth-method` | The authentication method used to authenticate the device that sent the message. |
|
||||
| `iothub-connection-device-id` | The **deviceId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-connection-module-id` | The **moduleId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-enqueuedtime` | The date and time in RFC3339 format that the device-to-cloud message was received by IoT Hub. |
|
||||
| System Property Name | Description & Routing Query Keyword |
|
||||
|----------------------|:------------------------------------|
|
||||
| `iothub-connection-auth-generation-id` | The **connectionDeviceGenerationId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-connection-auth-method` | The **connectionAuthMethod** used to authenticate the device that sent the message. |
|
||||
| `iothub-connection-device-id` | The **deviceId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-connection-module-id` | The **moduleId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). |
|
||||
| `iothub-enqueuedtime` | The **enqueuedTime** in RFC3339 format that the device-to-cloud message was received by IoT Hub. |
|
||||
| `message-id` | The user-settable AMQP **messageId**. |
|
||||
|
||||
For example, the headers of a delivered HTTP subscription message would contain:
|
||||
|
||||
|
|
@ -85,6 +86,7 @@ For example, the headers of a delivered HTTP subscription message would contain:
|
|||
'iothub-connection-auth-method': '{"scope":"module","type":"sas","issuer":"iothub","acceptingIpFilterRule":null}',
|
||||
'iothub-connection-module-id': 'my-test-module-a',
|
||||
'iothub-enqueuedtime': '2021-07-13T22:08:09Z',
|
||||
'message-id': 'my-custom-message-id',
|
||||
'x-opt-sequence-number': '35',
|
||||
'x-opt-enqueued-time': '2021-07-13T22:08:09Z',
|
||||
'x-opt-offset': '21560',
|
||||
|
|
|
|||
|
|
@ -116,11 +116,11 @@ In addition to the [settable metadata listed above](#sending-a-message-with-meta
|
|||
- `metadata.EnqueuedTimeUtc`
|
||||
- `metadata.SequenceNumber`
|
||||
|
||||
To find out more details on the purpose of any of these metadata properties, please refer to [the official Azure Service Bus documentation](https://docs.microsoft.com/en-us/rest/api/servicebus/message-headers-and-properties#message-headers).
|
||||
To find out more details on the purpose of any of these metadata properties, please refer to [the official Azure Service Bus documentation](https://docs.microsoft.com/rest/api/servicebus/message-headers-and-properties#message-headers).
|
||||
|
||||
## Create an Azure Service Bus
|
||||
|
||||
Follow the instructions [here](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quickstart-topics-subscriptions-portal) on setting up Azure Service Bus Topics.
|
||||
Follow the instructions [here](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-quickstart-topics-subscriptions-portal) on setting up Azure Service Bus Topics.
|
||||
|
||||
## Related links
|
||||
- [Basic schema for a Dapr component]({{< ref component-schema >}})
|
||||
|
|
|
|||
|
|
@ -43,6 +43,12 @@ spec:
|
|||
value: "100"
|
||||
- name: backOffMaxRetries
|
||||
value: "16"
|
||||
- name: enableDeadLetter # Optional enable dead Letter or not
|
||||
value: "true"
|
||||
- name: maxLen # Optional max message count in a queue
|
||||
value: "3000"
|
||||
- name: maxLenBytes # Optional maximum length in bytes of a queue.
|
||||
value: "10485760"
|
||||
```
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
|
||||
|
|
@ -69,6 +75,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| backOffRandomizationFactor | N | Randomization factor, between 1 and 0, including 0 but not 1. Randomized interval = RetryInterval * (1 ± backOffRandomizationFactor). Defaults to `"0.5"`. | `"0.5"` |
|
||||
| backOffMultiplier | N | Backoff multiplier for the policy. Increments the interval by multiplying it with the multiplier. Defaults to `"1.5"` | `"1.5"` |
|
||||
| backOffMaxElapsedTime | N | After MaxElapsedTime the ExponentialBackOff returns Stop. There are two valid formats, one is the fraction with a unit suffix format, and the other is the pure digital format that will be processed as milliseconds. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Defaults to `"15m"` | `"15m"` |
|
||||
| enableDeadLetter | N | Enable forwarding Messages that cannot be handled to a dead-letter topic. Defaults to `"false"` | `"true"`, `"false"` |
|
||||
| maxLen | N | The maximum number of messages of a queue and its dead letter queue (if dead letter enabled). If both `maxLen` and `maxLenBytes` are set then both will apply; whichever limit is hit first will be enforced. Defaults to no limit. | `"1000"` |
|
||||
| maxLenBytes | N | Maximum length in bytes of a queue and its dead letter queue (if dead letter enabled). If both `maxLen` and `maxLenBytes` are set then both will apply; whichever limit is hit first will be enforced. Defaults to no limit. | `"1048576"` |
|
||||
|
||||
|
||||
### Backoff policy introduction
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ You can use [Helm](https://helm.sh/) to quickly create a Redis instance in our K
|
|||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
[Azure Redis](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/quickstart-create-redis)
|
||||
[Azure Redis](https://docs.microsoft.com/azure/azure-cache-for-redis/quickstart-create-redis)
|
||||
{{% /codetab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Table captions:
|
|||
> `Status`: [Component certification]({{<ref "certification-lifecycle.md">}}) status
|
||||
- [Alpha]({{<ref "certification-lifecycle.md#alpha">}})
|
||||
- [Beta]({{<ref "certification-lifecycle.md#beta">}})
|
||||
- [GA]({{<ref "certification-lifecycle.md#general-availability-ga">}})
|
||||
- [Stable]({{<ref "certification-lifecycle.md#stable">}})
|
||||
> `Since`: defines from which Dapr Runtime version, the component is in the current status
|
||||
|
||||
> `Component version`: defines the version of the component
|
||||
|
|
@ -23,10 +23,10 @@ Table captions:
|
|||
|
||||
| Name | Status | Component version | Since |
|
||||
|-------------------------------------------------------------------|------------------------------| ---------------- |-- |
|
||||
| [Local environment variables]({{< ref envvar-secret-store.md >}}) | Beta | v1 | 1.0 |
|
||||
| [Local file]({{< ref file-secret-store.md >}}) | Beta | v1 | 1.0 |
|
||||
| [Local environment variables]({{< ref envvar-secret-store.md >}}) | Beta | v1 | 1.0 |
|
||||
| [Local file]({{< ref file-secret-store.md >}}) | Beta | v1 | 1.0 |
|
||||
| [HashiCorp Vault]({{< ref hashicorp-vault.md >}}) | Alpha | v1 | 1.0 |
|
||||
| [Kubernetes secrets]({{< ref kubernetes-secret-store.md >}}) | GA | v1 | 1.0 |
|
||||
| [Kubernetes secrets]({{< ref kubernetes-secret-store.md >}}) | Stable | v1 | 1.0 |
|
||||
|
||||
### Amazon Web Services (AWS)
|
||||
|
||||
|
|
@ -45,4 +45,4 @@ Table captions:
|
|||
|
||||
| Name | Status | Component version | Since |
|
||||
|---------------------------------------------------------------------------------------|--------| ---- |--------------|
|
||||
| [Azure Key Vault]({{< ref azure-keyvault.md >}}) | GA | v1 | 1.0 |
|
||||
| [Azure Key Vault]({{< ref azure-keyvault.md >}}) | Stable | v1 | 1.0 |
|
||||
|
|
|
|||
|
|
@ -265,7 +265,7 @@ To use a **certificate**:
|
|||
## References
|
||||
|
||||
- [Authenticating to Azure]({{< ref authenticating-azure.md >}})
|
||||
- [Azure CLI: keyvault commands](https://docs.microsoft.com/en-us/cli/azure/keyvault?view=azure-cli-latest#az-keyvault-create)
|
||||
- [Azure CLI: keyvault commands](https://docs.microsoft.com/cli/azure/keyvault?view=azure-cli-latest#az-keyvault-create)
|
||||
- [Secrets building block]({{< ref secrets >}})
|
||||
- [How-To: Retrieve a secret]({{< ref "howto-secrets.md" >}})
|
||||
- [How-To: Reference secrets in Dapr components]({{< ref component-secrets.md >}})
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Table captions:
|
|||
> `Status`: [Component certification]({{<ref "certification-lifecycle.md">}}) status
|
||||
- [Alpha]({{<ref "certification-lifecycle.md#alpha">}})
|
||||
- [Beta]({{<ref "certification-lifecycle.md#beta">}})
|
||||
- [GA]({{<ref "certification-lifecycle.md#general-availability-ga">}})
|
||||
- [Stable]({{<ref "certification-lifecycle.md#stable">}})
|
||||
> `Since`: defines from which Dapr Runtime version, the component is in the current status
|
||||
|
||||
> `Component version`: defines the version of the component
|
||||
|
|
@ -35,10 +35,10 @@ The following stores are supported, at various levels, by the Dapr state managem
|
|||
| [Hashicorp Consul]({{< ref setup-consul.md >}}) | ✅ | ❌ | ❌ | ❌ | ❌ | Alpha | v1 | 1.0 |
|
||||
| [Hazelcast]({{< ref setup-hazelcast.md >}}) | ✅ | ❌ | ❌ | ❌ | ❌ | Alpha | v1 | 1.0 |
|
||||
| [Memcached]({{< ref setup-memcached.md >}}) | ✅ | ❌ | ❌ | ✅ | ❌ | Alpha | v1 | 1.0 |
|
||||
| [MongoDB]({{< ref setup-mongodb.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | GA | v1 | 1.0 |
|
||||
| [MongoDB]({{< ref setup-mongodb.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Stable | v1 | 1.0 |
|
||||
| [MySQL]({{< ref setup-mysql.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [PostgreSQL]({{< ref setup-postgresql.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Redis]({{< ref setup-redis.md >}}) | ✅ | ✅ | ✅ | ✅ | ✅ | GA | v1 | 1.0 |
|
||||
| [Redis]({{< ref setup-redis.md >}}) | ✅ | ✅ | ✅ | ✅ | ✅ | Stable | v1 | 1.0 |
|
||||
| [RethinkDB]({{< ref setup-rethinkdb.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Zookeeper]({{< ref setup-zookeeper.md >}}) | ✅ | ❌ | ✅ | ❌ | ❌ | Alpha | v1 | 1.0 |
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ The following stores are supported, at various levels, by the Dapr state managem
|
|||
|
||||
| Name | CRUD | Transactional | ETag | [TTL]({{< ref state-store-ttl.md >}}) | [Actors]({{< ref howto-actors.md >}}) | Status | Component version | Since |
|
||||
|------------------------------------------------------------------|------|---------------------|------|-----|--------|-----|-----|-------|
|
||||
| [Azure Blob Storage]({{< ref setup-azure-blobstorage.md >}}) | ✅ | ❌ | ✅ | ❌ | ❌ | GA | v1 | 1.0 |
|
||||
| [Azure CosmosDB]({{< ref setup-azure-cosmosdb.md >}}) | ✅ | ✅ | ✅ | ✅ | ✅ | GA | v1 | 1.0 |
|
||||
| [Azure SQL Server]({{< ref setup-sqlserver.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Alpha | v1 | 1.0 |
|
||||
| [Azure Blob Storage]({{< ref setup-azure-blobstorage.md >}}) | ✅ | ❌ | ✅ | ❌ | ❌ | Stable | v1 | 1.0 |
|
||||
| [Azure CosmosDB]({{< ref setup-azure-cosmosdb.md >}}) | ✅ | ✅ | ✅ | ✅ | ✅ | Stable | v1 | 1.0 |
|
||||
| [Azure SQL Server]({{< ref setup-sqlserver.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Stable | v1 | 1.5 |
|
||||
| [Azure Table Storage]({{< ref setup-azure-tablestorage.md >}}) | ✅ | ❌ | ✅ | ❌ | ❌ | Alpha | v1 | 1.0 |
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
|
||||
## Setup Azure Blob Storage
|
||||
|
||||
[Follow the instructions](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal) from the Azure documentation on how to create an Azure Storage Account.
|
||||
[Follow the instructions](https://docs.microsoft.com/azure/storage/common/storage-account-create?tabs=azure-portal) from the Azure documentation on how to create an Azure Storage Account.
|
||||
|
||||
If you wish to create a container for Dapr to use, you can do so beforehand. However, the Blob Storage state provider will create one for you automatically if it doesn't exist.
|
||||
|
||||
|
|
@ -155,7 +155,7 @@ This creates the blob file in the container with `key` as filename and `value` a
|
|||
|
||||
## Concurrency
|
||||
|
||||
Azure Blob Storage state concurrency is achieved by using `ETag`s according to [the Azure Blob Storage documentation](https://docs.microsoft.com/en-us/azure/storage/common/storage-concurrency#managing-concurrency-in-blob-storage).
|
||||
Azure Blob Storage state concurrency is achieved by using `ETag`s according to [the Azure Blob Storage documentation](https://docs.microsoft.com/azure/storage/common/storage-concurrency#managing-concurrency-in-blob-storage).
|
||||
|
||||
## Related links
|
||||
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ If you wish to use CosmosDb as an actor store, append the following to the yaml.
|
|||
|
||||
## Setup Azure Cosmos DB
|
||||
|
||||
[Follow the instructions](https://docs.microsoft.com/en-us/azure/cosmos-db/how-to-manage-database-account) from the Azure documentation on how to create an Azure CosmosDB account. The database and collection must be created in CosmosDB before Dapr can use it.
|
||||
[Follow the instructions](https://docs.microsoft.com/azure/cosmos-db/how-to-manage-database-account) from the Azure documentation on how to create an Azure CosmosDB account. The database and collection must be created in CosmosDB before Dapr can use it.
|
||||
|
||||
**Note : The partition key for the collection must be named "/partitionKey". Note: this is case-sensitive.**
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
|
||||
## Setup Azure Table Storage
|
||||
|
||||
[Follow the instructions](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal) from the Azure documentation on how to create an Azure Storage Account.
|
||||
[Follow the instructions](https://docs.microsoft.com/azure/storage/common/storage-account-create?tabs=azure-portal) from the Azure documentation on how to create an Azure Storage Account.
|
||||
|
||||
If you wish to create a table for Dapr to use, you can do so beforehand. However, Table Storage state provider will create one for you automatically if it doesn't exist.
|
||||
|
||||
|
|
@ -79,7 +79,7 @@ will create the following record in a table:
|
|||
|
||||
## Concurrency
|
||||
|
||||
Azure Table Storage state concurrency is achieved by using `ETag`s according to [the official documentation]( https://docs.microsoft.com/en-us/azure/storage/common/storage-concurrency#managing-concurrency-in-table-storage).
|
||||
Azure Table Storage state concurrency is achieved by using `ETag`s according to [the official documentation]( https://docs.microsoft.com/azure/storage/common/storage-concurrency#managing-concurrency-in-table-storage).
|
||||
|
||||
|
||||
## Related links
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| client_x509_cert_url | Y | The client certificate URL | `"https://www.googleapis.com/robot/v1/metadata/x509/x"`
|
||||
| entity_kind | N | The entity name in Filestore. Defaults to `"DaprState"` | `"DaprState"`
|
||||
|
||||
## Setup GCP Firestone
|
||||
## Setup GCP Firestore
|
||||
|
||||
{{< tabs "Self-Hosted" "Google Cloud" >}}
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ spec:
|
|||
- name: connectionString
|
||||
value: <REPLACE-WITH-CONNECTION-STRING> # Required.
|
||||
- name: tableName
|
||||
value: <REPLACE-WITH-TABLE-NAME> # Required.
|
||||
value: <REPLACE-WITH-TABLE-NAME> # Optional. defaults to "state"
|
||||
- name: keyType
|
||||
value: <REPLACE-WITH-KEY-TYPE> # Optional. defaults to "string"
|
||||
- name: keyLength
|
||||
|
|
@ -52,8 +52,8 @@ If you wish to use SQL server as an [actor state store]({{< ref "state_api.md#co
|
|||
|
||||
| Field | Required | Details | Example |
|
||||
|--------------------|:--------:|---------|---------|
|
||||
| connectionString | Y | The connection string used to connect | `"Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"`
|
||||
| tableName | Y | The name of the table to use. Alpha-numeric with underscores | `"table_name"`
|
||||
| connectionString | Y | The connection string used to connect. If the connection string contains the database it must already exist. If the database is omitted a default database named `"Dapr"` is created. | `"Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"`
|
||||
| tableName | N | The name of the table to use. Alpha-numeric with underscores. Defaults to `"state"` | `"table_name"`
|
||||
| keyType | N | The type of key used. Defaults to `"string"` | `"string"`
|
||||
| keyLength | N | The max length of key. Used along with `"string"` keytype. Defaults to `"200"` | `"200"`
|
||||
| schema | N | The schema to use. Defaults to `"dbo"` | `"dapr"`,`"dbo"`
|
||||
|
|
@ -69,7 +69,7 @@ If you wish to use SQL server as an [actor state store]({{< ref "state_api.md#co
|
|||
|
||||
In order to setup SQL Server as a state store, you need the following properties:
|
||||
|
||||
- **Connection String**: the SQL Server connection string. For example: server=localhost;user id=sa;password=your-password;port=1433;database=mydatabase;
|
||||
- **Connection String**: The SQL Server connection string. For example: server=localhost;user id=sa;password=your-password;port=1433;database=mydatabase;
|
||||
- **Schema**: The database schema to use (default=dbo). Will be created if does not exist
|
||||
- **Table Name**: The database table name. Will be created if does not exist
|
||||
- **Indexed Properties**: Optional properties from json data which will be indexed and persisted as individual column
|
||||
|
|
|
|||
|
|
@ -8,12 +8,13 @@ weight: 300
|
|||
|
||||
The following table lists the environment variables used by the Dapr runtime, CLI, or from within your application:
|
||||
|
||||
| Environment Variable | Used By | Description |
|
||||
|----------------------------------|------------------|-------------|
|
||||
| DAPR_HTTP_PORT | Your application | The HTTP port that Dapr is listening on. Your application should use this variable to connect to Dapr instead of hardcoding the port value. Injected by the `dapr-sidecar-injector` into all the containers in the pod.
|
||||
| DAPR_GRPC_PORT | Your application | The gRPC port that Dapr is listening on. Your application should use this variable to connect to Dapr instead of hardcoding the port value. Injected by the `dapr-sidecar-injector` into all the containers in the pod.
|
||||
| DAPR_TOKEN_API | Your application | The token used for Dapr API authentication for requests from the application. Read [enable API token authentication in Dapr]({{< ref api-token >}}) for more information.
|
||||
| APP_TOKEN_API | Your application | The token used by the app to authenticate requests from Dapr. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information.
|
||||
| DAPR_PLACEMENT_HOST |Your application | The address for the Dapr Placement service. Only needed in self-hosted mode if you run your app (which creates actors) and you want to tell the app the location of the Placement service. This is never needed outside of local machine development.
|
||||
| DAPR_NETWORK | Dapr CLI | Optionally used by the Dapr CLI to specify the Docker network on which to deploy the Dapr runtime.
|
||||
| NAMESPACE | Dapr runtime | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}})
|
||||
| Environment Variable | Used By | Description |
|
||||
| -------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| APP_ID | Your application | The id for your application, used for service discovery |
|
||||
| APP_PORT | Your application | The port your application is listening on |
|
||||
| APP_API_TOKEN | Your application | The token used by the application to authenticate requests from Dapr API. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information. |
|
||||
| DAPR_HTTP_PORT | Your application | The HTTP port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self hosted or injected by the dapr-sidecar-injector into all the containers in the pod. |
|
||||
| DAPR_GRPC_PORT | Your application | The gRPC port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self hosted or injected by the dapr-sidecar-injector into all the containers in the pod. |
|
||||
| DAPR_METRICS_PORT | Your application | The HTTP [Prometheus]({{< ref prometheus >}}) port that Dapr sends its metrics information to. Your application can use this variable to send its application specific metrics to have both Dapr metrics and application metrics together. See [metrics-port]({{< ref arguments-annotations-overview>}}) for more information |
|
||||
| DAPR_API_TOKEN | Dapr sidecar | The token used for Dapr API authentication for requests from the application. Read [enable API token authentication in Dapr]({{< ref api-token >}}) for more information. |
|
||||
| NAMESPACE | Dapr sidecar | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}}) |
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
{{ define "main" }}
|
||||
<div class="td-content">
|
||||
<h1>{{ .Title }}</h1>
|
||||
{{ with .Params.description }}<div class="lead">{{ . | markdownify }}</div>{{ end }}
|
||||
<h1>{{ .LinkTitle }}</h1>
|
||||
{{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) }}
|
||||
{{ partial "reading-time.html" . }}
|
||||
{{ end }}
|
||||
|
|
|
|||
|
|
@ -2,7 +2,8 @@
|
|||
{{ $page := .Get "page" }}
|
||||
{{ $link := .Get "link" | default "#" }}
|
||||
{{ $text := .Get "text" }}
|
||||
{{ $newtab := .Get "newtab" | default "false" }}
|
||||
|
||||
{{- if $page -}}{{- $link = ref . $page -}}{{- end -}}
|
||||
|
||||
<a class="btn btn-{{ $color }}" href="{{ $link }}" role="button">{{ $text }}</a>
|
||||
<a class="btn btn-{{ $color }}" href="{{ $link }}" role="button" {{- if eq $newtab "true" -}}target="_blank"{{- end -}}>{{ $text }}</a>
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
{{- if .Get "short" }}1.4{{ else if .Get "long" }}1.4.1{{ else if .Get "cli" }}1.4.0{{ else }}1.4.1{{ end -}}
|
||||
{{- if .Get "short" }}1.4{{ else if .Get "long" }}1.4.3{{ else if .Get "cli" }}1.4.0{{ else }}1.4.3{{ end -}}
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Loading…
Reference in New Issue