You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
484 lines
14 KiB
HTML
484 lines
14 KiB
HTML
5 years ago
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!doctype html>
|
||
|
|
<html lang="en" class="no-js">
|
||
|
|
<head>
|
||
|
|
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="canonical" href="http://containrrr.github.io/watchtower/lifecycle-hooks/">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<meta name="lang:clipboard.copy" content="Copy to clipboard">
|
||
|
|
|
||
|
|
<meta name="lang:clipboard.copied" content="Copied to clipboard">
|
||
|
|
|
||
|
|
<meta name="lang:search.language" content="en">
|
||
|
|
|
||
|
|
<meta name="lang:search.pipeline.stopwords" content="True">
|
||
|
|
|
||
|
|
<meta name="lang:search.pipeline.trimmer" content="True">
|
||
|
|
|
||
|
|
<meta name="lang:search.result.none" content="No matching documents">
|
||
|
|
|
||
|
|
<meta name="lang:search.result.one" content="1 matching document">
|
||
|
|
|
||
|
|
<meta name="lang:search.result.other" content="# matching documents">
|
||
|
|
|
||
|
|
<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.2">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<title>Lifecycle hooks - Watchtower</title>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="../assets/stylesheets/application.30686662.css">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script src="../assets/javascripts/modernizr.74668098.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
|
||
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
|
||
|
|
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="../assets/fonts/material-icons.css">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body dir="ltr">
|
||
|
|
|
||
|
|
<svg class="md-svg">
|
||
|
|
<defs>
|
||
|
|
|
||
|
|
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
|
||
|
|
|
||
|
|
</defs>
|
||
|
|
</svg>
|
||
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||
|
|
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
|
||
|
|
|
||
|
|
<a href="#executing_commands_before_and_after_updating" tabindex="1" class="md-skip">
|
||
|
|
Skip to content
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
<header class="md-header" data-md-component="header">
|
||
|
|
<nav class="md-header-nav md-grid">
|
||
|
|
<div class="md-flex">
|
||
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
||
|
|
<a href="http://containrrr.github.io/watchtower/" title="Watchtower" class="md-header-nav__button md-logo">
|
||
|
|
|
||
|
|
<i class="md-icon"></i>
|
||
|
|
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
||
|
|
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
|
||
|
|
</div>
|
||
|
|
<div class="md-flex__cell md-flex__cell--stretch">
|
||
|
|
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
|
||
|
|
|
||
|
|
<span class="md-header-nav__topic">
|
||
|
|
Watchtower
|
||
|
|
</span>
|
||
|
|
<span class="md-header-nav__topic">
|
||
|
|
|
||
|
|
Lifecycle hooks
|
||
|
|
|
||
|
|
</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
||
|
|
|
||
|
|
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
|
||
|
|
|
||
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
||
|
|
<label class="md-search__overlay" for="__search"></label>
|
||
|
|
<div class="md-search__inner" role="search">
|
||
|
|
<form class="md-search__form" name="search">
|
||
|
|
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
|
||
|
|
<label class="md-icon md-search__icon" for="__search"></label>
|
||
|
|
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
|
||
|
|

