Skip to content

Commit

Permalink
Document service --network long form
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Ryabov <i@sepa.spb.ru>
  • Loading branch information
sepich committed Feb 16, 2018
1 parent a46fa07 commit 94ecd2b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
5 changes: 4 additions & 1 deletion docs/reference/commandline/service_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -716,7 +716,7 @@ etjpu59cykrptrgw0z0hk5snf
After you create an overlay network in swarm mode, all manager nodes have
access to the network.

When you create a service and pass the --network flag to attach the service to
When you create a service and pass the `--network` flag to attach the service to
the overlay network:

```bash
Expand All @@ -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` allows to specify list of aliases and driver options:
`--network name=my-network,alias=web1,driver-opt=field1=value1`

### Publish service ports externally to the swarm (-p, --publish)

You can publish service ports to make them available externally to the swarm
Expand Down
18 changes: 17 additions & 1 deletion docs/reference/commandline/service_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ myservice

Use the `--publish-add` or `--publish-rm` flags to add or remove a published
port for a service. You can use the short or long syntax discussed in the
[docker service create](service_create/#attach-a-service-to-an-existing-network-network)
[docker service create](service_create/#publish-service-ports-externally-to-the-swarm)
reference.

The following example adds a published service port to an existing service.
Expand All @@ -192,6 +192,22 @@ $ 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
[docker service create](service_create/#attach-a-service-to-an-existing-network-network)
reference.

The following example adds a new alias name to an existing service already connected to network my-network:

```bash
$ docker service update \
--network-rm my-network \
--network-add name=my-network,alias=web1 \
myservice
```

### Roll back to the previous version of a service

Use the `--rollback` option to roll back to the previous version of the service.
Expand Down

0 comments on commit 94ecd2b

Please sign in to comment.