closes #10231
[arvados.git] / doc / _includes / _install_docker_cleaner.liquid
1 h2. Configure the Docker cleaner
2
3 The arvados-docker-cleaner program removes least recently used Docker images as needed to keep disk usage below a configured limit.
4
5 {% include 'notebox_begin' %}
6 This also removes all containers as soon as they exit, as if they were run with @docker run --rm@. If you need to debug or inspect containers after they stop, temporarily stop arvados-docker-cleaner or configure it with @"RemoveStoppedContainers":"never"@.
7 {% include 'notebox_end' %}
8
9 Create a file @/etc/arvados/docker-cleaner/docker-cleaner.json@ in an editor, with the following contents.
10
11 <notextile>
12 <pre><code>{
13     "Quota": "<span class="userinput">10G</span>",
14     "RemoveStoppedContainers": "always"
15 }
16 </code></pre>
17 </notextile>
18
19 *Choosing a quota:* Most deployments will want a quota that's at least 10G.  From there, a larger quota can help reduce compute overhead by preventing reloading the same Docker image repeatedly, but will leave less space for other files on the same storage (usually Docker volumes).  Make sure the quota is less than the total space available for Docker images.
20
21 Restart the service after updating the configuration file.
22
23 <notextile>
24 <pre><code>~$ <span class="userinput">sudo systemctl restart arvados-docker-cleaner</span>
25 </code></pre>
26 </notextile>
27
28 *If you are using a different daemon supervisor,* or if you want to test the daemon in a terminal window, run @arvados-docker-cleaner@. Run @arvados-docker-cleaner --help@ for more configuration options.