https://github.com/neuroforgede/docker-swarm-proxy
What if you wanted a docker exec, but for Docker swarm? - Control any node in the swarm from your CLI
https://github.com/neuroforgede/docker-swarm-proxy
cli devops devops-tools docker docker-cli-plugin docker-swarm docker-swarm-mode plugin swarm
Last synced: 8 days ago
JSON representation
What if you wanted a docker exec, but for Docker swarm? - Control any node in the swarm from your CLI
- Host: GitHub
- URL: https://github.com/neuroforgede/docker-swarm-proxy
- Owner: neuroforgede
- License: mit
- Created: 2023-06-15T21:17:46.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-12T17:55:00.000Z (almost 2 years ago)
- Last Synced: 2025-04-02T21:12:35.705Z (13 days ago)
- Topics: cli, devops, devops-tools, docker, docker-cli-plugin, docker-swarm, docker-swarm-mode, plugin, swarm
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 34
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-swarm - docker-swarm-proxy - CLI plugin to that allows to exec into services. `docker exec` for Swarm. (Community Tools / Extra Functionality)
README
# docker-swarm-proxy
What if you wanted a docker exec, but for Docker swarm?
A problem with Docker Swarm and automation with it has been that you can't directly exec into any service from the command line. There exist some workarounds to achieve this behaviour, but in the end you want something similar and as convenient as `docker exec` but for services.
## Installation
### Prerequisites
Install docker-py and click:
```bash
pip3 install docker
pip3 install click
```
Install the plugin your docker cli (from github)
```bash
rm ~/.docker/cli-plugins/docker-swarmproxy
curl -L https://raw.githubusercontent.com/neuroforgede/docker-swarm-proxy/master/docker_swarm_proxy.py -o ~/.docker/cli-plugins/docker-swarmproxy
chmod +x ~/.docker/cli-plugins/docker-swarmproxy
```
Or copy from a local copy of this repo:
```bash
cp docker_swarm_proxy.py ~/.docker/cli-plugins/docker-swarmproxy
chmod +x ~/.docker/cli-plugins/docker-swarmproxy
```
## Usage
NOTE: For remote clusters, only usage of the DOCKER_HOST environment variable is supported. Usage of Docker Contexts for switching environments is not supported. For remote clusters we strongly advise against exposing the TCP socket directly. Instead use the SSH tunneling support of docker cli as described [here](https://docs.docker.com/engine/security/protect-access/).
### Exec into a running service
```bash
docker swarmproxy service exec -it vibrant_bell bash
```
See all available options:
```bash
docker swarmproxy service exec --help
```
### Use `-` in the command
Since swarmproxy uses click under the hood for argument parsing, you have to use `--` before any exec command.
This will not work:
```bash
docker swarmproxy service exec -it vibrant_bell bash -c 'echo hello'
```
This will work:
```bash
docker swarmproxy service exec -it vibrant_bell -- bash -c 'echo hello'
```