Feature: Implement Garbage Collection (GC) Management Commands

[intojhanurag]

Description

Currently, the Harbor CLI lacks support for managing Garbage Collection (GC), which is a key gap compared to the Harbor WebUI. Users must switch to the WebUI to trigger or schedule storage cleanup, breaking the flow for CLI-based administration and automation.

This PR adds full GC management capabilities to the Harbor CLI.

Closed

• Fixes feat: Implement Garbage Collection (GC) Management Commands #619

Proposed Solution

Introduce a new gc command group under the System group with the following sub-commands:

• harbor gc list
  List the history of GC executions, including ID, status, dry-run, and start/end time.

  • --page 2 --page-size 20
  • --sort -creation_time
  • --match job_status=Success : filter gc history by exact match
  • --fuzzy job_name=gc : filter gc history by fuzzy match
  • --range id=1~10 : filter gc history by range

• harbor gc schedule
  View the current GC schedule (rendered using table view).

• harbor gc update-schedule [type]
  Update the GC schedule. Supported schedule types: none, hourly, daily, weekly, custom-> Interactive input of user.

  • After harbor gc update-schedule custom
    User will go through the interactive prompt where he will enter the 6-field cron format.

• harbor gc run
  Manually trigger a GC job. Supports flags:

  • --dry-run: Simulate GC without deleting artifacts.
  • --delete-untagged: Delete untagged artifacts (default: true).

• harbor gc stop

  • Interactive select from all active running gc and then with cursor he will select the process that he want to stop

• harbor gc log [id]
  Retrieve and display the log for a specific GC execution.

video demo

https://www.loom.com/share/0b068199f6b34f64b290cee2030e0406

[codecov]

Codecov Report

❌ Patch coverage is 3.09917% with 469 lines in your changes missing coverage. Please review.
✅ Project coverage is 7.29%. Comparing base (60ad0bd) to head (7c5ef97).
⚠️ Report is 106 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/harbor/root/gc/update_schedule.go	14.45%	71 Missing ⚠️
pkg/api/gc_handler.go	0.00%	64 Missing ⚠️
cmd/harbor/root/gc/list.go	0.00%	62 Missing ⚠️
pkg/prompt/prompt.go	0.00%	51 Missing ⚠️
cmd/harbor/root/gc/stop.go	0.00%	35 Missing ⚠️
pkg/views/gc/update/view.go	0.00%	32 Missing ⚠️
cmd/harbor/root/gc/log.go	0.00%	27 Missing ⚠️
cmd/harbor/root/gc/run.go	0.00%	23 Missing ⚠️
pkg/views/gc/schedule/view.go	0.00%	22 Missing ⚠️
cmd/harbor/root/gc/view_schedule.go	0.00%	21 Missing ⚠️
... and 4 more

Additional details and impacted files

@@            Coverage Diff            @@
##             main    #624      +/-   ##
=========================================
- Coverage   10.99%   7.29%   -3.71%     
=========================================
  Files         173     274     +101     
  Lines        8671   13429    +4758     
=========================================
+ Hits          953     979      +26     
- Misses       7612   12341    +4729     
- Partials      106     109       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[NucleoFusion]

Hi!
so I have already been working on this, but if you wish to do this, I can remove my PR (its been a while since I worked on it)

[intojhanurag]

Hi! so I have already been working on this, but if you wish to do this, I can remove my PR (its been a while since I worked on it)

Hey I am working with this from two days . Please give me the chance to implement this :)
Thanks !

[NucleoFusion]

No issues,
but just as a heads up, have a look at existing issues/PRs before building, its fine since it was kinda stale this time, but we wouldnt want 2 contributors to clash.

[NucleoFusion]

Also, we use charm/huh as inputs, have a look at my PR.
the update-schedule is not apparent that it requires cron flag to be set. and take that input via charm/huh.

[intojhanurag]

Also, we use charm/huh as inputs, have a look at my PR. the update-schedule is not apparent that it requires cron flag to be set. and take that input via charm/huh.

Thanks, will take a look !

[intojhanurag]

No issues, but just as a heads up, have a look at existing issues/PRs before building, its fine since it was kinda stale this time, but we wouldnt want 2 contributors to clash.

Sorry for that 🥲

[intojhanurag]

Hey @bupd , Can I get a review on this one ?

[NucleoFusion]

Do ping me after this is ready for review, from what I can see. Its still being developed

[intojhanurag]

Do ping me after this is ready for review, from what I can see. Its still being developed

Hey @NucleoFusion , I added all commands mine and as well as mentioned by you on your issue :)
Can you take a look , what i can add next ?

[qcserestipy]

Thanks for the contribution! LGTM, please only address minor changes and make sure merge conflicts are solved.

[intojhanurag]

Hey @qcserestipy , I applied all your suggestions. PTAL :)