Skip to content

Commit a37df8c

Browse files
Add documentation for docker desktop issues (#194)
* Update troubleshooting section to document 2 recent Docker Desktop issues * Update CLI installation section to replace an specific error infobox by a link to the troubleshooting section
1 parent 236e676 commit a37df8c

File tree

4 files changed

+30
-3
lines changed

4 files changed

+30
-3
lines changed
Loading
Loading

docs/user-guide/leverage-cli/installation.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ To use Leverage CLI you need to install it from the Python Package Index (Pypi).
77
* [x] **Git** `>= 2.25`
88
* [x] **Docker engine** `>= 20.x.y`
99

10-
!!! warning "Docker daemon doesn't seem to be responding"
11-
If you are using Docker Desktop on macOS 12.5 or above, right click on your Docker Desktop task bar icon,
12-
then “Settings …“, under “General” , make sure to choose osxfs (legacy) as your file sharing implementation.
10+
!!! warning "Having issues with the CLI?"
11+
Check out [the troubleshooting section](/user-guide/troubleshooting/general) to find more help.
1312

1413
###Install Pip
1514

docs/user-guide/troubleshooting/general.md

+28
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,31 @@ Matching host key in /root/.ssh/known_hosts:xyw
3838
Are you sure you want to continue connecting (yes/no)?
3939
```
4040
You may have more than 1 key associated to the `YYY` host. Remove the old or incorrect one, and the dialog should stop.
41+
42+
## Leverage CLI can't find the Docker daemon
43+
44+
The Leverage CLI talks to the Docker API which usually runs as a daemon on your machine. Here's an example of the error:
45+
```
46+
$ leverage tf shell
47+
[17:06:13.754] ERROR Docker daemon doesn't seem to be responding. Please check it is up and running correctly before re-running the command.
48+
```
49+
50+
We've seen this happen after a Docker Desktop upgrade. Defaults are changed and the Docker daemon no longer uses Unix sockets but TCP, or perhaps it does use Unix sockets but under a different path or user.
51+
52+
What has worked for us in order to fix the issue is to make sure the following setting is enabled:
53+
![docket-daemon-not-responding](/assets/images/screenshots/leverage-docket-desktop-daemon-issue.png "Docker daemon not responding")
54+
55+
Note: that setting can be accessed by clicking on the Docker Desktop icon tray, and then clicking on "Settings...". Then click on the "Advanced" tab to find the checkbox.
56+
57+
## Leverage CLI fails to mount the SSH directory
58+
59+
The Leverage CLI mounts the `~/.ssh` directory in order to make the pulling of private Terraform modules work. The error should look similar to the following:
60+
```
61+
[18:26:44.416] ERROR Error creating container:
62+
APIError: 400 Client Error for http+docker://localhost/v1.43/containers/create: Bad Request ("invalid mount config for type "bind": stat /host_mnt/private/tmp/com.apple.launchd.CWrsoki5yP/Listeners: operation not supported")
63+
```
64+
65+
The problem happes because of the file system virtualization that is used by default and can be fixed by choosing the "osxfs (Legacy)" option as shown below:
66+
![docket-daemon-not-responding](/assets/images/screenshots/leverage-docket-desktop-daemon-issue.png "Docker daemon not responding")
67+
68+
Note: that setting can be accessed by clicking on the Docker Desktop icon tray, and then clicking on "Settings...". The setting should be in the "General" tab.

0 commit comments

Comments
 (0)