docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

config: use relative markdown links 

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2020-04-08 16:43:38 +02:00
parent 777c5d23da
commit b0f9061565
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
20 changed files with 63 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
config/containers/container-networking.md
View File

@ -9,8 +9,8 @@ redirect_from:
- /engine/userguide/networking/default_network/container-communication/
---
The type of network a container uses, whether it is a [bridge](bridges.md), an
[overlay](overlay.md), a [macvlan network](macvlan.md), or a custom network
The type of network a container uses, whether it is a [bridge](../../network/bridge.md), an
[overlay](../../network/overlay.md), a [macvlan network](../../network/macvlan.md), or a custom network
plugin, is transparent from within the container. From the container's point of
view, it has a network interface with an IP address, a gateway, a routing table,
DNS services, and other networking details (assuming the container is not using
@ -70,4 +70,4 @@ settings on a per-container basis.
## Proxy server
If your container needs to use a proxy server, see
[Use a proxy server](/network/proxy.md).
[Use a proxy server](../../network/proxy.md).

2
config/containers/logging/awslogs.md
View File

@ -20,7 +20,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is
located in `/etc/docker/` on Linux hosts or
`C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about
configuring Docker using `daemon.json`, see
[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
The following example sets the log driver to `awslogs` and sets the
`awslogs-region` option.

2
config/containers/logging/fluentd.md
View File

@ -39,7 +39,7 @@ Some options are supported by specifying `--log-opt` as many times as needed:
located in `/etc/docker/` on Linux hosts or
`C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about
+configuring Docker using `daemon.json`, see
+[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
+[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
The following example sets the log driver to `fluentd` and sets the
`fluentd-address` option.

2
config/containers/logging/gcplogs.md
View File

@ -17,7 +17,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is
located in `/etc/docker/` on Linux hosts or
`C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about
configuring Docker using `daemon.json`, see
[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
The following example sets the log driver to `gcplogs` and sets the
`gcp-meta-name` option.

2
config/containers/logging/gelf.md
View File

@ -25,7 +25,7 @@ To use the `gelf` driver as the default logging driver, set the `log-driver` and
`log-opt` keys to appropriate values in the `daemon.json` file, which is located
in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json`
on Windows Server. For more about configuring Docker using `daemon.json`, see
[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
The following example sets the log driver to `gelf` and sets the `gelf-address`
option.

2
config/containers/logging/index.md
View File

@ -51,4 +51,4 @@ its errors to `/proc/self/fd/2` (which is `STDERR`). See the
## Next steps
- Configure [logging drivers](configure.md).
- Write a [Dockerfile](/engine/reference/builder.md).
- Write a [Dockerfile](../../../engine/reference/builder.md).

2
config/containers/logging/journald.md
View File

@ -30,7 +30,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is
located in `/etc/docker/` on Linux hosts or
`C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about
configuring Docker using `daemon.json`, see
[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
The following example sets the log driver to `journald`:

2
config/containers/logging/json-file.md
View File

@ -24,7 +24,7 @@ and `log-opts` keys to appropriate values in the `daemon.json` file, which is
located in `/etc/docker/` on Linux hosts or
`C:\ProgramData\docker\config\` on Windows Server. For more information about
configuring Docker using `daemon.json`, see
[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
The following example sets the log driver to `json-file` and sets the `max-size` and `max-file` options.

2
config/containers/logging/local.md
View File

@ -29,7 +29,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is
located in `/etc/docker/` on Linux hosts or
`C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about
configuring Docker using `daemon.json`, see
[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
The following example sets the log driver to `local` and sets the `max-size`
option.

2
config/containers/logging/plugins.md
View File

@ -9,7 +9,7 @@ redirect_from:
Docker logging plugins allow you to extend and customize Docker's logging
capabilities beyond those of the [built-in logging drivers](configure.md).
A logging service provider can
[implement their own plugins](/engine/extend/plugins_logging.md) and make them
[implement their own plugins](../../../engine/extend/plugins_logging.md) and make them
available on Docker Hub, or a private registry. This topic shows
how a user of that logging service can configure Docker to use the plugin.

2
config/containers/logging/splunk.md
View File

@ -34,7 +34,7 @@ configuration file and restart Docker. For example:
The daemon.json file is located in `/etc/docker/` on Linux hosts or
`C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about
configuring Docker using `daemon.json`, see
[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
> **Note**
>

2
config/containers/logging/syslog.md
View File

@ -38,7 +38,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is
located in `/etc/docker/` on Linux hosts or
`C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about
configuring Docker using `daemon.json`, see
[daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
The following example sets the log driver to `syslog` and sets the
`syslog-address` option. The `syslog-address` options supports both UDP and TCP;

8
config/containers/resource_constraints.md
View File

@ -15,7 +15,7 @@ on when you should set such limits and the possible implications of setting them
Many of these features require your kernel to support Linux capabilities. To
check for support, you can use the
[`docker info`](/engine/reference/commandline/info.md) command. If a capability
[`docker info`](../../engine/reference/commandline/info.md) command. If a capability
is disabled in your kernel, you may see a warning at the end of the output like
the following:
@ -24,7 +24,7 @@ WARNING: No swap limit support
```
Consult your operating system's documentation for enabling them.
[Learn more](/engine/install/linux-postinstall.md#your-kernel-does-not-support-cgroup-swap-limit-capabilities).
[Learn more](../../engine/install/linux-postinstall.md#your-kernel-does-not-support-cgroup-swap-limit-capabilities).
## Memory
@ -59,7 +59,7 @@ You can mitigate the risk of system instability due to OOME by:
- Be mindful when configuring swap on your Docker hosts. Swap is slower and
less performant than memory but can provide a buffer against running out of
system memory.
- Consider converting your container to a [service](/engine/swarm/services.md),
- Consider converting your container to a [service](../../engine/swarm/services.md),
and using service-level constraints and node labels to ensure that the
application runs only on hosts with enough memory
@ -233,7 +233,7 @@ for realtime tasks per runtime period. For instance, with the default period of
containers using the realtime scheduler can run for 950000 microseconds for every
1000000-microsecond period, leaving at least 50000 microseconds available for
non-realtime tasks. To make this configuration permanent on systems which use
`systemd`, see [Control and configure Docker with systemd](/config/daemon/systemd.md).
`systemd`, see [Control and configure Docker with systemd](../daemon/systemd.md).
#### Configure individual containers

2
config/containers/runmetrics.md
View File

@ -24,7 +24,7 @@ redis1 0.07% 796 KB / 64 MB 1.21%
redis2 0.07% 2.746 MB / 64 MB 4.29% 1.266 KB / 648 B 12.4 MB / 0 B
```
The [docker stats](/engine/reference/commandline/stats.md) reference page has
The [docker stats](../../engine/reference/commandline/stats.md) reference page has
more details about the `docker stats` command.
## Control groups

4
config/containers/start-containers-automatically.md
View File

@ -8,7 +8,7 @@ redirect_from:
title: Start containers automatically
---
Docker provides [restart policies](/engine/reference/run.md#restart-policies---restart)
Docker provides [restart policies](../../engine/reference/run.md#restart-policies---restart)
to control whether your containers start automatically when they exit, or when
Docker restarts. Restart policies ensure that linked containers are started in
the correct order. Docker recommends that you use restart policies, and avoid
@ -53,7 +53,7 @@ Keep the following in mind when using restart policies:
- Restart policies only apply to _containers_. Restart policies for swarm
services are configured differently. See the
[flags related to service restart](/engine/reference/commandline/service_create/).
[flags related to service restart](../../engine/reference/commandline/service_create/).
## Use a process manager

26
config/daemon/index.md
View File

@ -34,9 +34,9 @@ not manually by a user. This makes it easier to automatically start Docker when
the machine reboots.
The command to start Docker depends on your operating system. Check the correct
page under [Install Docker](/engine/install/index.md). To configure Docker
page under [Install Docker](../../engine/install/index.md). To configure Docker
to start automatically at system boot, see
[Configure Docker to start on boot](/engine/install/linux-postinstall.md#configure-docker-to-start-on-boot).
[Configure Docker to start on boot](../../engine/install/linux-postinstall.md#configure-docker-to-start-on-boot).
## Start the daemon manually
@ -90,7 +90,7 @@ Here's what the configuration file looks like:
With this configuration the Docker daemon runs in debug mode, uses TLS, and
listens for traffic routed to `192.168.59.3` on port `2376`.
You can learn what configuration options are available in the
[dockerd reference docs](/engine/reference/commandline/dockerd/#daemon-configuration-file)
[dockerd reference docs](../../engine/reference/commandline/dockerd.md#daemon-configuration-file)
You can also start the Docker daemon manually and configure it using flags.
This can be useful for troubleshooting problems.
@ -107,7 +107,7 @@ dockerd --debug \
```
You can learn what configuration options are available in the
[dockerd reference docs](/engine/reference/commandline/dockerd.md), or by running:
[dockerd reference docs](../../engine/reference/commandline/dockerd.md), or by running:
```
dockerd --help
@ -116,10 +116,10 @@ dockerd --help
Many specific configuration options are discussed throughout the Docker
documentation. Some places to go next include:
- [Automatically start containers](/engine/admin/host_integration.md)
- [Limit a container's resources](/engine/admin/resource_constraints.md)
- [Configure storage drivers](/engine/userguide/storagedriver/index.md)
- [Container security](/engine/security/index.md)
- [Automatically start containers](../containers/start-containers-automatically.md)
- [Limit a container's resources](../containers/resource_constraints.md)
- [Configure storage drivers](../../storage/storagedriver/select-storage-driver.md)
- [Container security](../../engine/security/index.md)
## Docker daemon directory
@ -145,7 +145,7 @@ are difficult to troubleshoot.
You can enable debugging on the daemon to learn about the runtime activity of
the daemon and to aid in troubleshooting. If the daemon is completely
non-responsive, you can also
[force a full stack trace](#force-a-full-stack-trace-to-be-logged) of all
[force a full stack trace](#force-a-stack-trace-to-be-logged) of all
threads to be added to the daemon log by sending the `SIGUSR` signal to the
Docker daemon.
@ -165,7 +165,7 @@ If you see an error similar to this one and you are starting the daemon manually
you may need to adjust your flags or the `daemon.json` to remove the conflict.
> **Note**: If you see this specific error, continue to the
> [next section](#use-the-hosts-key-in-daemon-json-with-systemd) for a workaround.
> [next section](#use-the-hosts-key-in-daemonjson-with-systemd) for a workaround.
If you are starting Docker using your operating system's init scripts, you may
need to override the defaults in these scripts in ways that are specific to the
@ -190,7 +190,7 @@ ExecStart=/usr/bin/dockerd
```
There are other times when you might need to configure `systemd` with Docker, such as
[configuring a HTTP or HTTPS proxy](/engine/admin/systemd/#httphttps-proxy).
[configuring a HTTP or HTTPS proxy](systemd.md#httphttps-proxy).
> **Note**: If you override this option and then do not specify a `hosts` entry in the `daemon.json`
> or a `-H` flag when starting Docker manually, Docker fails to start.
@ -212,7 +212,7 @@ you may experience an Out Of Memory Exception (OOME) and a container, or the
Docker daemon, might be killed by the kernel OOM killer. To prevent this from
happening, ensure that your application runs on hosts with adequate memory and
see
[Understand the risks of running out of memory](/engine/admin/resource_constraints.md#understand-the-risks-of-running-out-of-memory).
[Understand the risks of running out of memory](../containers/resource_constraints.md#understand-the-risks-of-running-out-of-memory).
### Read the logs
@ -283,7 +283,7 @@ by sending a `SIGUSR1` signal to the daemon.
- **Windows Server**:
Download [docker-signal](https://github.com/jhowardmsft/docker-signal).
Download [docker-signal](https://github.com/moby/docker-signal).
Get the process ID of dockerd `Get-Process dockerd`.

4
config/daemon/ipv6.md
View File

@ -34,5 +34,5 @@ addresses using the `--ip6` flag.
## Next steps
- [Networking overview](/network/index.md)
- [Container networking](/config/containers/container-networking.md)
- [Networking overview](../../network/index.md)
- [Container networking](../containers/container-networking.md)

6
config/daemon/systemd.md
View File

@ -34,14 +34,14 @@ do not have `systemctl`, use the `service` command.
### Start automatically at system boot
If you want Docker to start at boot, see
[Configure Docker to start on boot](/engine/install/linux-postinstall.md#configure-docker-to-start-on-boot).
[Configure Docker to start on boot](../../engine/install/linux-postinstall.md#configure-docker-to-start-on-boot).
## Custom Docker daemon options
There are a number of ways to configure the daemon flags and environment variables
for your Docker daemon. The recommended way is to use the platform-independent
`daemon.json` file, which is located in `/etc/docker/` on Linux by default. See
[Daemon configuration file](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
[Daemon configuration file](../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
You can configure nearly all daemon configuration options using `daemon.json`. The following
example configures two options. One thing you cannot configure using `daemon.json` mechanism is
@ -155,7 +155,7 @@ you need to add this configuration in the Docker systemd service file.
## Configure where the Docker daemon listens for connections
See
[Configure where the Docker daemon listens for connections](/engine/install/linux-postinstall.md#control-where-the-docker-daemon-listens-for-connections).
[Configure where the Docker daemon listens for connections](../../engine/install/linux-postinstall.md#control-where-the-docker-daemon-listens-for-connections).
## Manually create the systemd unit files

40
config/labels-custom-metadata.md
View File

@ -78,33 +78,33 @@ the lifetime of the object. To change these labels you must recreate the object.
Labels on swarm nodes and services can be updated dynamically.
- Images and containers
- [Adding labels to images](/engine/reference/builder.md#label)
- [Overriding a container's labels at runtime](/engine/reference/commandline/run.md#set-metadata-on-container--l---label---label-file)
- [Inspecting labels on images or containers](/engine/reference/commandline/inspect.md)
- [Filtering images by label](/engine/reference/commandline/images.md#filtering)
- [Filtering containers by label](/engine/reference/commandline/ps.md#filtering)
- [Adding labels to images](../engine/reference/builder.md#label)
- [Overriding a container's labels at runtime](../engine/reference/commandline/run.md#set-metadata-on-container--l---label---label-file)
- [Inspecting labels on images or containers](../engine/reference/commandline/inspect.md)
- [Filtering images by label](../engine/reference/commandline/images.md#filtering)
- [Filtering containers by label](../engine/reference/commandline/ps.md#filtering)
- Local Docker daemons
- [Adding labels to a Docker daemon at runtime](/engine/reference/commandline/dockerd.md)
- [Inspecting a Docker daemon's labels](/engine/reference/commandline/info.md)
- [Adding labels to a Docker daemon at runtime](../engine/reference/commandline/dockerd.md)
- [Inspecting a Docker daemon's labels](../engine/reference/commandline/info.md)
- Volumes
- [Adding labels to volumes](/engine/reference/commandline/volume_create.md)
- [Inspecting a volume's labels](/engine/reference/commandline/volume_inspect.md)
- [Filtering volumes by label](/engine/reference/commandline/volume_ls.md#filtering)
- [Adding labels to volumes](../engine/reference/commandline/volume_create.md)
- [Inspecting a volume's labels](../engine/reference/commandline/volume_inspect.md)
- [Filtering volumes by label](../engine/reference/commandline/volume_ls.md#filtering)
- Networks
- [Adding labels to a network](/engine/reference/commandline/network_create.md)
- [Inspecting a network's labels](/engine/reference/commandline/network_inspect.md)
- [Filtering networks by label](/engine/reference/commandline/network_ls.md#filtering)
- [Adding labels to a network](../engine/reference/commandline/network_create.md)
- [Inspecting a network's labels](../engine/reference/commandline/network_inspect.md)
- [Filtering networks by label](../engine/reference/commandline/network_ls.md#filtering)
- Swarm nodes
- [Adding or updating a swarm node's labels](/engine/reference/commandline/node_update.md#add-label-metadata-to-a-node)
- [Inspecting a swarm node's labels](/engine/reference/commandline/node_inspect.md)
- [Filtering swarm nodes by label](/engine/reference/commandline/node_ls.md#filtering)
- [Adding or updating a swarm node's labels](../engine/reference/commandline/node_update.md#add-label-metadata-to-a-node)
- [Inspecting a swarm node's labels](../engine/reference/commandline/node_inspect.md)
- [Filtering swarm nodes by label](../engine/reference/commandline/node_ls.md#filtering)
- Swarm services
- [Adding labels when creating a swarm service](/engine/reference/commandline/service_create.md#set-metadata-on-a-service-l-label)
- [Updating a swarm service's labels](/engine/reference/commandline/service_update.md)
- [Inspecting a swarm service's labels](/engine/reference/commandline/service_inspect.md)
- [Filtering swarm services by label](/engine/reference/commandline/service_ls.md#filtering)
- [Adding labels when creating a swarm service](../engine/reference/commandline/service_create.md#set-metadata-on-a-service-l-label)
- [Updating a swarm service's labels](../engine/reference/commandline/service_update.md)
- [Inspecting a swarm service's labels](../engine/reference/commandline/service_inspect.md)
- [Filtering swarm services by label](../engine/reference/commandline/service_ls.md#filtering)

8
config/pruning.md
View File

@ -50,7 +50,7 @@ $ docker image prune -a --filter "until=24h"
```
Other filtering expressions are available. See the
[`docker image prune` reference](/engine/reference/commandline/image_prune.md)
[`docker image prune` reference](../engine/reference/commandline/image_prune.md)
for more examples.
## Prune containers
@ -81,7 +81,7 @@ $ docker container prune --filter "until=24h"
```
Other filtering expressions are available. See the
[`docker container prune` reference](/engine/reference/commandline/container_prune.md)
[`docker container prune` reference](../engine/reference/commandline/container_prune.md)
for more examples.
## Prune volumes
@ -109,7 +109,7 @@ $ docker volume prune --filter "label!=keep"
```
Other filtering expressions are available. See the
[`docker volume prune` reference](/engine/reference/commandline/volume_prune.md)
[`docker volume prune` reference](../engine/reference/commandline/volume_prune.md)
for more examples.
## Prune networks
@ -138,7 +138,7 @@ $ docker network prune --filter "until=24h"
```
Other filtering expressions are available. See the
[`docker network prune` reference](/engine/reference/commandline/network_prune.md)
[`docker network prune` reference](../engine/reference/commandline/network_prune.md)
for more examples.
## Prune everything