From 7a30fd71025b005cd7e24d3c097cdcf8547ed3ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Armando=20L=C3=BCscher?= Date: Fri, 9 Aug 2019 16:38:46 +0200 Subject: [PATCH] Correcting a few typos and text styling. (#359) --- docs/arguments.md | 10 +++++----- docs/container-selection.md | 2 +- docs/lifecycle-hooks.md | 4 ++-- docs/linked-containers.md | 2 +- docs/notifications.md | 4 ++-- docs/usage-overview.md | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/arguments.md b/docs/arguments.md index 2472cd2..90165d8 100644 --- a/docs/arguments.md +++ b/docs/arguments.md @@ -12,8 +12,8 @@ $ docker run -d \ ``` In the example above, watchtower will only monitor the containers named "nginx" and "redis" for updates -- all of the other -running containers will be ignored. If you do not want watchtower to run as a daemon you can pass a run-once flag and remove -the watchtower container after it's execution. +running containers will be ignored. If you do not want watchtower to run as a daemon you can pass the `--run-once` flag and remove +the watchtower container after its execution. ```bash $ docker run --rm \ @@ -23,7 +23,7 @@ $ docker run --rm \ nginx redis ``` -In the example above, watchtower will execute an upgrade attempt on the containers named "nginx" and "redis". Using this mode will enable debugging output showing all actions performed as usage is intended for interactive users. Once the attempt is completed, the container will exit and remove itself due to the "--rm" flag. +In the example above, watchtower will execute an upgrade attempt on the containers named "nginx" and "redis". Using this mode will enable debugging output showing all actions performed, as usage is intended for interactive users. Once the attempt is completed, the container will exit and remove itself due to the `--rm` flag. When no arguments are specified, watchtower will monitor all running containers. @@ -48,7 +48,7 @@ Environment Variable: WATCHTOWER_CLEANUP ``` ## Remove attached volumes -Removes attached volumes after updating. When this flag is specified, watchtower will remove all attached volumes from the container before restarting container with a new image. Use this option to force new volumes to be populated as containers are updated. +Removes attached volumes after updating. When this flag is specified, watchtower will remove all attached volumes from the container before restarting with a new image. Use this option to force new volumes to be populated as containers are updated. ``` Argument: --remove-volumes @@ -87,7 +87,7 @@ Environment Variable: WATCHTOWER_INCLUDE_STOPPED Default: false ``` -## Poll Interval +## Poll interval Poll interval (in seconds). This value controls how frequently watchtower will poll for new images. ``` diff --git a/docs/container-selection.md b/docs/container-selection.md index 0e2cd20..4c3312c 100644 --- a/docs/container-selection.md +++ b/docs/container-selection.md @@ -12,7 +12,7 @@ Or, it can be specified as part of the `docker run` command line: docker run -d --label=com.centurylinklabs.watchtower.enable=false someimage ``` -If you need to only include only some containers, pass the --label-enable flag on startup and set the _com.centurylinklabs.watchtower.enable_ label with a value of true for the containers you want to watch. +If you need to include only some containers, pass the `--label-enable` flag on startup and set the _com.centurylinklabs.watchtower.enable_ label with a value of `true` for the containers you want to watch. ```docker LABEL com.centurylinklabs.watchtower.enable="true" diff --git a/docs/lifecycle-hooks.md b/docs/lifecycle-hooks.md index bbf9d21..97d254e 100644 --- a/docs/lifecycle-hooks.md +++ b/docs/lifecycle-hooks.md @@ -11,14 +11,14 @@ executed after restarting the container. This feature is disabled by default. To enable it, you need to set the option `--enable-lifecycle-hooks` on the command line, or set the environment variable -`WATCHTOWER_LIFECYCLE_HOOKS` to true. +`WATCHTOWER_LIFECYCLE_HOOKS` to `true`. ### Specifying update commands The commands are specified using docker container labels, with -`com.centurylinklabs.watchtower.pre-update-command` for the *pre-update* +`com.centurylinklabs.watchtower.lifecycle.pre-update-command` for the *pre-update* command and `com.centurylinklabs.watchtower.lifecycle.post-update` for the *post-update* command. diff --git a/docs/linked-containers.md b/docs/linked-containers.md index 133d3ca..6960b5b 100644 --- a/docs/linked-containers.md +++ b/docs/linked-containers.md @@ -1,3 +1,3 @@ -Watchtower will detect if there are links between any of the running containers and ensure that things are stopped/started in a way that won't break any of the links. If an update is detected for one of the dependencies in a group of linked containers, watchtower will stop and start all of the containers in the correct order so that the application comes back up correctly. +Watchtower will detect if there are links between any of the running containers and ensures that things are stopped/started in a way that won't break any of the links. If an update is detected for one of the dependencies in a group of linked containers, watchtower will stop and start all of the containers in the correct order so that the application comes back up correctly. For example, imagine you were running a _mysql_ container and a _wordpress_ container which had been linked to the _mysql_ container. If watchtower were to detect that the _mysql_ container required an update, it would first shut down the linked _wordpress_ container followed by the _mysql_ container. When restarting the containers it would handle _mysql_ first and then _wordpress_ to ensure that the link continued to work. \ No newline at end of file diff --git a/docs/notifications.md b/docs/notifications.md index 853ee63..af6a5ec 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -47,7 +47,7 @@ If watchtower is monitoring the same Docker daemon under which the watchtower co To receive notifications in Slack, add `slack` to the `--notifications` option or the `WATCHTOWER_NOTIFICATIONS` environment variable. -Additionally, you should set the Slack webhook url using the `--notification-slack-hook-url` option or the `WATCHTOWER_NOTIFICATION_SLACK_HOOK_URL` environment variable. +Additionally, you should set the Slack webhook URL using the `--notification-slack-hook-url` option or the `WATCHTOWER_NOTIFICATION_SLACK_HOOK_URL` environment variable. By default, watchtower will send messages under the name `watchtower`, you can customize this string through the `--notification-slack-identifier` option or the `WATCHTOWER_NOTIFICATION_SLACK_IDENTIFIER` environment variable. @@ -76,7 +76,7 @@ docker run -d \ To receive notifications in MSTeams channel, add `msteams` to the `--notifications` option or the `WATCHTOWER_NOTIFICATIONS` environment variable. -Additionally, you should set the MSTeams webhook url using the `--notification-msteams-hook` option or the `WATCHTOWER_NOTIFICATION_MSTEAMS_HOOK_URL` environment variable. +Additionally, you should set the MSTeams webhook URL using the `--notification-msteams-hook` option or the `WATCHTOWER_NOTIFICATION_MSTEAMS_HOOK_URL` environment variable. MSTeams notifier could send keys/values filled by `log.WithField` or `log.WithFields` as MSTeams message facts. To enable this feature add `--notification-msteams-data` flag or set `WATCHTOWER_NOTIFICATION_MSTEAMS_USE_LOG_DATA=true` environment variable. diff --git a/docs/usage-overview.md b/docs/usage-overview.md index fcc2039..f74a9a7 100644 --- a/docs/usage-overview.md +++ b/docs/usage-overview.md @@ -1,6 +1,6 @@ Watchtower is itself packaged as a Docker container so installation is as simple as pulling the `containrrr/watchtower` image. If you are using ARM based architecture, pull the appropriate `containrrr/watchtower:armhf-` image from the [containrrr Docker Hub](https://hub.docker.com/r/containrrr/watchtower/tags/). -Since the watchtower code needs to interact with the Docker API in order to monitor the running containers, you need to mount _/var/run/docker.sock_ into the container with the -v flag when you run it. +Since the watchtower code needs to interact with the Docker API in order to monitor the running containers, you need to mount _/var/run/docker.sock_ into the container with the `-v` flag when you run it. Run the `watchtower` container with the following command: @@ -37,7 +37,7 @@ docker run -d \ containrrr/watchtower container_to_watch --debug ``` -If you mount the config file as described above, be sure to also prepend the url for the registry when starting up your watched image (you can omit the https://). Here is a complete docker-compose.yml file that starts up a docker container from a private repo at dockerhub and monitors it with watchtower. Note the command argument changing the interval to 30s rather than the default 5 minutes. +If you mount the config file as described above, be sure to also prepend the URL for the registry when starting up your watched image (you can omit the https://). Here is a complete docker-compose.yml file that starts up a docker container from a private repo at Docker Hub and monitors it with watchtower. Note the command argument changing the interval to 30s rather than the default 5 minutes. ```json version: "3"