Skip to content

Network docs for release#17340

Merged
moxiegirl merged 1 commit intomoby:masterfrom
moxiegirl:new-networking-docs
Nov 3, 2015
Merged

Network docs for release#17340
moxiegirl merged 1 commit intomoby:masterfrom
moxiegirl:new-networking-docs

Conversation

@moxiegirl
Copy link
Contributor

Removing old networking.md
Updating dockernetworks.md with images
Adding information on network plugins
Adding blurb about links to docker networking
Updating the working documentation
Adding Overlay Getting Started
Downplaying links by removing refs/examples, adding refs/examples for network.
Updating getting started to reflect networks not links

Signed-off-by: Mary Anthony [email protected]

@moxiegirl
Copy link
Contributor Author

@mavenugo @dave-tucker this is currently a WIP. You can check here. I'll push check points. EOD Sunday I'll make it through all of it.

TODO:
-- Clip the old networking material

@moxiegirl moxiegirl changed the title WIP: First pass at consolidating and correcting network docs WIP: Drafting network docs for release Oct 25, 2015
@moxiegirl
Copy link
Contributor Author

Updated with first pass at the Getting started with overlay. End-to-end testing of the final draft is going to have to wait until: a solution to #17047 is merged.

@moxiegirl
Copy link
Contributor Author

@mavenugo @dave-tucker Updated also the getting started which is our tutorial for new users. Wanted them to start with networking rather than linking.

@moxiegirl
Copy link
Contributor Author

TODO: Pare down old networking docs
TODO: Ask a couple of questions re the networking for tutorial
TODO: Get and test the solution for the overlay getting started.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just so you don't miss them; got some merge markers in here

@moxiegirl moxiegirl changed the title WIP: Drafting network docs for release Newtork docs for release Oct 28, 2015
@moxiegirl
Copy link
Contributor Author

@mavenugo @thaJeztah @dave-tucker @vdemeester Go ahead and review.

Dave I have your changes and Madhu I have notes regarding:

  • -b def to renamed docker0
  • "Docker default network" = bridge bridge or docker0 in the stack if not renamed.

@moxiegirl moxiegirl force-pushed the new-networking-docs branch from 6f37bfc to 09c2e95 Compare October 28, 2015 03:31
@moxiegirl moxiegirl changed the title Newtork docs for release Network docs for release Oct 28, 2015
@dave-tucker
Copy link
Contributor

@moxiegirl I put some suggestions in moxiegirl#1 over the weekend. Rebased so it makes more sense.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: fwithout

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drop "simply"

"You can also container id" -> "you can also use the container id"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"tho"? 😉

@nicolaka
Copy link

nicolaka commented Nov 2, 2015

I think "Within of a user-defined bridge network, linking is not supported." is not true. I was able to link two containers that are part of a user-defined bridge network.

@nicolaka
Copy link

nicolaka commented Nov 2, 2015

In the "default bridge0 network in detail", without linking two container1 and container2 i dont think pinging using their name will work???

@nicolaka
Copy link

nicolaka commented Nov 2, 2015

Duplicate "run" in
$ docker run run -itd --net=mmy-multi-host-network busybox

@nicolaka
Copy link

nicolaka commented Nov 2, 2015

Need to specify which kv paramters are actually required. cluster-advertise and cluster-store are actually both REQUIRED and listing them as options might be misleading.

@abronan
Copy link
Contributor

abronan commented Nov 3, 2015

Just went through the doc and overall SGTM minor the typos and fixes suggested above. I was mostly reviewing the steps as a user and I think it's great for a first shot at the doc. As it is let's rebase and fix the typos if possible. This can always be improved (although it's practical to have all the suggestions here to fix them asap).

And nicely done @moxiegirl :)

@thaJeztah thaJeztah added this to the 1.9.0 milestone Nov 3, 2015
Removing old networking.md
Updating dockernetworks.md with images
Adding information on network plugins
Adding blurb about links to docker networking
Updating the working documentation
Adding Overlay Getting Started
Downplaying links by removing refs/examples, adding refs/examples for network.
Updating getting started to reflect networks not links
Pulling out old network material
Updating per discussion with Madhu to add Default docs section
Updating with bridge default
Fix bad merge
Updating with new cluster-advertise behavior
Update working and NetworkSettings examples
Correcting example for default bridge discovery behavior
Entering comments
Fixing broken Markdown Syntax
Updating with comments
Updating all the links

Signed-off-by: Mary Anthony <[email protected]>
@moxiegirl moxiegirl force-pushed the new-networking-docs branch from df4e5b6 to 9ef855f Compare November 3, 2015 05:15
@moxiegirl
Copy link
Contributor Author

author LGTM

@moxiegirl
Copy link
Contributor Author

Publishing for release. Good enough, not perfect.

moxiegirl pushed a commit that referenced this pull request Nov 3, 2015
@moxiegirl moxiegirl merged commit 43077f9 into moby:master Nov 3, 2015
@moxiegirl
Copy link
Contributor Author

@tiborvass Ready for Cherry pick captain, my captain.

@thaJeztah
Copy link
Member

Thanks so much, @moxiegirl !

rsmoorthy pushed a commit to rsmoorthy/docker-1 that referenced this pull request Nov 3, 2015
Network docs for release
Signed-off-by: Moorthy RS <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants