Skip to content

Commit 1ebea6d

Browse files
authored
docs: Added the troubleshooting section and how to address the docker.sock issue on osx (#171)
Signed-off-by: Daniel Liszka <daniel@chainloop.dev>
1 parent 6d5405e commit 1ebea6d

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

devel/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,40 @@ You will get redirected to the pre-configured local OIDC provider (DEX) where th
7070

7171
Once logged in, please refer to our [Getting Started guide](https://docs.chainloop.dev/getting-started/setup) to learn how to setup an OCI registry.
7272

73+
## Troubleshooting
74+
75+
### Integration tests failing on OSX with Docker Desktop
76+
77+
You might be getting the following error on OSX with Docker Desktop:
78+
79+
```
80+
Cannot connect to the Docker daemon at unix:///var/run/docker.sock
81+
```
82+
83+
```
84+
$ cd chainloop
85+
$ make test
86+
[...]
87+
--- FAIL: TestVaultIntegration/TestReadWriteCredentials (0.00s)
88+
keyval_test.go:182:
89+
Error Trace: projects/chainloop/chainloop/internal/credentials/vault/keyval_test.go:182
90+
projects/chainloop/chainloop/internal/credentials/vault/keyval_test.go:207
91+
go/pkg/mod/github.com/stretchr/testify@v1.8.2/suite/suite.go:187
92+
Error: Received unexpected error:
93+
Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?: failed to create container
94+
Test: TestVaultIntegration/TestReadWriteCredentials
95+
suite.go:87: test panicked: runtime error: invalid memory address or nil pointer dereference
96+
[...]
97+
```
98+
99+
We use testcontainers for integration tests. You can check all requirements on [this page](https://www.testcontainers.org/supported_docker_environment/).
100+
101+
This is a known issue listed there:
102+
103+
"Docker Desktop Starting 4.13, run sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock"
104+
105+
Running the following command fixes the issue:
106+
107+
```
108+
sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock
109+
```

0 commit comments

Comments
 (0)