|
|
|
|
|
|
|
|
|
|
|
<!doctype html>
|
|
|
<html lang="en" class="no-js">
|
|
|
<head>
|
|
|
|
|
|
<meta charset="utf-8">
|
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
|
|
|
|
<link rel="canonical" href="http://containrrr.github.io/watchtower/private-registries/">
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../assets/images/favicon.png">
|
|
|
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-5.2.2">
|
|
|
|
|
|
|
|
|
|
|
|
<title>Private registries - Watchtower</title>
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.a2408e81.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
|
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|
|
<style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
<body dir="ltr">
|
|
|
|
|
|
<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" for="__drawer"></label>
|
|
|
<div data-md-component="skip">
|
|
|
|
|
|
|
|
|
<a href="#create_the_configuration_file_manually" class="md-skip">
|
|
|
Skip to content
|
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
<div data-md-component="announce">
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
|
<nav class="md-header-nav md-grid" aria-label="Header">
|
|
|
<a href="http://containrrr.github.io/watchtower/" title="Watchtower" class="md-header-nav__button md-logo" aria-label="Watchtower">
|
|
|
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
|
|
|
|
|
|
</a>
|
|
|
<label class="md-header-nav__button md-icon" for="__drawer">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
|
|
|
</label>
|
|
|
<div class="md-header-nav__title" data-md-component="header-title">
|
|
|
|
|
|
<div class="md-header-nav__ellipsis">
|
|
|
<span class="md-header-nav__topic md-ellipsis">
|
|
|
Watchtower
|
|
|
</span>
|
|
|
<span class="md-header-nav__topic md-ellipsis">
|
|
|
|
|
|
Private registries
|
|
|
|
|
|
</span>
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<label class="md-header-nav__button md-icon" for="__search">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
|
</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" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
|
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
|
</label>
|
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
|
|
|
</button>
|
|
|
</form>
|
|
|
<div class="md-search__output">
|
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
|
<div class="md-search-result__meta">
|
|
|
Initializing search
|
|
|
</div>
|
|
|
<ol class="md-search-result__list"></ol>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
<div class="md-header-nav__source">
|
|
|
|
|
|
<a href="https://github.com/containrrr/watchtower/" title="Go to repository" class="md-source">
|
|
|
<div class="md-source__icon md-icon">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
|
|
|
</div>
|
|
|
<div class="md-source__repository">
|
|
|
GitHub
|
|
|
</div>
|
|
|
</a>
|
|
|
</div>
|
|
|
|
|
|
</nav>
|
|
|
</header>
|
|
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
|
<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" aria-label="Navigation" data-md-level="0">
|
|
|
<label class="md-nav__title" for="__drawer">
|
|
|
<a href="http://containrrr.github.io/watchtower/" title="Watchtower" class="md-nav__button md-logo" aria-label="Watchtower">
|
|
|
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
|
|
|
|
|
|
</a>
|
|
|
Watchtower
|
|
|
</label>
|
|
|
|
|
|
<div class="md-nav__source">
|
|
|
|
|
|
<a href="https://github.com/containrrr/watchtower/" title="Go to repository" class="md-source">
|
|
|
<div class="md-source__icon md-icon">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></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 md-nav__item--active">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
|
Private registries
|
|
|
<span class="md-nav__icon md-icon">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 9h14V7H3v2m0 4h14v-2H3v2m0 4h14v-2H3v2m16 0h2v-2h-2v2m0-10v2h2V7h-2m0 6h2v-2h-2v2z"/></svg>
|
|
|
</span>
|
|
|
</label>
|
|
|
|
|
|
<a href="./" title="Private registries" class="md-nav__link md-nav__link--active">
|
|
|
Private registries
|
|
|
</a>
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
|
<span class="md-nav__icon md-icon">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
|
</span>
|
|
|
Table of contents
|
|
|
</label>
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#create_the_configuration_file_manually" class="md-nav__link">
|
|
|
Create the configuration file manually
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#i_username_and_password_for_gcloud" class="md-nav__link">
|
|
|
ℹ️ Username and Password for GCloud
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#share_the_docker_configuration_file" class="md-nav__link">
|
|
|
Share the Docker configuration file
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#credential_helpers" class="md-nav__link">
|
|
|
Credential helpers
|
|
|
</a>
|
|
|
|
|
|
<nav class="md-nav" aria-label="Credential helpers">
|
|
|
<ul class="md-nav__list">
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#example" class="md-nav__link">
|
|
|
Example
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
</nav>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="../lifecycle-hooks/" title="Lifecycle hooks" class="md-nav__link">
|
|
|
Lifecycle hooks
|
|
|
</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" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
|
<span class="md-nav__icon md-icon">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
|
</span>
|
|
|
Table of contents
|
|
|
</label>
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#create_the_configuration_file_manually" class="md-nav__link">
|
|
|
Create the configuration file manually
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#i_username_and_password_for_gcloud" class="md-nav__link">
|
|
|
ℹ️ Username and Password for GCloud
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#share_the_docker_configuration_file" class="md-nav__link">
|
|
|
Share the Docker configuration file
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#credential_helpers" class="md-nav__link">
|
|
|
Credential helpers
|
|
|
</a>
|
|
|
|
|
|
<nav class="md-nav" aria-label="Credential helpers">
|
|
|
<ul class="md-nav__list">
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#example" class="md-nav__link">
|
|
|
Example
|
|
|
</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/private-registries.md" title="Edit this page" class="md-content__button md-icon">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1>Private registries</h1>
|
|
|
|
|
|
<p>Watchtower supports private Docker image registries. In many cases, accessing a private registry
|
|
|
requires a valid username and password (i.e., <em>credentials</em>). In order to operate in such an
|
|
|
environment, watchtower needs to know the credentials to access the registry. </p>
|
|
|
<p>The credentials can be provided to watchtower in a configuration file called <code>config.json</code>.
|
|
|
There are two ways to generate this configuration file:</p>
|
|
|
<ul>
|
|
|
<li>The configuration file can be created manually.</li>
|
|
|
<li>Call <code>docker login <REGISTRY_NAME></code> and share the resulting configuration file.</li>
|
|
|
</ul>
|
|
|
<h3 id="create_the_configuration_file_manually">Create the configuration file manually<a class="headerlink" href="#create_the_configuration_file_manually" title="Permanent link">¶</a></h3>
|
|
|
<p>Create a new configuration file with the following syntax and a base64 encoded username and
|
|
|
password <code>auth</code> string:</p>
|
|
|
<pre><code class="json">{
|
|
|
"auths": {
|
|
|
"<REGISTRY_NAME>": {
|
|
|
"auth": "XXXXXXX"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
</code></pre>
|
|
|
|
|
|
<p><code><REGISTRY_NAME></code> needs to be replaced by the name of your private registry
|
|
|
(e.g., <code>my-private-registry.example.org</code>)</p>
|
|
|
<p>The required <code>auth</code> string can be generated as follows:</p>
|
|
|
<pre><code class="bash">echo -n 'username:password' | base64
|
|
|
</code></pre>
|
|
|
|
|
|
<blockquote>
|
|
|
<h3 id="i_username_and_password_for_gcloud">ℹ️ Username and Password for GCloud<a class="headerlink" href="#i_username_and_password_for_gcloud" title="Permanent link">¶</a></h3>
|
|
|
<p>For gcloud, we'll use <code>__json_key</code> as our username and the content
|
|
|
of <code>gcloudauth.json</code> as the password.</p>
|
|
|
</blockquote>
|
|
|
<p>When the watchtower Docker container is started, the created configuration file
|
|
|
(<code><PATH>/config.json</code> in this example) needs to be passed to the container:</p>
|
|
|
<pre><code class="bash">docker run [...] -v <PATH>/config.json:/config.json containrrr/watchtower
|
|
|
</code></pre>
|
|
|
|
|
|
<h3 id="share_the_docker_configuration_file">Share the Docker configuration file<a class="headerlink" href="#share_the_docker_configuration_file" title="Permanent link">¶</a></h3>
|
|
|
<p>To pull an image from a private registry, <code>docker login</code> needs to be called first, to get access
|
|
|
to the registry. The provided credentials are stored in a configuration file called <code><PATH_TO_HOME_DIR>/.docker/config.json</code>.
|
|
|
This configuration file can be directly used by watchtower. In this case, the creation of an
|
|
|
additional configuration file is not necessary.</p>
|
|
|
<p>When the Docker container is started, pass the configuration file to watchtower:</p>
|
|
|
<pre><code class="bash">docker run [...] -v <PATH_TO_HOME_DIR>/.docker/config.json:/config.json containrrr/watchtower
|
|
|
</code></pre>
|
|
|
|
|
|
<p>When creating the watchtower container via docker-compose, use the following lines:</p>
|
|
|
<pre><code class="yaml">version: "3"
|
|
|
[...]
|
|
|
watchtower:
|
|
|
image: index.docker.io/containrrr/watchtower:latest
|
|
|
volumes:
|
|
|
- /var/run/docker.sock:/var/run/docker.sock
|
|
|
- <PATH_TO_HOME_DIR>/.docker/config.json:/config.json
|
|
|
[...]
|
|
|
</code></pre>
|
|
|
|
|
|
<h2 id="credential_helpers">Credential helpers<a class="headerlink" href="#credential_helpers" title="Permanent link">¶</a></h2>
|
|
|
<p>Some private Docker registries (the most prominent probably being AWS ECR) use non-standard ways of authentication.
|
|
|
To be able to use this together with watchtower, we need to use a credential helper.</p>
|
|
|
<p>To keep the image size small we've decided to not include any helpers in the watchtower image, instead we'll put the
|
|
|
helper in a separate container and mount it using volumes.</p>
|
|
|
<h3 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h3>
|
|
|
<p>Example implementation for use with <a href="https://github.com/awslabs/amazon-ecr-credential-helper">amazon-ecr-credential-helper</a>:</p>
|
|
|
<pre><code class="Dockerfile">FROM golang:latest
|
|
|
|
|
|
ENV CGO_ENABLED 0
|
|
|
ENV REPO github.com/awslabs/amazon-ecr-credential-helper/ecr-login/cli/docker-credential-ecr-login
|
|
|
|
|
|
RUN go get -u $REPO
|
|
|
|
|
|
RUN rm /go/bin/docker-credential-ecr-login
|
|
|
|
|
|
RUN go build \
|
|
|
-o /go/bin/docker-credential-ecr-login \
|
|
|
/go/src/$REPO
|
|
|
|
|
|
WORKDIR /go/bin/
|
|
|
</code></pre>
|
|
|
|
|
|
<p>and the docker-compose definition:</p>
|
|
|
<pre><code class="yaml">version: "3"
|
|
|
|
|
|
services:
|
|
|
watchtower:
|
|
|
image: index.docker.io/containrrr/watchtower:latest
|
|
|
volumes:
|
|
|
- /var/run/docker.sock:/var/run/docker.sock
|
|
|
- <PATH_TO_HOME_DIR>/.docker/config.json:/config.json
|
|
|
- helper:/go/bin
|
|
|
environment:
|
|
|
- HOME=/
|
|
|
- PATH=$PATH:/go/bin
|
|
|
- AWS_REGION=<AWS_REGION>
|
|
|
- AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY>
|
|
|
- AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
|
|
|
volumes:
|
|
|
helper: {}
|
|
|
</code></pre>
|
|
|
|
|
|
<p>and for <code><PATH_TO_HOME_DIR>/.docker/config.json</code>:</p>
|
|
|
<pre><code class="json"> {
|
|
|
"HttpHeaders" : {
|
|
|
"User-Agent" : "Docker-Client/19.03.1 (XXXXXX)"
|
|
|
},
|
|
|
"credsStore" : "osxkeychain",
|
|
|
"auths" : {
|
|
|
"xyzxyzxyz.dkr.ecr.eu-north-1.amazonaws.com" : {},
|
|
|
"https://index.docker.io/v1/": {}
|
|
|
},
|
|
|
"credHelpers": {
|
|
|
"xyzxyzxyz.dkr.ecr.eu-north-1.amazonaws.com" : "ecr-login",
|
|
|
"index.docker.io": "osxkeychain"
|
|
|
}
|
|
|
}
|
|
|
</code></pre>
|
|
|
|
|
|
<p><em>Note:</em> <code>osxkeychain</code> can be changed to your preferred credentials helper.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
</div>
|
|
|
</div>
|
|
|
</main>
|
|
|
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
|
|
<div class="md-footer-nav">
|
|
|
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
|
|
|
|
|
|
<a href="../container-selection/" title="Container selection" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
|
|
<div class="md-footer-nav__button md-icon">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
|
</div>
|
|
|
<div class="md-footer-nav__title">
|
|
|
<div class="md-ellipsis">
|
|
|
<span class="md-footer-nav__direction">
|
|
|
Previous
|
|
|
</span>
|
|
|
Container selection
|
|
|
</div>
|
|
|
</div>
|
|
|
</a>
|
|
|
|
|
|
|
|
|
<a href="../linked-containers/" title="Linked containers" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
|
|
|
<div class="md-footer-nav__title">
|
|
|
<div class="md-ellipsis">
|
|
|
<span class="md-footer-nav__direction">
|
|
|
Next
|
|
|
</span>
|
|
|
Linked containers
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="md-footer-nav__button md-icon">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
|
|
|
</div>
|
|
|
</a>
|
|
|
|
|
|
</nav>
|
|
|
</div>
|
|
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
|
<div class="md-footer-meta__inner md-grid">
|
|
|
<div class="md-footer-copyright">
|
|
|
|
|
|
Made with
|
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
|
Material for MkDocs
|
|
|
</a>
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
</footer>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<script src="../assets/javascripts/vendor.d710d30a.min.js"></script>
|
|
|
<script src="../assets/javascripts/bundle.5f27aba8.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents"}</script>
|
|
|
|
|
|
<script>
|
|
|
app = initialize({
|
|
|
base: "..",
|
|
|
features: [],
|
|
|
search: Object.assign({
|
|
|
worker: "../assets/javascripts/worker/search.27c6a5e6.min.js"
|
|
|
}, typeof search !== "undefined" && search)
|
|
|
})
|
|
|
</script>
|
|
|
|
|
|
|
|
|
</body>
|
|
|
</html> |