|
||
|
|
</button>
|
||
|
|
</form>
|
||
|
|
<div class="md-search__output">
|
||
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
||
|
|
<div class="md-search-result" data-md-component="result">
|
||
|
|
<div class="md-search-result__meta">
|
||
|
|
Type to start searching
|
||
|
|
</div>
|
||
|
|
<ol class="md-search-result__list"></ol>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
||
|
|
<div class="md-header-nav__source">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="https://github.com/containrrr/watchtower/" title="Go to repository" class="md-source" data-md-source="github">
|
||
|
|
|
||
|
|
<div class="md-source__icon">
|
||
|
|
<svg viewBox="0 0 24 24" width="24" height="24">
|
||
|
|
<use xlink:href="#__github" width="24" height="24"></use>
|
||
|
|
</svg>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="md-source__repository">
|
||
|
|
GitHub
|
||
|
|
</div>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<div class="md-container">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<main class="md-main" role="main">
|
||
|
|
<div class="md-main__inner md-grid" data-md-component="container">
|
||
|
|
|
||
|
|
|
||
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
|
||
|
|
<div class="md-sidebar__scrollwrap">
|
||
|
|
<div class="md-sidebar__inner">
|
||
|
|
<nav class="md-nav md-nav--primary" data-md-level="0">
|
||
|
|
<label class="md-nav__title md-nav__title--site" for="__drawer">
|
||
|
|
<a href="http://containrrr.github.io/watchtower/" title="Watchtower" class="md-nav__button md-logo">
|
||
|
|
|
||
|
|
<i class="md-icon"></i>
|
||
|
|
|
||
|
|
</a>
|
||
|
|
Watchtower
|
||
|
|
</label>
|
||
|
|
|
||
|
|
<div class="md-nav__source">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="https://github.com/containrrr/watchtower/" title="Go to repository" class="md-source" data-md-source="github">
|
||
|
|
|
||
|
|
<div class="md-source__icon">
|
||
|
|
<svg viewBox="0 0 24 24" width="24" height="24">
|
||
|
|
<use xlink:href="#__github" width="24" height="24"></use>
|
||
|
|
</svg>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="md-source__repository">
|
||
|
|
GitHub
|
||
|
|
</div>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href=".." title="Home" class="md-nav__link">
|
||
|
|
Home
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="../introduction/" title="Introduction" class="md-nav__link">
|
||
|
|
Introduction
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="../usage-overview/" title="Usage overview" class="md-nav__link">
|
||
|
|
Usage overview
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="../arguments/" title="Arguments" class="md-nav__link">
|
||
|
|
Arguments
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="../notifications/" title="Notifications" class="md-nav__link">
|
||
|
|
Notifications
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="../container-selection/" title="Container selection" class="md-nav__link">
|
||
|
|
Container selection
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<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
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="../remote-hosts/" title="Remote hosts" class="md-nav__link">
|
||
|
|
Remote hosts
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="../secure-connections/" title="Secure connections" class="md-nav__link">
|
||
|
|
Secure connections
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="../stop-signals/" title="Stop signals" class="md-nav__link">
|
||
|
|
Stop signals
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
|
||
|
|
<div class="md-sidebar__scrollwrap">
|
||
|
|
<div class="md-sidebar__inner">
|
||
|
|
|
||
|
|
<nav class="md-nav md-nav--secondary">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<label class="md-nav__title" for="__toc">Table of contents</label>
|
||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="#executing_commands_before_and_after_updating" class="md-nav__link">
|
||
|
|
Executing commands before and after updating
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<nav class="md-nav">
|
||
|
|
<ul class="md-nav__list">
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="#specifying_update_commands" class="md-nav__link">
|
||
|
|
Specifying update commands
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="#execution_failure" class="md-nav__link">
|
||
|
|
Execution failure
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="md-content">
|
||
|
|
<article class="md-content__inner md-typeset">
|
||
|
|
|
||
|
|
|
||
|
|
<a href="https://github.com/containrrr/watchtower/edit/master/docs/lifecycle-hooks.md" title="Edit this page" class="md-icon md-content__icon"></a>
|
||
|
|
|
||
|
|
|
||
|
|
<h1>Lifecycle hooks</h1>
|
||
|
|
|
||
|
|
<h2 id="executing_commands_before_and_after_updating">Executing commands before and after updating<a class="headerlink" href="#executing_commands_before_and_after_updating" title="Permanent link">¶</a></h2>
|
||
|
|
<blockquote>
|
||
|
|
<p><strong>DO NOTE</strong>: Both commands are shell commands executed with <code>sh</code>, and therefore require the
|
||
|
|
container to provide the <code>sh</code> executable.</p>
|
||
|
|
</blockquote>
|
||
|
|
<p>It is possible to execute a <em>pre-update</em> command and a <em>post-update</em> command
|
||
|
|
<strong>inside</strong> every container updated by watchtower. The <em>pre-update</em> command is
|
||
|
|
executed before stopping the container, and the <em>post-update</em> command is
|
||
|
|
executed after restarting the container.</p>
|
||
|
|
<p>This feature is disabled by default. To enable it, you need to set the option
|
||
|
|
<code>--enable-lifecycle-hooks</code> on the command line, or set the environment variable
|
||
|
|
<code>WATCHTOWER_LIFECYCLE_HOOKS</code> to <code>true</code>.</p>
|
||
|
|
<h3 id="specifying_update_commands">Specifying update commands<a class="headerlink" href="#specifying_update_commands" title="Permanent link">¶</a></h3>
|
||
|
|
<p>The commands are specified using docker container labels, with
|
||
|
|
<code>com.centurylinklabs.watchtower.lifecycle.pre-update-command</code> for the <em>pre-update</em>
|
||
|
|
command and <code>com.centurylinklabs.watchtower.lifecycle.post-update</code> for the
|
||
|
|
<em>post-update</em> command.</p>
|
||
|
|
<p>These labels can be declared as instructions in a Dockerfile:</p>
|
||
|
|
<pre><code class="docker">LABEL com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh"
|
||
|
|
LABEL com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh"
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<p>Or be specified as part of the <code>docker run</code> command line:</p>
|
||
|
|
<pre><code class="bash">docker run -d \
|
||
|
|
--label=com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh" \
|
||
|
|
--label=com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh" \
|
||
|
|
someimage
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<h3 id="execution_failure">Execution failure<a class="headerlink" href="#execution_failure" title="Permanent link">¶</a></h3>
|
||
|
|
<p>The failure of a command to execute, identified by an exit code different than
|
||
|
|
0, will not prevent watchtower from updating the container. Only an error
|
||
|
|
log statement containing the exit code will be reported.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</main>
|
||
|
|
|
||
|
|
|
||
|
|
<footer class="md-footer">
|
||
|
|
|
||
|
|
<div class="md-footer-meta md-typeset">
|
||
|
|
<div class="md-footer-meta__inner md-grid">
|
||
|
|
<div class="md-footer-copyright">
|
||
|
|
|
||
|
|
powered by
|
||
|
|
<a href="https://www.mkdocs.org">MkDocs</a>
|
||
|
|
and
|
||
|
|
<a href="https://squidfunk.github.io/mkdocs-material/">
|
||
|
|
Material for MkDocs</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script src="../assets/javascripts/application.c648116f.js"></script>
|
||
|
|
|
||
|
|
<script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|