Tecnativa / Tecnativa/docker-socket-proxy

Docs on Swarm need to point out it must be deployed on manager nodes

Open
#67 0 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.8k
Forks
207
PR merge metrics
No merged PRs in 30d

Description

In Docker Swarm, the docker socket only exists on manager nodes, so this was failing sporadically for me without much explanation until I realized it was whenever the proxy was deployed to a worker node. Here are the constraints required in docker compose format:

 deploy:
      mode: global
      placement:
        constraints:
          - node.role == manager

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Docker Swarm deployment documentation and review how proxy placement is currently described. Document that the proxy must run on manager nodes because the Docker socket is only available there, including the manager-node placement constraints shown in the issue. Done means the deployment guidance explains the worker-node failure and the required constraint.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.