Skip to content

Commit 8e137d6

Browse files
authored
Merge pull request #4051 from hhunter-ms/issue_3540
Add pre-reqs and section in troubleshooting guide for `dapr init`
2 parents 5cd8da4 + 6e1e74e commit 8e137d6

File tree

4 files changed

+26
-2
lines changed

4 files changed

+26
-2
lines changed

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

+5
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

+3-2
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/troubleshooting/common_issues.md

+18
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.
Loading

0 commit comments

Comments
 (0)