Add clarity note around required user-created overlay #2972
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdlinville
suggested changes
Apr 20, 2017
engine/swarm/networking.md
Outdated
| @@ -158,6 +158,8 @@ the service a VIP. The VIP maps to a DNS alias based upon the service name. | |||
| Containers on the network share DNS mappings for the service via gossip so any container on the network can access the service via its service | |||
| name. | |||
|
|
|||
| >**Note**: Service discovery will only work if your services are attached to a user-created overlay network (see top of this article). When a Swarm is initialized an ingress network is created (if it doesn't already exist) however containers are not added directly to this network. Ingress is used to enable to routing mesh functionality of swarm mode. | |||
There was a problem hiding this comment.
No need to capitalize swarm
Maybe a little rewording:
When a swarm is initialized, an ingress network is created if it does not exist. This network is not used by containers, but to enable the daemons participating in the swarm to communicate.
There was a problem hiding this comment.
Thanks Misty. Agree on first sentence. For second, what about "This network is not used by containers, but to enable the routing mesh functionality in swarm mode."
Just to make explicit that it's routing mesh that ingress enables, rather than 'just' daemon communication? WDYT?
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Fix #176