moby / moby/libnetwork

Document how a network driver plugin confirms exposed ports

Open
#2,451 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
2.2k
Forks
875
PR merge metrics
No merged PRs in 30d

Description

In this example request, I see the information needed to expose container ports in the undocumented 'Options' keys. I cannot tell how I would tell the docker daemon that the ports had been exposed so that they will be displayed, for example in docker ps.

How can a docker network plugin return the port mapping so that it appears in docker ps and docker inspect?

{'EndpointID': 'd2cd7f8fa079d4af8450985a76bcd82cac268da469ceed3366f2fba373524bda',
 'NetworkID': 'de18f6d7edf488138815ae7fc8412be6ad88774e5e5ee041232fc8a96eff59e7',
 'Options': {'com.docker.network.endpoint.exposedports': [{'Port': 80,
                                                           'Proto': 6}],
             'com.docker.network.portmap': [{'HostIP': '',
                                             'HostPort': 0,
                                             'HostPortEnd': 0,
                                             'IP': '',
                                             'Port': 80,
                                             'Proto': 6}]},
 'SandboxKey': '/var/run/docker/netns/7541c34f2dc7'}

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

Start with the network-plugin example and the Options keys shown in the issue, then compare the behavior of docker ps and docker inspect. Document how a plugin confirms exposed ports and returns the port mapping, including the expected result in both commands; no target file or test is named.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation, networking
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.