Skip to content

Commit ce035f4

Browse files
committed
Fix description of 'inhibit_ipv4'
Signed-off-by: Rob Murray <[email protected]>
1 parent 8c85f1c commit ce035f4

File tree

1 file changed

+22
-20
lines changed
  • content/manuals/engine/network/drivers

1 file changed

+22
-20
lines changed

content/manuals/engine/network/drivers/bridge.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -105,16 +105,16 @@ flag.
105105
The following table describes the driver-specific options that you can pass to
106106
`--option` when creating a custom network using the `bridge` driver.
107107

108-
| Option | Default | Description |
109-
|-------------------------------------------------------------------------------------------------|-----------------------------|------------------------------------------------------------------------------------------------|
110-
| `com.docker.network.bridge.name` | | Interface name to use when creating the Linux bridge. |
111-
| `com.docker.network.bridge.enable_ip_masquerade` | `true` | Enable IP masquerading. |
112-
| `com.docker.network.bridge.gateway_mode_ipv4`<br/>`com.docker.network.bridge.gateway_mode_ipv6` | `nat` | Enable NAT and masquerading (`nat`), or only allow direct routing to the container (`routed`). |
113-
| `com.docker.network.bridge.enable_icc` | `true` | Enable or Disable inter-container connectivity. |
114-
| `com.docker.network.bridge.host_binding_ipv4` | all IPv4 and IPv6 addresses | Default IP when binding container ports. |
115-
| `com.docker.network.driver.mtu` | `0` (no limit) | Set the containers network Maximum Transmission Unit (MTU). |
116-
| `com.docker.network.container_iface_prefix` | `eth` | Set a custom prefix for container interfaces. |
117-
| `com.docker.network.bridge.inhibit_ipv4` | `false` | Prevent Docker from [assigning an IP address](#skip-ip-address-configuration) to the network. |
108+
| Option | Default | Description |
109+
|-------------------------------------------------------------------------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------|
110+
| `com.docker.network.bridge.name` | | Interface name to use when creating the Linux bridge. |
111+
| `com.docker.network.bridge.enable_ip_masquerade` | `true` | Enable IP masquerading. |
112+
| `com.docker.network.bridge.gateway_mode_ipv4`<br/>`com.docker.network.bridge.gateway_mode_ipv6` | `nat` | Enable NAT and masquerading (`nat`), or only allow direct routing to the container (`routed`). |
113+
| `com.docker.network.bridge.enable_icc` | `true` | Enable or Disable inter-container connectivity. |
114+
| `com.docker.network.bridge.host_binding_ipv4` | all IPv4 and IPv6 addresses | Default IP when binding container ports. |
115+
| `com.docker.network.driver.mtu` | `0` (no limit) | Set the containers network Maximum Transmission Unit (MTU). |
116+
| `com.docker.network.container_iface_prefix` | `eth` | Set a custom prefix for container interfaces. |
117+
| `com.docker.network.bridge.inhibit_ipv4` | `false` | Prevent Docker from [assigning an IP address](#skip-bridge-ip-address-configuration) to the bridge. |
118118

119119
Some of these options are also available as flags to the `dockerd` CLI, and you
120120
can use them to configure the default `docker0` bridge when starting the Docker
@@ -295,20 +295,22 @@ to a single network.
295295
For more information about this limitation, see
296296
[moby/moby#44973](https://github.com/moby/moby/issues/44973#issuecomment-1543747718).
297297

298-
## Skip IP address configuration
298+
## Skip Bridge IP address configuration
299+
300+
The bridge is normally assigned the network's `--gateway` address, which is
301+
used as the default route from the bridge network to other networks.
299302

300303
The `com.docker.network.bridge.inhibit_ipv4` option lets you create a network
301-
that uses an existing bridge and have Docker skip configuring the IPv4 address
302-
on the bridge. This is useful if you want to configure the IP address for the
303-
bridge manually. For instance if you add a physical interface to your bridge,
304-
and need to move its IP address to the bridge interface.
304+
without the IPv4 gateway address being assigned to the bridge. This is useful
305+
if you want to configure the gateway IP address for the bridge manually. For
306+
instance if you add a physical interface to your bridge, and need it to have
307+
the gateway address.
305308

306-
To use this option, you should first configure the Docker daemon to use a
307-
self-managed bridge, using the `bridge` option in the `daemon.json` or the
308-
`dockerd --bridge` flag.
309+
With this configuration, north-south traffic (to and from the bridge network)
310+
won't work unless you've manually configured the gateway address on the bridge,
311+
or a device attached to it.
309312

310-
With this configuration, north-south traffic won't work unless you've manually
311-
configured the IP address for the bridge.
313+
This option can only be used with user-defined bridge networks.
312314

313315
## Next steps
314316

0 commit comments

Comments
 (0)