Andreas/watchtower
1
0
Fork 0
mirror of https://github.com/containrrr/watchtower.git synced 2025-12-16 23:20:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deployed 1b3db5e with MkDocs version: 1.0.4

Browse source
This commit is contained in:
2019-09-15 14:54:30 +00:00
parent 5c39db873d
commit 82de4c9147
20 changed files with 1365 additions and 114 deletions
Download patch file Download diff file Expand all files Collapse all files

132
arguments/index.html
View file

@ -34,7 +34,7 @@
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.0">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
@ -42,7 +42,7 @@
<link rel="stylesheet" href="../assets/stylesheets/application.0284f74d.css">
<link rel="stylesheet" href="../assets/stylesheets/application.30686662.css">
@ -171,7 +171,7 @@
<main class="md-main">
<main class="md-main" role="main">
<div class="md-main__inner md-grid" data-md-component="container">
@ -275,91 +275,105 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#help" title="Help" class="md-nav__link">
<a href="#help" class="md-nav__link">
Help
</a>
</li>
<li class="md-nav__item">
<a href="#cleanup" title="Cleanup" class="md-nav__link">
<a href="#cleanup" class="md-nav__link">
Cleanup
</a>
</li>
<li class="md-nav__item">
<a href="#debug" title="Debug" class="md-nav__link">
<a href="#remove_attached_volumes" class="md-nav__link">
Remove attached volumes
</a>
</li>
<li class="md-nav__item">
<a href="#debug" class="md-nav__link">
Debug
</a>
</li>
<li class="md-nav__item">
<a href="#docker_host" title="Docker host" class="md-nav__link">
<a href="#docker_host" class="md-nav__link">
Docker host
</a>
</li>
<li class="md-nav__item">
<a href="#include_stopped" title="Include stopped" class="md-nav__link">
<a href="#docker_api_version" class="md-nav__link">
Docker API version
</a>
</li>
<li class="md-nav__item">
<a href="#include_stopped" class="md-nav__link">
Include stopped
</a>
</li>
<li class="md-nav__item">
<a href="#poll_interval" title="Poll Interval" class="md-nav__link">
Poll Interval
<a href="#poll_interval" class="md-nav__link">
Poll interval
</a>
</li>
<li class="md-nav__item">
<a href="#filter_by_enable_label" title="Filter by enable label" class="md-nav__link">
<a href="#filter_by_enable_label" class="md-nav__link">
Filter by enable label
</a>
</li>
<li class="md-nav__item">
<a href="#without_updating_containers" title="Without updating containers" class="md-nav__link">
<a href="#without_updating_containers" class="md-nav__link">
Without updating containers
</a>
</li>
<li class="md-nav__item">
<a href="#without_pulling_new_images" title="Without pulling new images" class="md-nav__link">
<a href="#without_pulling_new_images" class="md-nav__link">
Without pulling new images
</a>
</li>
<li class="md-nav__item">
<a href="#run_once" title="Run once" class="md-nav__link">
<a href="#run_once" class="md-nav__link">
Run once
</a>
</li>
<li class="md-nav__item">
<a href="#scheduling" title="Scheduling" class="md-nav__link">
<a href="#scheduling" class="md-nav__link">
Scheduling
</a>
</li>
<li class="md-nav__item">
<a href="#wait_until_timeout" title="Wait until timeout" class="md-nav__link">
<a href="#wait_until_timeout" class="md-nav__link">
Wait until timeout
</a>
</li>
<li class="md-nav__item">
<a href="#tls_verification" title="TLS Verification" class="md-nav__link">
<a href="#tls_verification" class="md-nav__link">
TLS Verification
</a>
@ -405,6 +419,18 @@
<li class="md-nav__item">
<a href="../credential-helpers/" title="Credential helpers" class="md-nav__link">
Credential helpers
</a>
</li>
<li class="md-nav__item">
<a href="../linked-containers/" title="Linked containers" class="md-nav__link">
Linked containers
@ -467,91 +493,105 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#help" title="Help" class="md-nav__link">
<a href="#help" class="md-nav__link">
Help
</a>
</li>
<li class="md-nav__item">
<a href="#cleanup" title="Cleanup" class="md-nav__link">
<a href="#cleanup" class="md-nav__link">
Cleanup
</a>
</li>
<li class="md-nav__item">
<a href="#debug" title="Debug" class="md-nav__link">
<a href="#remove_attached_volumes" class="md-nav__link">
Remove attached volumes
</a>
</li>
<li class="md-nav__item">
<a href="#debug" class="md-nav__link">
Debug
</a>
</li>
<li class="md-nav__item">
<a href="#docker_host" title="Docker host" class="md-nav__link">
<a href="#docker_host" class="md-nav__link">
Docker host
</a>
</li>
<li class="md-nav__item">
<a href="#include_stopped" title="Include stopped" class="md-nav__link">
<a href="#docker_api_version" class="md-nav__link">
Docker API version
</a>
</li>
<li class="md-nav__item">
<a href="#include_stopped" class="md-nav__link">
Include stopped
</a>
</li>
<li class="md-nav__item">
<a href="#poll_interval" title="Poll Interval" class="md-nav__link">
Poll Interval
<a href="#poll_interval" class="md-nav__link">
Poll interval
</a>
</li>
<li class="md-nav__item">
<a href="#filter_by_enable_label" title="Filter by enable label" class="md-nav__link">
<a href="#filter_by_enable_label" class="md-nav__link">
Filter by enable label
</a>
</li>
<li class="md-nav__item">
<a href="#without_updating_containers" title="Without updating containers" class="md-nav__link">
<a href="#without_updating_containers" class="md-nav__link">
Without updating containers
</a>
</li>
<li class="md-nav__item">
<a href="#without_pulling_new_images" title="Without pulling new images" class="md-nav__link">
<a href="#without_pulling_new_images" class="md-nav__link">
Without pulling new images
</a>
</li>
<li class="md-nav__item">
<a href="#run_once" title="Run once" class="md-nav__link">
<a href="#run_once" class="md-nav__link">
Run once
</a>
</li>
<li class="md-nav__item">
<a href="#scheduling" title="Scheduling" class="md-nav__link">
<a href="#scheduling" class="md-nav__link">
Scheduling
</a>
</li>
<li class="md-nav__item">
<a href="#wait_until_timeout" title="Wait until timeout" class="md-nav__link">
<a href="#wait_until_timeout" class="md-nav__link">
Wait until timeout
</a>
</li>
<li class="md-nav__item">
<a href="#tls_verification" title="TLS Verification" class="md-nav__link">
<a href="#tls_verification" class="md-nav__link">
TLS Verification
</a>
@ -590,8 +630,8 @@ launching watchtower.</p>
</code></pre>
<p>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.</p>
running containers will be ignored. If you do not want watchtower to run as a daemon you can pass the <code>--run-once</code> flag and remove
the watchtower container after its execution.</p>
<pre><code class="bash">$ docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
@ -599,7 +639,7 @@ the watchtower container after it's execution.</p>
nginx redis
</code></pre>
<p>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.</p>
<p>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 <code>--rm</code> flag.</p>
<p>When no arguments are specified, watchtower will monitor all running containers.</p>
<h2 id="help">Help<a class="headerlink" href="#help" title="Permanent link">&para;</a></h2>
<p>Shows documentation about the supported flags.</p>
@ -617,6 +657,14 @@ Environment Variable: WATCHTOWER_CLEANUP
Default: false
</code></pre>
<h2 id="remove_attached_volumes">Remove attached volumes<a class="headerlink" href="#remove_attached_volumes" title="Permanent link">&para;</a></h2>
<p>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.</p>
<pre><code> Argument: --remove-volumes
Environment Variable: WATCHTOWER_REMOVE_VOLUMES
Type: Boolean
Default: false
</code></pre>
<h2 id="debug">Debug<a class="headerlink" href="#debug" title="Permanent link">&para;</a></h2>
<p>Enable debug mode with verbose logging.</p>
<pre><code> Argument: --debug
@ -633,6 +681,14 @@ Environment Variable: DOCKER_HOST
Default: &quot;unix:///var/run/docker.sock&quot;
</code></pre>
<h2 id="docker_api_version">Docker API version<a class="headerlink" href="#docker_api_version" title="Permanent link">&para;</a></h2>
<p>The API version to use by the Docker client for connecting to the Docker daemon. The minimum supported version is 1.24.</p>
<pre><code> Argument: --api-version, -a
Environment Variable: DOCKER_API_VERSION
Type: String
Default: &quot;1.24&quot;
</code></pre>
<h2 id="include_stopped">Include stopped<a class="headerlink" href="#include_stopped" title="Permanent link">&para;</a></h2>
<p>Will also include created and exited containers.</p>
<pre><code> Argument: --include-stopped
@ -641,16 +697,16 @@ Environment Variable: WATCHTOWER_INCLUDE_STOPPED
Default: false
</code></pre>
<h2 id="poll_interval">Poll Interval<a class="headerlink" href="#poll_interval" title="Permanent link">&para;</a></h2>
<h2 id="poll_interval">Poll interval<a class="headerlink" href="#poll_interval" title="Permanent link">&para;</a></h2>
<p>Poll interval (in seconds). This value controls how frequently watchtower will poll for new images.</p>
<pre><code> Argument: ---interval, -i
<pre><code> Argument: --interval, -i
Environment Variable: WATCHTOWER_POLL_INTERVAL
Type: Integer
Default: 300
</code></pre>
<h2 id="filter_by_enable_label">Filter by enable label<a class="headerlink" href="#filter_by_enable_label" title="Permanent link">&para;</a></h2>
<p>Watch containers where the <code>com.centurylinklabs.watchtower.enable</code> label is set to true.</p>
<p>Update containers that have a <code>com.centurylinklabs.watchtower.enable</code> label set to true.</p>
<pre><code> Argument: --label-enable
Environment Variable: WATCHTOWER_LABEL_ENABLE
Type: Boolean
@ -776,7 +832,7 @@ Environment Variable: DOCKER_TLS_VERIFY
</div>
<script src="../assets/javascripts/application.245445c6.js"></script>
<script src="../assets/javascripts/application.c648116f.js"></script>
<script>app.initialize({version:"1.0.4",url:{base:".."}})</script>