Skip to content

engine: consolidate network drivers documentation #23731

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+963 −1,429
Open

engine: consolidate network drivers documentation #23731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions content/manuals/compose/how-tos/networking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Networking in Compose
linkTitle: Networking
weight: 70
aliases:
- /compose/networking/
- /compose/networking/
---

{{% include "compose-eol.md" %}}
Expand Down Expand Up @@ -75,7 +75,6 @@ Links allow you to define extra aliases by which a service is reachable from ano

```yaml
services:

web:
build: .
links:
Expand All @@ -93,8 +92,8 @@ you can make use of the built-in `overlay` driver to enable multi-host communica

Overlay networks are always created as `attachable`. You can optionally set the [`attachable`](/reference/compose-file/networks.md#attachable) property to `false`.

Consult the [Swarm mode section](/manuals/engine/swarm/_index.md), to see how to set up
a Swarm cluster, and the [Getting started with multi-host networking](/manuals/engine/network/tutorials/overlay.md)
Consult the [Swarm mode section](/manuals/engine/swarm/_index.md) to see how to set up
a Swarm cluster, and the [overlay network driver documentation](/manuals/engine/network/drivers/overlay.md)
to learn about multi-host overlay networks.

## Specify custom networks
Expand Down Expand Up @@ -169,6 +168,7 @@ networks:
If you've manually created a bridge network outside of Compose using the `docker network create` command, you can connect your Compose services to it by marking the network as `external`.

If you want your containers to join a pre-existing network, use the [`external` option](/reference/compose-file/networks.md#external)

```yaml
services:
# ...
Expand All @@ -180,7 +180,7 @@ networks:

Instead of attempting to create a network called `[projectname]_default`, Compose looks for a network called `my-pre-existing-network` and connects your app's containers to it.

## Further reference information
## Further reference information

For full details of the network configuration options available, see the following references:

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/engine/network/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ By default, containers inherit the DNS settings as defined in the
`/etc/resolv.conf` configuration file.
Containers that attach to the default `bridge` network receive a copy of this file.
Containers that attach to a
[custom network](tutorials/standalone.md#use-user-defined-bridge-networks)
[custom network](drivers/bridge.md#use-user-defined-bridge-networks)
use Docker's embedded DNS server.
The embedded DNS server forwards external DNS lookups to the DNS servers configured on the host.

Expand Down
11 changes: 3 additions & 8 deletions content/manuals/engine/network/drivers/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,7 @@ exist by default, and provide core networking functionality:
- Third-party network plugins allow you to integrate Docker with specialized
network stacks.

## Networking tutorials
## Next steps

Now that you understand the basics about Docker networks, deepen your
understanding using the following tutorials:

- [Standalone networking tutorial](/manuals/engine/network/tutorials/standalone.md)
- [Host networking tutorial](/manuals/engine/network/tutorials/host.md)
- [Overlay networking tutorial](/manuals/engine/network/tutorials/overlay.md)
- [Macvlan networking tutorial](/manuals/engine/network/tutorials/macvlan.md)
Each driver page includes detailed explanations, configuration options, and
hands-on usage examples to help you work with that driver effectively.
Loading
Loading