Skip to content

Commit

Permalink
DOCKER-585 Doc update on docker run and docker create --network option
Browse files Browse the repository at this point in the history
  • Loading branch information
Angela Fong committed Jul 29, 2016
1 parent 547ee2d commit e98159d
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 18 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -29,9 +29,9 @@ Offically supported version: 1.21 (equivalent to docker client version 1.9)

Supported version range:

- Remote API: 1.20 to 1.23
- Docker CLI: 1.8 to 1.11
- Docker Compose: 1.6 to 1.7
- Remote API: 1.20 to 1.24
- Docker CLI: 1.8 to 1.12
- Docker Compose: 1.6 to 1.8

When a client makes a remote API call to sdc-docker and it does not specify a
version, then sdc-docker will default to the officially supported version.
Expand Down
7 changes: 4 additions & 3 deletions docs/api/commands/create.md
Expand Up @@ -51,8 +51,8 @@ Creates a new container.
--memory-swap="" Total memory (memory + swap), '-1' to disable swap
--memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100
--name="" Assign a name to the container
--net=default Connect a container to a network
--net-alias=[] Add network-scoped alias for the container
--network=default Connect a container to a network
--network-alias=[] Add network-scoped alias for the container
--oom-kill-disable=false Whether to disable OOM Killer for the container or not
--oom-score-adj Tune host's OOM preferences (-1000 to 1000)
-P, --publish-all=false Publish all exposed ports to random ports
Expand Down Expand Up @@ -147,7 +147,8 @@ Triton's secure, multi-tenant, container-native environment imposes some differe
* `--mac-address` which is unsupported. See [networking](../features/networks.md).
* `--kernel-memory` and `--memory-reservation` (memory limits) are unsupported. See [resource allocation](../features/resources.md) for more about memory allocation in Triton.
* `--memory-swap` and `--memory-swappiness` (disabling swap and tuning memory swappiness) are unsupported.
* `--net`, `--net-alias`, `--ip`, `--ip6` (controls network config and ip address assignment) are currently unsupported. See [networking](../features/networks.md).
* `--network-alias`, `--ip`, `--ip6` (controls network config and ip address
assignment) are currently unsupported.
* `--oom-kill-disable` and `--oom-score-adj` (tunables for OOM behavior) are unsupported.
* `--pid=host` is unsupported.
* `-P`, `--publish-all`, `-p`, and `--publish` behave slightly differently thanks to each container having a complete IP stack with one or more virtual NICs. See [networking](../features/networks.md).
Expand Down
7 changes: 4 additions & 3 deletions docs/api/commands/run.md
Expand Up @@ -50,8 +50,8 @@
--memory-swap="" Total memory (memory + swap), '-1' to disable swap
--memory-swappiness="" Tune container memory swappiness (0 to 100)
--name="" Assign a name to the container
--net=default Connect a container to a network
--net-alias=[] Add network-scoped alias for the container
--network=default Connect a container to a network
--network-alias=[] Add network-scoped alias for the container
--oom-kill-disable=false Whether to disable OOM Killer for the container or not
--oom-score-adj Tune host's OOM preferences (-1000 to 1000)
-P, --publish-all=false Publish all exposed ports to random ports
Expand Down Expand Up @@ -496,7 +496,8 @@ Triton's secure, multi-tenant, container-native environment imposes some differe
* `--mac-address` which is unsupported. See [networking](../features/networks.md).
* `--kernel-memory` and `--memory-reservation` (memory limits) are unsupported. See [resource allocation](../features/resources.md) for more about memory allocation in Triton.
* `--memory-swap` and `--memory-swappiness` (disabling swap and tuning memory swappiness) are unsupported.
* `--net`, `--net-alias`, `--ip`, `--ip6` (controls network config and ip address assignment) are currently unsupported. See [networking](../features/networks.md).
* `--network-alias`, `--ip`, `--ip6` (controls network config and ip address
assignment) are currently unsupported.
* `--oom-kill-disable` and `--oom-score-adj` (tunables for OOM behavior) are unsupported.
* `--pid=host` is unsupported.
* `-P`, `--publish-all`, `-p`, and `--publish` behave slightly differently thanks to each container having a complete IP stack with one or more virtual NICs. See [networking](../features/networks.md).
Expand Down
21 changes: 12 additions & 9 deletions docs/api/features/networks.md
Expand Up @@ -9,17 +9,20 @@ Each default fabric network is private to a user - one user's containers cannot
connect to another's fabric IP addresses, and vice-versa.

To isolate the traffic between different applications or groups of applications,
users may use the CloudAPI to create additional networks on their fabric.
you may want to create additional networks on your fabric with CloudAPI.
Any of these user-defined networks can be designated as the 'default' network
to be used for provisioning Docker containers. When you change the 'default'
network, it affects only the newly provisioned containers.

The management of fabric networks and the option to select the network(s) to
use for a container are supported only through CloudAPI at this time. There
is work going on to enable the use of the `--net` option in `docker run` and
`docker create`. The `docker network` commands will also be available soon
in sdc-docker to better support the use of Docker Compose v2 to orchestrate
network management. Follow [DOCKER-722](http://smartos.org/bugview/DOCKER-722),
network, it affects only the newly provisioned containers. You may specify
a different fabric network during provisioning by passing the `--network`
argument in `docker run` and `docker create`, e.g.

```
docker run --network=dev-net-123 busybox
docker run --network=d8f607e4 -P -d nginx
```

The work to support `docker network` commands is in progress. Follow
[DOCKER-722](http://smartos.org/bugview/DOCKER-722),
[DOCKER-723](http://smartos.org/bugview/DOCKER-723),
[DOCKER-724](http://smartos.org/bugview/DOCKER-724),
[DOCKER-725](http://smartos.org/bugview/DOCKER-725) for updates.
Expand Down

0 comments on commit e98159d

Please sign in to comment.