mirror of https://github.com/dapr/docs.git
Merge branch 'v1.9' into greenie-msft-patch-7
This commit is contained in:
Hannah Hunter
GitHub
commit
5665fbab1c
|
|
@ -27,7 +27,7 @@ disableKinds = ["taxonomy", "term"]
|
|||
|
||||
# Google Analytics
|
||||
[services.googleAnalytics]
|
||||
id = "UA-149338238-3"
|
||||
id = "G-60C6Q1ETC1"
|
||||
|
||||
# Mounts
|
||||
[module]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Resiliency"
|
||||
linkTitle: "Resiliency"
|
||||
weight: 400
|
||||
description: "Configure policies and monitor app and sidecar health"
|
||||
---
|
||||
|
||||
Distributed applications are commonly comprised of many microservices, with dozens - sometimes hundreds - of instances scaling across underlying infrastructure. As these distributed solutions grow in size and complexity, the potential for system failures inevitably increases. Service instances can fail or become unresponsive due to any number of issues, including hardware failures, unexpected throughput, or application lifecycle events, such as scaling out and application restarts. Designing and implementing a self-healing solution with the ability to detect, mitigate, and respond to failure is critical.
|
||||
|
||||
## Resiliency Policies
|
||||
<img src="/images/resiliency_diagram.png" width="1200" alt="Diagram showing the resiliency applied to Dapr APIs">
|
||||
|
||||
Dapr provides a capability for defining and applying fault tolerance resiliency policies to your application. You can define policies for following resiliency patterns:
|
||||
|
||||
- Timeouts
|
||||
- Retries/back-offs
|
||||
- Circuit breakers
|
||||
|
||||
These policies can be applied to any Dapr API calls when calling components with a [resiliency spec]({{< ref resiliency-overview >}}).
|
||||
|
||||
## App Health Checks
|
||||
<img src="/images/observability-app-health.webp" width="800" alt="Diagram showing the app health feature. Running Dapr with app health enabled causes Dapr to periodically probe the app for its health">
|
||||
|
||||
Applications can become unresponsive for a variety of reasons. For example, they are too busy to accept new work, could have crashed, or be in a deadlock state. Sometimes the condition can be transitory or persistent.
|
||||
|
||||
Dapr provides a capability for monitoring app health through probes that check the health of your application and react to status changes. When an unhealthy app is detected, Dapr stops accepting new work on behalf of the application.
|
||||
|
||||
Read more on how to apply [app health checks]({{< ref app-health >}}) to your application.
|
||||
|
||||
## Sidecar Health Checks
|
||||
<img src="/images/sidecar-health.png" width="800" alt="Diagram showing the app health feature. Running Dapr with app health enabled causes Dapr to periodically probe the app for its health">
|
||||
|
||||
Dapr provides a way to determine its health using an [HTTP `/healthz` endpoint]({{< ref health_api.md >}}). With this endpoint, the *daprd* process, or sidecar, can be:
|
||||
|
||||
- Probed for its health
|
||||
- Determined for readiness and liveness
|
||||
|
||||
Read more on about how to apply [dapr health checks]({{< ref sidecar-health >}}) to your application.
|
||||
|
|
@ -6,7 +6,7 @@ weight: 200
|
|||
description: Dapr sidecar health checks
|
||||
---
|
||||
|
||||
Dapr provides a way to [determine its health using an [HTTP `/healthz` endpoint]({{< ref health_api.md >}}). With this endpoint, the *daprd* process, or sidecar, can be:
|
||||
Dapr provides a way to determine its health using an [HTTP `/healthz` endpoint]({{< ref health_api.md >}}). With this endpoint, the *daprd* process, or sidecar, can be:
|
||||
|
||||
- Probed for its health
|
||||
- Determined for readiness and liveness
|
||||
|
|
|
|||
|
|
@ -84,7 +84,7 @@ To start, create a new Azure AD application, which will also be used as Service
|
|||
|
||||
Prerequisites:
|
||||
|
||||
- [Azure Subscription](https://azure.microsoft.com/free/)
|
||||
- Azure Subscription
|
||||
- [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli)
|
||||
- [jq](https://stedolan.github.io/jq/download/)
|
||||
- OpenSSL (included by default on all Linux and macOS systems, as well as on WSL)
|
||||
|
|
|
|||
|
|
@ -6,6 +6,6 @@ description: "Publish APIs for Dapr services and components through Azure API Ma
|
|||
weight: 2000
|
||||
---
|
||||
|
||||
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).
|
||||
Azure API Management (APIM) is a way to create consistent and modern API gateways for back-end services, including 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/azure/api-management/api-management-dapr-policies" >}}
|
||||
|
|
|
|||
|
|
@ -64,9 +64,7 @@ For Kubernetes:
|
|||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
<!-- IGNORE_LINKS -->
|
||||
Verify you have an [Azure subscription](https://azure.microsoft.com/free/).
|
||||
<!-- END_IGNORE -->
|
||||
Verify you have an Azure subscription.
|
||||
|
||||
1. Open and log into the [Azure portal](https://ms.portal.azure.com/#create/Microsoft.Cache) to start the Azure Redis Cache creation flow.
|
||||
1. Fill out the necessary information.
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ description: "Configure Dapr retries, timeouts, and circuit breakers"
|
|||
Resiliency is currently a preview feature. Before you can utilize a resiliency spec, you must first [enable the resiliency preview feature]({{< ref support-preview-features >}}).
|
||||
{{% /alert %}}
|
||||
|
||||
Distributed applications are commonly comprised of many microservices, with dozens, even hundreds, of instances for any given application. With so many microservices, the likelihood of a system failure increases. For example, an instance can fail or be unresponsive due to hardware, an overwhelming number of requests, application restarts/scale outs, or several other reasons. These events can cause a network call between services to fail. Designing and implementing your application with fault tolerance, the ability to detect, mitigate, and respond to failures, allows your application to recover to a functioning state and become self healing.
|
||||
|
||||
Dapr provides a capability for defining and applying fault tolerance resiliency policies via a [resiliency spec]({{< ref "resiliency-overview.md#complete-example-policy" >}}). Resiliency specs are saved in the same location as components specs and are applied when the Dapr sidecar starts. The sidecar determines how to apply resiliency policies to your Dapr API calls. In self-hosted mode, the resiliency spec must be named `resiliency.yaml`. In Kubernetes Dapr finds the named resiliency specs used by your application. Within the resiliency spec, you can define policies for popular resiliency patterns, such as:
|
||||
|
||||
- [Timeouts]({{< ref "policies.md#timeouts" >}})
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ The table below shows the versions of Dapr releases that have been tested togeth
|
|||
|
||||
| Release date | Runtime | CLI | SDKs | Dashboard | Status |
|
||||
|--------------------|:--------:|:--------|---------|---------|---------|
|
||||
| November 4th 2022 | 1.9.3</br> | 1.9.1 | Java 1.7.0 </br>Go 1.6.0 </br>PHP 1.1.0 </br>Python 1.8.3 </br>.NET 1.9.0 </br>JS 2.4.2 | 0.11.0 | Supported (current) |
|
||||
| November 1st 2022 | 1.9.2</br> | 1.9.1 | Java 1.7.0 </br>Go 1.6.0 </br>PHP 1.1.0 </br>Python 1.8.1 </br>.NET 1.9.0 </br>JS 2.4.2 | 0.11.0 | Supported (current) |
|
||||
| October 26th 2022 | 1.9.1</br> | 1.9.1 | Java 1.7.0 </br>Go 1.6.0 </br>PHP 1.1.0 </br>Python 1.8.1 </br>.NET 1.9.0 </br>JS 2.4.2 | 0.11.0 | Supported |
|
||||
| October 13th 2022 | 1.9.0</br> | 1.9.1 | Java 1.7.0 </br>Go 1.6.0 </br>PHP 1.1.0 </br>Python 1.8.3 </br>.NET 1.9.0 </br>JS 2.4.2 | 0.11.0 | Supported |
|
||||
|
|
@ -74,21 +75,18 @@ General guidance on upgrading can be found for [self hosted mode]({{< ref self-h
|
|||
|
||||
| Current Runtime version | Must upgrade through | Target Runtime version |
|
||||
|--------------------------|-----------------------|------------------------- |
|
||||
| 1.4.0 to 1.4.2 | N/A | 1.4.4 |
|
||||
| | 1.4.4 | 1.5.2 |
|
||||
| | 1.5.2 | 1.6.0 |
|
||||
| | 1.6.0 | 1.6.2 |
|
||||
| | 1.6.0 | 1.7.4 |
|
||||
| | 1.6.0 | 1.7.5 |
|
||||
| 1.5.0 to 1.5.2 | N/A | 1.6.0 |
|
||||
| | 1.6.0 | 1.6.2 |
|
||||
| | 1.6.0 | 1.7.4 |
|
||||
| | 1.6.0 | 1.7.5 |
|
||||
| 1.6.0 | N/A | 1.6.2 |
|
||||
| 1.6.0 | N/A | 1.7.5 |
|
||||
| 1.7.0 to 1.7.5 | N/A | 1.8.0 |
|
||||
| 1.8.0 | N/A | 1.8.6 |
|
||||
| 1.9.0 | N/A | 1.9.2 |
|
||||
| | 1.6.2 | 1.7.5 |
|
||||
| | 1.7.5 | 1.8.6 |
|
||||
| | 1.8.6 | 1.9.3 |
|
||||
| 1.6.0 to 1.6.2 | N/A | 1.7.5 |
|
||||
| | 1.7.5 | 1.8.6 |
|
||||
| | 1.8.6 | 1.9.3 |
|
||||
| 1.7.0 to 1.7.5 | N/A | 1.8.6 |
|
||||
| | 1.8.6 | 1.9.3 |
|
||||
| 1.8.0 to 1.8.6 | N/A | 1.9.3 |
|
||||
| 1.9.0 | N/A | 1.9.3 |
|
||||
|
||||
## Breaking changes and deprecations
|
||||
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ spec:
|
|||
- name: accessKey
|
||||
value: "[AccessKey]"
|
||||
- name: topicEndpoint
|
||||
value: "[TopicEndpoint]
|
||||
value: "[TopicEndpoint]"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
|
@ -102,7 +102,7 @@ _Make sure to also to add quotes around the `[HandshakePort]` in your Event Grid
|
|||
|
||||
```bash
|
||||
# Using random port 9000 as an example
|
||||
ngrok http -host-header=localhost 9000
|
||||
ngrok http --host-header=localhost 9000
|
||||
```
|
||||
|
||||
- Configure the ngrok's HTTPS endpoint and custom port to input binding metadata
|
||||
|
|
|
|||
|
|
@ -66,10 +66,14 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
This component supports **output binding** with the following operations:
|
||||
|
||||
- `create`
|
||||
- `get`
|
||||
- `delete`
|
||||
|
||||
### create
|
||||
|
||||
You can store a record in Redis using the `create` operation. This sets a key to hold a value. If the key already exists, the value is overwritten.
|
||||
|
||||
### Request
|
||||
#### Request
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -84,10 +88,58 @@ You can store a record in Redis using the `create` operation. This sets a key to
|
|||
}
|
||||
```
|
||||
|
||||
### Response
|
||||
#### Response
|
||||
|
||||
An HTTP 204 (No Content) and empty body is returned if successful.
|
||||
|
||||
### get
|
||||
|
||||
You can get a record in Redis using the `get` operation. This gets a key that was previously set.
|
||||
|
||||
#### Request
|
||||
|
||||
```json
|
||||
{
|
||||
"operation": "get",
|
||||
"metadata": {
|
||||
"key": "key1"
|
||||
},
|
||||
"data": {
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Response
|
||||
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"Hello": "World",
|
||||
"Lorem": "Ipsum"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### delete
|
||||
|
||||
You can delete a record in Redis using the `delete` operation. Returns success whether the key exists or not.
|
||||
|
||||
#### Request
|
||||
|
||||
```json
|
||||
{
|
||||
"operation": "delete",
|
||||
"metadata": {
|
||||
"key": "key1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Response
|
||||
|
||||
An HTTP 204 (No Content) and empty body is returned if successful.
|
||||
|
||||
|
||||
## Create a Redis instance
|
||||
|
||||
Dapr can use any Redis instance - containerized, running on your local dev machine, or a managed cloud service, provided the version of Redis is 5.0.0 or later.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
type: docs
|
||||
title: "AWS Secrets Manager"
|
||||
linkTitle: "AWS Secrets Manager"
|
||||
description: Detailed information on the decret store component
|
||||
description: Detailed information on the secret store component
|
||||
aliases:
|
||||
- "/operations/components/setup-secret-store/supported-secret-stores/aws-secret-manager/"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ Additionally, you must provide the authentication fields as explained in the [Au
|
|||
|
||||
### Prerequisites
|
||||
|
||||
- [Azure Subscription](https://azure.microsoft.com/free/)
|
||||
- Azure Subscription
|
||||
- [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli)
|
||||
- [jq](https://stedolan.github.io/jq/download/)
|
||||
- The scripts below are optimized for a bash or zsh shell
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
{{- if .Get "short" }}1.9{{ else if .Get "long" }}1.9.0{{ else if .Get "cli" }}1.9.0{{ else }}1.9.0{{ end -}}
|
||||
{{- if .Get "short" }}1.9{{ else if .Get "long" }}1.9.3{{ else if .Get "cli" }}1.9.0{{ else }}1.9.3{{ end -}}
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 316 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
Loading…
Reference in New Issue