Skip to content

Commit 87c70c0

Browse files
authored
Merge branch 'v1.12' into issue_3965_1.12
2 parents 8d63baa + abdb980 commit 87c70c0

File tree

10 files changed

+42
-10
lines changed

10 files changed

+42
-10
lines changed

daprdocs/content/en/getting-started/get-started-api.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ type: docs
33
title: "Use the Dapr API"
44
linkTitle: "Use the Dapr API"
55
weight: 30
6-
description: "Run a Dapr sidecar and try out the state API"
6+
description: "Run a Dapr sidecar and try out the state management API"
77
---
88

9-
In this guide, you'll simulate an application by running the sidecar and calling the API directly. After running Dapr using the Dapr CLI, you'll:
9+
In this guide, you'll simulate an application by running the sidecar and calling the state management API directly.
10+
After running Dapr using the Dapr CLI, you'll:
1011

1112
- Save a state object.
1213
- Read/get the state object.
@@ -21,7 +22,8 @@ In this guide, you'll simulate an application by running the sidecar and calling
2122

2223
### Step 1: Run the Dapr sidecar
2324

24-
The [`dapr run`]({{< ref dapr-run.md >}}) command launches an application, together with a sidecar.
25+
The [`dapr run`]({{< ref dapr-run.md >}}) command normally runs your application and a Dapr sidecar. In this case,
26+
it only runs the sidecar since you are interacting with the state management API directly.
2527

2628
Launch a Dapr sidecar that will listen on port 3500 for a blank application named `myapp`:
2729

daprdocs/content/en/getting-started/install-dapr-cli.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ You'll use the Dapr CLI as the main tool for various Dapr-related tasks. You can
1515

1616
The Dapr CLI works with both [self-hosted]({{< ref self-hosted >}}) and [Kubernetes]({{< ref Kubernetes >}}) environments.
1717

18+
{{% alert title="Before you begin" color="primary" %}}
19+
In Docker Desktop's advanced options, verify you've allowed the default Docker socket to be used.
20+
<img src="/images/docker-desktop-setting.png" width=800 style="padding-bottom:15px;">
21+
{{% /alert %}}
22+
1823
### Step 1: Install the Dapr CLI
1924

2025
{{< tabs Linux Windows MacOS Binaries>}}

daprdocs/content/en/getting-started/install-dapr-selfhost.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To initialize Dapr in your local or remote **Kubernetes** cluster for developmen
2727
{{% /alert %}}
2828

