From 42c1e259937eeb770f2dbd52925250ceeeb2a78f Mon Sep 17 00:00:00 2001
From: Maria Bermudez <bermudez.mt@gmail.com>
Date: Fri, 31 Aug 2018 15:00:19 -0700
Subject: [PATCH] Initial draft of online GC

---
 .../configure/online-garbage-collection.md    | 99 +++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 ee/dtr/admin/configure/online-garbage-collection.md

diff --git a/ee/dtr/admin/configure/online-garbage-collection.md b/ee/dtr/admin/configure/online-garbage-collection.md
new file mode 100644
index 0000000000..745575fea3
--- /dev/null
+++ b/ee/dtr/admin/configure/online-garbage-collection.md
@@ -0,0 +1,99 @@
+---
+title: Online Garbage collection
+description: Save disk space by configuring the garbage collection settings in
+  Docker Trusted Registry
+keywords: registry, online garbage collection, gc, space, disk space
+---
+
+> BETA DISCLAIMER
+>
+> This is beta content. It is not yet complete and should be considered a work in progress. This content is subject to change without notice.
+
+
+You can configure Docker Trusted Registry to automatically delete unused image
+layers, thus saving you disk space. This process is also known as garbage collection.
+
+## How DTR deletes unused layers
+
+First you configure DTR to run a garbage collection job on a fixed schedule. At
+the scheduled time DTR:
+
+2. Identifies and marks unused image layers.
+3. Deletes the marked image layers.
+
+As of v2.6.0, online garbage collection is no longer in experimental mode. The registry no longer has to be in read-only mode (or offline) during garbage collection. 
+
+To enable garbage collection, navigate to the **DTR web UI**, go to **Settings** and
+choose **Garbage collection**.
+
+![upgrade garbage collection](../../images/garbage-collection-0.png){: .with-border}
+
+Once enabled this setting can't be changed back. The upgrade process might
+take a while depending on the amount of Docker images that you have stored.
+
+During this upgrade users can still push and pull images from DTR, but
+the garbage collection job will be temporarily disabled.
+
+## Schedule garbage collection
+
+Navigate to the **Settings** page, and choose **Garbage collection**.
+
+![](../../images/garbage-collection-1.png){: .with-border}
+
+Select for how long the garbage collection job should run:
+* Until done: Run the job until all unused image layers are deleted.
+* For x minutes: Only run the garbage collection job for a maximum of x minutes
+at a time.
+* Never: Never delete unused image layers.
+
+Once you select for how long to run the garbage collection job, you can
+configure its schedule (in UTC time) using the cron format.
+
+![](../../images/garbage-collection-2.png){: .with-border}
+
+Once everything is configured you can chose to **Save & start** to immediately
+run the garbage collection job, or just **Save** to run the job on the next
+scheduled interval.
+
+## Stop the garbage collection job
+
+Once the garbage collection job starts running, a banner is displayed on the
+web UI explaining that users can't push images. If you're an administrator, you can click the banner to stop the garbage
+collection job.
+
+![](../../images/garbage-collection-3.png){: .with-border}
+
+## Under the hood
+
+Each image stored in DTR is made up of multiple files:
+
+* A list of image layers that represent the image filesystem.
+* A configuration file that contains the architecture of the image and other
+metadata.
+* A manifest file containing the list of all layers and configuration file for
+an image.
+
+All these files are stored in a content-addressable way in which the name of
+the file is the result of hashing the file's content. This means that if two
+image tags have exactly the same content, DTR only stores the image content
+once, even if the tag name is different.
+
+As an example, if `wordpress:4.8` and `wordpress:latest` have the same content,
+they will only be stored once. If you delete one of these tags, the other won't
+be deleted.
+
+This means that when users delete an image tag, DTR can't delete the underlying
+files of that image tag since it's possible that there are other tags that
+also use the same files.
+
+To delete unused image layers, DTR:
+1. Becomes read-only to make sure that no one is able to push an image, thus
+changing the underlying files in the filesystem.
+2. Check all the manifest files and keep a record of the files that are
+referenced.
+3. If a file is never referenced, that means that no image tag uses it, so it
+can be safely deleted.
+
+## Where to go next
+
+- [Deploy DTR caches](deploy-caches/index.md)