Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document long form of --network and --network-add #843

Merged
merged 1 commit into from
Feb 21, 2018

Conversation

sepich
Copy link
Contributor

@sepich sepich commented Jan 27, 2018

Signed-off-by: Alexander Ryabov i@sepa.spb.ru

- What I did
Added missing documentation for long form of --network/--network-add
- How I did it
Read PR: moby/moby/pull/33130
- How to verify it

- Description for the changelog
Document long form of --network and --network-add

- A picture of a cute animal (not mandatory but encouraged)

@codecov-io
Copy link

codecov-io commented Jan 27, 2018

Codecov Report

Merging #843 into master will increase coverage by 0.27%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #843      +/-   ##
==========================================
+ Coverage   52.67%   52.94%   +0.27%     
==========================================
  Files         257      244      -13     
  Lines       16403    15839     -564     
==========================================
- Hits         8640     8386     -254     
+ Misses       7190     6899     -291     
+ Partials      573      554      -19

@thaJeztah
Copy link
Member

Also relates to #62, which implemented the CLI side of this

Copy link
Collaborator

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

LGTm 🌮

@mdlinville
Copy link
Contributor

@thaJeztah @gbarr01 please work together to figure out the target version for this and figure out which narrative docs should be updated.

@@ -734,6 +734,9 @@ The swarm extends my-network to each node running the service.
Containers on the same network can access each other using
[service discovery](https://docs.docker.com/engine/swarm/networking/#use-swarm-mode-service-discovery).

Long form syntax of `--network` (since v17.06) allows to specify list of aliases and driver options:
Copy link
Member

Choose a reason for hiding this comment

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

Generally we don't mention specific versions (but we should back port this change to the 17.06 and up docs archive)

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

Thanks! Two minor nits; also, can you squash your commits? let me know if you need help on that.

@@ -192,6 +192,21 @@ $ docker service update \
myservice
```

### Add or remove network

Use the `--network-add` or `--network-rm` flags to add or remove a network for a service. You can use the short or long syntax discussed in the
Copy link
Member

Choose a reason for hiding this comment

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

nit: can you wrap this line to 80-characters?

Signed-off-by: Alexander Ryabov <i@sepa.spb.ru>
@sepich
Copy link
Contributor Author

sepich commented Feb 16, 2018

Sure, hopefully fixed

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@thaJeztah thaJeztah merged commit 84c7dd6 into docker:master Feb 21, 2018
@GordonTheTurtle GordonTheTurtle added this to the 18.03.0 milestone Feb 21, 2018
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.

6 participants