Skip to content

Commit

Permalink
Add full list of used Docker APIs to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
m90 committed Feb 4, 2024
1 parent 0299382 commit 2f2f8c7
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/how-tos/use-custom-docker-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,24 @@ If you are interfacing with Docker via TCP, set `DOCKER_HOST` to the correct URL
DOCKER_HOST=tcp://docker_socket_proxy:2375
```

In case you are using [`docker-socket-proxy`][proxy], the following permissions are required:
If you do this as you seek to restrict access to the Docker socket, this tool is potentially calling the following Docker APIs:

| API | When |
|-|-|
| `Info` | always |
| `ContainerExecCreate` | running commands from `exec-labels` |
| `ContainerExecAttach` | running commands from `exec-labels` |
| `ContainerExecInspect` | running commands from `exec-labels` |
| `ContainerList` | always |
`ServiceList` | Docker engine is running in Swarm mode |
| `ServiceInspect` | Docker engine is running in Swarm mode |
| `ServiceUpdate` | Docker engine is running in Swarm mode and `stop-during-backup` is used |
| `ConatinerStop` | `stop-during-backup` labels are applied to containers |
| `ContainerStart` | `stop-during-backup` labels are applied to container |

---

In case you are using [`docker-socket-proxy`][proxy], this means following permissions are required:

| Permission | When |
|-|-|
Expand Down

0 comments on commit 2f2f8c7

Please sign in to comment.