From 971fc2253af77ae4a22a3741fff51d84cd9bc697 Mon Sep 17 00:00:00 2001 From: Malte Janduda Date: Mon, 3 Nov 2014 11:43:11 +0100 Subject: [PATCH] enhancing set-macaddress docu Signed-off-by: Malte Janduda --- docs/man/docker-run.1.md | 2 +- docs/sources/articles/networking.md | 6 +++--- docs/sources/reference/api/docker_remote_api.md | 2 +- docs/sources/reference/run.md | 8 ++++---- integration-cli/docker_cli_run_test.go | 8 ++++---- runconfig/parse.go | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/man/docker-run.1.md b/docs/man/docker-run.1.md index ce2ffeb434..ae559819b1 100644 --- a/docs/man/docker-run.1.md +++ b/docs/man/docker-run.1.md @@ -192,7 +192,7 @@ and foreground Docker containers. Set the MAC address for the container's ethernet device: --mac-address=12:34:56:78:9a:bc -Remember that the MAC address in an ethernet network must be unique. +Remember that the MAC address in an Ethernet network must be unique. The IPv6 link-local address will be based on the device's MAC address according to RFC4862. diff --git a/docs/sources/articles/networking.md b/docs/sources/articles/networking.md index 49f3722216..6587efc522 100644 --- a/docs/sources/articles/networking.md +++ b/docs/sources/articles/networking.md @@ -105,7 +105,7 @@ Finally, several networking options can only be provided when calling [How Docker networks a container](#container-networking) * `--mac-address=MACADDRESS...` — see - [How docker networks a container](#container-networking) + [How Docker networks a container](#container-networking) * `-p SPEC` or `--publish=SPEC` — see [Binding container ports](#binding-ports) @@ -540,13 +540,13 @@ The steps with which Docker configures a container are: separate and unique network interface namespace, there are no physical interfaces with which this name could collide. -4. Set the interface's mac address according to the `--mac-address` +4. Set the interface's MAC address according to the `--mac-address` parameter or generate a random one. 5. Give the container's `eth0` a new IP address from within the bridge's range of network addresses, and set its default route to the IP address that the Docker host owns on the bridge. If available - the IP address is generated from the MAC address. This prevents arp + the IP address is generated from the MAC address. This prevents ARP cache invalidation problems, when a new container comes up with an IP used in the past by another container with another MAC. diff --git a/docs/sources/reference/api/docker_remote_api.md b/docs/sources/reference/api/docker_remote_api.md index 5b054c6bbe..3babab8eca 100644 --- a/docs/sources/reference/api/docker_remote_api.md +++ b/docs/sources/reference/api/docker_remote_api.md @@ -54,7 +54,7 @@ total memory available (`MemTotal`). `POST /containers/create` **New!** -You can define the container's MAC address by providing a MacAddress key-value pair. +You can set the new container's MAC address explicitly. ## v1.15 diff --git a/docs/sources/reference/run.md b/docs/sources/reference/run.md index c8a141de06..4ec867f1a6 100644 --- a/docs/sources/reference/run.md +++ b/docs/sources/reference/run.md @@ -140,7 +140,7 @@ example, `docker run ubuntu:14.04`. 'container:': reuses another container network stack 'host': use the host network stack inside the container --add-host="" : Add a line to /etc/hosts (host:IP) - --mac-address="" : Sets the container's ethernet device's mac address + --mac-address="" : Sets the container's ethernet device's MAC address By default, all containers have networking enabled and they can make any outgoing connections. The operator can completely disable networking @@ -151,9 +151,9 @@ networking. In cases like this, you would perform I/O through files or Your container will use the same DNS servers as the host by default, but you can override this with `--dns`. -By default a random mac is generated. You can set the container's mac address -explicitly by providing a mac via the `--mac-address` parameter (format: -12:34:56:78:9a:bc). +By default a random MAC is generated. You can set the container's MAC address +explicitly by providing a MAC via the `--mac-address` parameter (format: +`12:34:56:78:9a:bc`). Supported networking modes are: diff --git a/integration-cli/docker_cli_run_test.go b/integration-cli/docker_cli_run_test.go index 389bcda93a..4c3e8d0a08 100644 --- a/integration-cli/docker_cli_run_test.go +++ b/integration-cli/docker_cli_run_test.go @@ -2027,11 +2027,11 @@ func TestRunSetMacAddress(t *testing.T) { } actualMac := strings.TrimSpace(out) if actualMac != mac { - t.Fatalf("Set Mac Address with --mac-address failed. The container has an incorrect MAC address: %q, expected: %q", actualMac, mac) + t.Fatalf("Set MAC address with --mac-address failed. The container has an incorrect MAC address: %q, expected: %q", actualMac, mac) } deleteAllContainers() - logDone("run - setting Mac Address with --mac-address") + logDone("run - setting MAC address with --mac-address") } func TestRunInspectMacAddress(t *testing.T) { @@ -2047,10 +2047,10 @@ func TestRunInspectMacAddress(t *testing.T) { t.Fatal(err) } if inspectedMac != mac { - t.Fatalf("Inspecting Mac Address with failed. docker inspect shows incorrect MacAddress: %q, actual Mac: %q", inspectedMac, mac) + t.Fatalf("docker inspect outputs wrong MAC address: %q, should be: %q", inspectedMac, mac) } deleteAllContainers() - logDone("run - inspecting Mac Address") + logDone("run - inspecting MAC address") } func TestRunDeallocatePortOnMissingIptablesRule(t *testing.T) { diff --git a/runconfig/parse.go b/runconfig/parse.go index aed10eadd1..c62ab3fdd4 100644 --- a/runconfig/parse.go +++ b/runconfig/parse.go @@ -59,7 +59,7 @@ func Parse(cmd *flag.FlagSet, args []string, sysInfo *sysinfo.SysInfo) (*Config, flCpuShares = cmd.Int64([]string{"c", "-cpu-shares"}, 0, "CPU shares (relative weight)") flCpuset = cmd.String([]string{"-cpuset"}, "", "CPUs in which to allow execution (0-3, 0,1)") flNetMode = cmd.String([]string{"-net"}, "bridge", "Set the Network mode for the container\n'bridge': creates a new network stack for the container on the docker bridge\n'none': no networking for this container\n'container:': reuses another container network stack\n'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.") - flMacAddress = cmd.String([]string{"-mac-address"}, "", "Container MAC address (ex: 92:d0:c6:0a:29:33)") + flMacAddress = cmd.String([]string{"-mac-address"}, "", "Container MAC address (e.g. 92:d0:c6:0a:29:33)") flRestartPolicy = cmd.String([]string{"-restart"}, "", "Restart policy to apply when a container exits (no, on-failure[:max-retry], always)") )