2929
{{% alert title="Docker" color="primary" %}}
30-
The recommended development environment requires [Docker](https://docs.docker.com/install/). While you can [initialize Dapr without a dependency on Docker]({{< ref self-hosted-no-docker.md >}})), the next steps in this guide assume the recommended Docker development environment.
30+
The recommended development environment requires [Docker](https://docs.docker.com/install/). While you can [initialize Dapr without a dependency on Docker]({{< ref self-hosted-no-docker.md >}}), the next steps in this guide assume the recommended Docker development environment.
3131

3232
You can also install [Podman](https://podman.io/) in place of Docker. Read more about [initializing Dapr using Podman]({{< ref dapr-init.md >}}).
3333
{{% /alert %}}
@@ -70,7 +70,7 @@ dapr init
7070

7171
**If you are installing on Mac OS Silicon with Docker,** you may need to perform the following workaround to enable `dapr init` to talk to Docker without using Kubernetes.
7272
1. Navigate to **Docker Desktop** > **Settings** > **Advanced**.
73-
1. Select the **Enable default Docker socket** checkbox.
73+
1. Select the **Allow the default Docker socket to be used (requires password)** checkbox.
7474

7575
{{% /codetab %}}
7676

@@ -86,6 +86,7 @@ dapr init
8686

8787
{{< /tabs >}}
8888

89+
[See the troubleshooting guide if you encounter any error messages regarding Docker not being installed or running.]({{< ref "common_issues.md#dapr-cant-connect-to-docker-when-installing-the-dapr-cli" >}})
8990

9091
### Step 3: Verify Dapr version
9192

daprdocs/content/en/operations/security/api-token.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,11 @@ kubectl rollout restart deployment/<deployment-name> --namespace <namespace-name
8888

8989
## Adding API token to client API invocations
9090

91-
Once token authentication is configured in Dapr, all clients invoking Dapr API will have to append the API token token to every request:
91+
Once token authentication is configured in Dapr, all clients invoking Dapr API need to append the `dapr-api-token` token to every request.
92+
93+
> **Note:** The Dapr SDKs read the [DAPR_API_TOKEN]({{< ref environment >}}) environment variable and set it for you by default.
94+
95+
<img src="/images/tokens-auth.png" width=800 style="padding-bottom:15px;">
9296

9397
### HTTP
9498

daprdocs/content/en/operations/security/app-api-token.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,13 @@ kubectl rollout restart deployment/<deployment-name> --namespace <namespace-name
8989

9090
## Authenticating requests from Dapr
9191

92-
Once app token authentication is configured in Dapr, all requests *coming from Dapr* include the token.
92+
Once app token authentication is configured using the environment variable or Kubernetes secret `app-api-token`, the Dapr sidecar always includes the HTTP header/gRPC metadata `dapr-api-token: <token>` in the calls to the app. From the app side, ensure you are authenticating using the `dapr-api-token` value which uses the `app-api-token` you set to authenticate requests from Dapr.
93+
94+
<img src="/images/tokens-auth.png" width=800 style="padding-bottom:15px;">
9395

9496
### HTTP
9597

96-
In case of HTTP, in your code look for the HTTP header `dapr-api-token` in incoming requests:
98+
In your code, look for the HTTP header `dapr-api-token` in incoming requests:
9799

98100
```text
99101
dapr-api-token: <token>

daprdocs/content/en/operations/troubleshooting/common_issues.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,24 @@ weight: 1000
66
description: "Common issues and problems faced when running Dapr applications"
77
---
88

9+
This guide covers common issues you may encounter while installing and running Dapr.
10+
11+
## Dapr can't connect to Docker when installing the Dapr CLI
12+
13+
When installing and initializing the Dapr CLI, if you see the following error message after running `dapr init`:
14+
15+
```bash
16+
⌛ Making the jump to hyperspace...
17+
❌ could not connect to docker. docker may not be installed or running
18+
```
19+
20+
Troubleshoot the error by ensuring:
21+
22+
1. [The correct containers are running.]({{< ref "install-dapr-selfhost.md#step-4-verify-containers-are-running" >}})
23+
1. In Docker Desktop, verify the **Allow the default Docker socket to be used (requires password)** option is selected.
24+
25+
<img src="/images/docker-desktop-setting.png" width=800 style="padding-bottom:15px;">
26+
927
## I don't see the Dapr sidecar injected to my pod
1028

1129
There could be several reasons to why a sidecar will not be injected into a pod.

daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ The above example uses secrets as plain strings. It is recommended to use a secr
4343
| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"`
4444
| consumerID | N | The consumer group ID | `"myGroup"`
4545
| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"`
46-
| redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"`
47-
| processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"`
46+
| redeliverInterval | N | The interval between checking for pending messages to redeliver. Can use either be Go duration string (for example "ms", "s", "m") or milliseconds number. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"`, `"5000"`
47+
| processingTimeout | N | The amount time that a message must be pending before attempting to redeliver it. Can use either be Go duration string ( for example "ms", "s", "m") or milliseconds number. Defaults to `"15s"`. `"0"` disables redelivery. | `"60s"`, `"600000"`
4848
| queueDepth | N | The size of the message queue for processing. Defaults to `"100"`. | `"1000"`
4949
| concurrency | N | The number of concurrent workers that are processing messages. Defaults to `"10"`. | `"15"`
5050
| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"`
255 KB
Loading
23.6 KB
Loading
871 KB
Binary file not shown.

0 commit comments

Comments
 (0)