Overlay networking tutorial: confusing info about default network use
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 4.7k
- Forks
- 8.5k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 108
Description
Is this a docs issue?
- My issue is about the documentation content or website
Type of issue
Other
Description
I find the information about using / not using the default overlay network very confusing.
The first section is about using the default overlay network:
Use the default overlay network demonstrates how to use the default overlay network that Docker sets up for you automatically when you initialize or join a swarm. This network is not the best choice for production systems.
Does this refer to the ingress network? If yes, why is this not a good choice for production? Isn't ingress traffic supposed to go via ingress network? Am I not supposed to publish a port to the Ingress network? Or is it not a good choice for a different kind of use (inter-task communication)?
The tutorial then goes on to create a user defined network nginx-net and attach a service to it in the same section (so, it's not using the "default network"?)
The second section is about "Using a user-defined overlay network". Yet the steps involved seem to be exactly the same as in the first section only with a different name for the network (my-overlay instead of nginx-net).
Location
https://docs.docker.com/network/network-tutorial-overlay/
Suggestion
- Clarify for what purpose exactly one should not use the default network
- Point out the differences (if any) between the "Use the default overlay network" and "Use a user-defined overlay network" approaches
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the overlay networking tutorial at docs.docker.com/network/network-tutorial-overlay/, reading both the “Use the default overlay network” and “Using a user-defined overlay network” sections together. Verify the intended distinction and purposes from the surrounding Docker documentation, then update the page so the default-network limitation and the differences between the two approaches are explicit.
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
- 45/100