diff --git a/docs/user_guide.md b/docs/user_guide.md index 4d087b37b..11ac4a3ae 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -554,27 +554,28 @@ helm install --ca-file=ca.crt --key-file=server.key --cert-file=server.crt --use For other more helm commands like how to sign a chart, please refer to the [helm doc](https://docs.helm.sh/helm/#helm). ## Online Garbage Collection -Online Garbage Collection is to let user to trigger docker registry garbage collection by clicking button in UI. +Online Garbage Collection enables user to trigger docker registry garbage collection by clicking button on UI. -**NOTES:** GC is not stoppable, and it deletes unused image layers. +**NOTES:** The space is not freed when the images are deleted from Harbor, Garbage Collection is the task to free up the space by removing blobs from the filesystem when they are no longer referenced by a manifest. -### Setting up garbage collection +### Setting up Garbage Collection If you are a system admin, you can trigger garbage collection by clicking "GC Now" in the **'Garbage Collection'** tab of **'Configuration'** section under **'Administration'**. ![browse project](img/gc_now.png) -**NOTES:** Harbor is put into read-only mode when to execute GC, and any modification on docker registry is prohibited. +**NOTES:** Harbor is put into read-only mode when to execute Garbage Collection, and any modification on docker registry is prohibited. -To avoid frequently triggering the gc process, the availability of the button is restricted. It can be only triggered once in one minute. +To avoid frequently triggering the garbage collection process, the availability of the button is restricted. It can be only triggered once in one minute. ![browse project](img/gc_now2.png) -**Scheduled GC by Policy** +**Scheduled Garbage Collection by Policy** * **None:** No policy is selected. -* **Daily:** Policy is activated daily. It means an analysis job is scheduled to be executed at the specified time everyday. The scheduled job will do GC in Harbor. +* **Daily:** Policy is activated daily. It means an analysis job is scheduled to be executed at the specified time everyday. The scheduled job will do garbage collection in Harbor. +* **Weekly:** Policy is activated weekly. It means an analysis job is scheduled to be executed at the specified time every week. The scheduled job will do garbage collection in Harbor. Once the policy has been configured, you have the option to save the schedule. ![browse project](img/gc_policy.png) -### GC history -If you are a system admin, you can view the latest 10 records of GC execution. +### Garbage Collection history +If you are a system admin, you can view the latest 10 records of garbage collection execution. ![browse project](img/gc_history.png) You can click on the 'details' link to view the related logs.