diff --git a/daprdocs/content/en/getting-started/get-started-api.md b/daprdocs/content/en/getting-started/get-started-api.md index 8fa005dca6c..a785812c4d2 100644 --- a/daprdocs/content/en/getting-started/get-started-api.md +++ b/daprdocs/content/en/getting-started/get-started-api.md @@ -3,10 +3,11 @@ type: docs title: "Use the Dapr API" linkTitle: "Use the Dapr API" weight: 30 -description: "Run a Dapr sidecar and try out the state API" +description: "Run a Dapr sidecar and try out the state management API" --- -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: +In this guide, you'll simulate an application by running the sidecar and calling the state management API directly. +After running Dapr using the Dapr CLI, you'll: - Save a state object. - Read/get the state object. @@ -21,7 +22,8 @@ In this guide, you'll simulate an application by running the sidecar and calling ### Step 1: Run the Dapr sidecar -The [`dapr run`]({{< ref dapr-run.md >}}) command launches an application, together with a sidecar. +The [`dapr run`]({{< ref dapr-run.md >}}) command normally runs your application and a Dapr sidecar. In this case, +it only runs the sidecar since you are interacting with the state management API directly. Launch a Dapr sidecar that will listen on port 3500 for a blank application named `myapp`: diff --git a/daprdocs/content/en/getting-started/install-dapr-cli.md b/daprdocs/content/en/getting-started/install-dapr-cli.md index df9b25d69d0..21f17968973 100644 --- a/daprdocs/content/en/getting-started/install-dapr-cli.md +++ b/daprdocs/content/en/getting-started/install-dapr-cli.md @@ -15,6 +15,11 @@ You'll use the Dapr CLI as the main tool for various Dapr-related tasks. You can The Dapr CLI works with both [self-hosted]({{< ref self-hosted >}}) and [Kubernetes]({{< ref Kubernetes >}}) environments. +{{% alert title="Before you begin" color="primary" %}} +In Docker Desktop's advanced options, verify you've allowed the default Docker socket to be used. + +{{% /alert %}} + ### Step 1: Install the Dapr CLI {{< tabs Linux Windows MacOS Binaries>}} diff --git a/daprdocs/content/en/getting-started/install-dapr-selfhost.md b/daprdocs/content/en/getting-started/install-dapr-selfhost.md index 7ffa33f2c29..b3b61be3277 100644 --- a/daprdocs/content/en/getting-started/install-dapr-selfhost.md +++ b/daprdocs/content/en/getting-started/install-dapr-selfhost.md @@ -27,7 +27,7 @@ To initialize Dapr in your local or remote **Kubernetes** cluster for developmen {{% /alert %}} {{% alert title="Docker" color="primary" %}} -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. +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. You can also install [Podman](https://podman.io/) in place of Docker. Read more about [initializing Dapr using Podman]({{< ref dapr-init.md >}}). {{% /alert %}} @@ -70,7 +70,7 @@ dapr init **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. 1. Navigate to **Docker Desktop** > **Settings** > **Advanced**. -1. Select the **Enable default Docker socket** checkbox. +1. Select the **Allow the default Docker socket to be used (requires password)** checkbox. {{% /codetab %}} @@ -86,6 +86,7 @@ dapr init {{< /tabs >}} +[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" >}}) ### Step 3: Verify Dapr version diff --git a/daprdocs/content/en/operations/security/api-token.md b/daprdocs/content/en/operations/security/api-token.md index aa30b39750e..2722f67a5fc 100644 --- a/daprdocs/content/en/operations/security/api-token.md +++ b/daprdocs/content/en/operations/security/api-token.md @@ -88,7 +88,11 @@ kubectl rollout restart deployment/ --namespace **Note:** The Dapr SDKs read the [DAPR_API_TOKEN]({{< ref environment >}}) environment variable and set it for you by default. + + ### HTTP diff --git a/daprdocs/content/en/operations/security/app-api-token.md b/daprdocs/content/en/operations/security/app-api-token.md index d94e325139f..9a9264ed267 100644 --- a/daprdocs/content/en/operations/security/app-api-token.md +++ b/daprdocs/content/en/operations/security/app-api-token.md @@ -89,11 +89,13 @@ kubectl rollout restart deployment/ --namespace ` 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. + + ### HTTP -In case of HTTP, in your code look for the HTTP header `dapr-api-token` in incoming requests: +In your code, look for the HTTP header `dapr-api-token` in incoming requests: ```text dapr-api-token: diff --git a/daprdocs/content/en/operations/troubleshooting/common_issues.md b/daprdocs/content/en/operations/troubleshooting/common_issues.md index 346b680c68f..40281dd2fee 100644 --- a/daprdocs/content/en/operations/troubleshooting/common_issues.md +++ b/daprdocs/content/en/operations/troubleshooting/common_issues.md @@ -6,6 +6,24 @@ weight: 1000 description: "Common issues and problems faced when running Dapr applications" --- +This guide covers common issues you may encounter while installing and running Dapr. + +## Dapr can't connect to Docker when installing the Dapr CLI + +When installing and initializing the Dapr CLI, if you see the following error message after running `dapr init`: + +```bash +⌛ Making the jump to hyperspace... +❌ could not connect to docker. docker may not be installed or running +``` + +Troubleshoot the error by ensuring: + +1. [The correct containers are running.]({{< ref "install-dapr-selfhost.md#step-4-verify-containers-are-running" >}}) +1. In Docker Desktop, verify the **Allow the default Docker socket to be used (requires password)** option is selected. + + + ## I don't see the Dapr sidecar injected to my pod There could be several reasons to why a sidecar will not be injected into a pod. diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md index 73b9cc00633..b833301b2ea 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md @@ -43,8 +43,8 @@ The above example uses secrets as plain strings. It is recommended to use a secr | 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"` | consumerID | N | The consumer group ID | `"myGroup"` | enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` -| redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` -| processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` +| 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"` +| 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"` | queueDepth | N | The size of the message queue for processing. Defaults to `"100"`. | `"1000"` | concurrency | N | The number of concurrent workers that are processing messages. Defaults to `"10"`. | `"15"` | 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"` diff --git a/daprdocs/static/images/docker-desktop-setting.png b/daprdocs/static/images/docker-desktop-setting.png new file mode 100644 index 00000000000..1e5b6e54206 Binary files /dev/null and b/daprdocs/static/images/docker-desktop-setting.png differ diff --git a/daprdocs/static/images/tokens-auth.png b/daprdocs/static/images/tokens-auth.png new file mode 100644 index 00000000000..0eb566d7cfd Binary files /dev/null and b/daprdocs/static/images/tokens-auth.png differ diff --git a/daprdocs/static/presentations/dapr-slidedeck.pptx.zip b/daprdocs/static/presentations/dapr-slidedeck.pptx.zip index 6ef5a3b8720..27df424b293 100644 Binary files a/daprdocs/static/presentations/dapr-slidedeck.pptx.zip and b/daprdocs/static/presentations/dapr-slidedeck.pptx.zip differ