harbor/docs/administration/garbage-collection/_index.md

44 lines
1.9 KiB
Markdown
Raw Normal View History

---
title: Garbage Collection
weight: 40
---
2019-10-17 15:47:25 +02:00
2019-12-13 15:08:40 +01:00
When you delete images from Harbor, space is not automatically freed up. You must run garbage collection to free up space by removing blobs that are no longer referenced by a manifest from the file system.
2019-10-17 15:47:25 +02:00
2020-01-13 16:05:58 +01:00
## Run Garbage Collection
2019-10-17 15:47:25 +02:00
2019-12-13 15:08:40 +01:00
1. Log in to the Harbor interface with an account that has Harbor system administrator privileges.
1. Expand **Administration**, and select **Garbage Collection**.
1. Select the **'Garbage Collection'** tab.
![Garbage collection](../../img/garbage-collection.png)
1. To delete untagged artifacts, select the check box **Delete Untagged Artifacts**.
2019-12-13 15:08:40 +01:00
1. To run garbage collection immediately, click **GC Now**.
2019-10-17 15:47:25 +02:00
2019-12-13 15:08:40 +01:00
When you run garbage collection, Harbor goes into read-only mode. All modifications to the registry are prohibited.
2019-10-17 15:47:25 +02:00
2019-12-13 15:08:40 +01:00
To avoid triggering the garbage collection process too frequently, the availability of the **GC Now** button is restricted. Garbage collection can be only run once per minute.
2019-10-17 15:47:25 +02:00
2020-01-13 16:05:58 +01:00
## Schedule Garbage Collection
2019-10-17 15:47:25 +02:00
2019-12-13 15:08:40 +01:00
1. Expand **Administration**, and select **Garbage Collection**.
1. Select the **'Garbage Collection'** tab.
1. Use the drop down-menu to select how often to run garbage collection.
![Schedule garbage collection](../../img/gc-policy.png)
* **None**: No garbage collection is scheduled.
* **Hourly**: Run garbage collection at the beginning of every hour.
* **Daily**: Run garbage collection at midnight every day.
* **Weekly**: Run garbage collection at midnight every Saturday.
* **Custom**: Run garbage collection according to a `cron` job.
1. To delete untagged artifacts, select the check box **Delete Untagged Artifacts**.
2019-12-13 15:08:40 +01:00
1. Click **Save**.
1. Select the **History** tab to view records of the 10 most recent garbage collection runs.
![Garbage collection history](../../img/gc-history.png)
2019-12-18 16:06:18 +01:00
1. Click on the **Logs** link to view the related logs.