Add Support for System-Level Robot Accounts by qcserestipy · Pull Request #507 · goharbor/harbor-cli

qcserestipy · 2025-06-29T13:48:39Z

This PR adds full support for managing system-level robot accounts in Harbor CLI, which allows automation across multiple projects with a single robot account.

Features Added:

Create system-level robot accounts with permissions spanning multiple projects
Update existing system-level robots while preserving their project permissions
Configure both system-wide and per-project permissions
Load and save robot configurations from/to files
Interactive permission selection for both system and project levels
Support for bulk project permission assignment
Commands include:

harbor-cli robot create 
harbor-cli robot update
harbor-cli robot delete
harbor-cli robot list
harbor-cli robot view
harbor-cli robot refresh

Benefits:

Simplifies automation setup for CI/CD pipelines that need access to multiple projects
Provides a more maintainable approach than creating many project-specific robots
Enables consistent permission management across Harbor instances
Reduces manual steps through configuration files and interactive prompts

This implementation follows Harbor's API design for system robot accounts and maintains consistency with the existing CLI patterns.

ToDo

There are still some steps that have to be covered:

Currently create and update have shared functionality written out. TO reduce code duplication this has to be moved to a different location.
It has to be discussed where to handle the interactive huh forms for create and update operations.

Screenshots & Videos

Screen.Recording.2025-07-21.at.14.37.46.mov

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

codecov · 2025-06-29T13:51:22Z

Codecov Report

❌ Patch coverage is 0.29070% with 1372 lines in your changes missing coverage. Please review.
✅ Project coverage is 7.39%. Comparing base (60ad0bd) to head (b0b0216).
⚠️ Report is 25 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/harbor/root/robot/update.go	0.00%	497 Missing ⚠️
cmd/harbor/root/robot/create.go	0.00%	337 Missing ⚠️
cmd/harbor/root/robot/refresh.go	0.00%	93 Missing ⚠️
pkg/views/robot/view/view.go	0.00%	80 Missing ⚠️
pkg/views/robot/select/view.go	0.00%	75 Missing ⚠️
cmd/harbor/root/robot/list.go	0.00%	65 Missing ⚠️
pkg/config/robot/robot.go	0.00%	65 Missing ⚠️
cmd/harbor/root/robot/view.go	0.00%	52 Missing ⚠️
cmd/harbor/root/robot/delete.go	0.00%	48 Missing ⚠️
pkg/views/robot/create/view.go	0.00%	17 Missing ⚠️
... and 7 more

Additional details and impacted files

@@            Coverage Diff            @@
##             main    #507      +/-   ##
=========================================
- Coverage   10.99%   7.39%   -3.60%     
=========================================
  Files         173     226      +53     
  Lines        8671   13665    +4994     
=========================================
+ Hits          953    1010      +57     
- Misses       7612   12549    +4937     
  Partials      106     106

☔ 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.

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

bupd

Overall, LGTM

@qcserestipy please resolve conflicts

…on empty Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

qcserestipy · 2025-07-21T12:49:53Z

@bupd In a few upcoming PRs I aim to do some code clean up, because I think several things can be optimized and moved to other places

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

…521) * build(deps): bump golang.org/x/text from 0.23.0 to 0.27.0 (#519) Bumps [golang.org/x/text](https://github.com/golang/text) from 0.23.0 to 0.27.0. - [Release notes](https://github.com/golang/text/releases) - [Commits](golang/text@v0.23.0...v0.27.0) --- updated-dependencies: - dependency-name: golang.org/x/text dependency-version: 0.27.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * add system `config get` command This command fetches and stores the system config in the harbor config file. Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * add system config `update` command Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Rebase on main; moved command to its own package; added reflection for api configurationsok types; Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Updated get function to sort for categories; update api handler for different categories; todo: update from config runs into swagger api errors Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * .. Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * feat(configurations): Added configurations view command, clean up get and update command, extend reflection for view functionality - In this commit the view command is added that supports setting categories aligned with the UI - Reflection is cleaned up to also handle secret values stored in the config file - Reflection is used for table view of configurations Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Add Support for System-Level Robot Accounts (#507) Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Updated github.com/go-viper/mapstructure/v2 to avoid vulnerability Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Renamed config update to config apply; added -f flag for config apply command to support specifiying configurations in a separate file than the harbor-cli global config Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * feat: Remove get command, refactor view command The get command is removed since not necessary. The view command is updated to make category selection available for piping. The apply command is adapted to not use harbor config but external config file that can be chosen via flag. Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * refactor(harbor-cli): Remove add configurations to harbor config function. This function is not longer needed since the configurations settings will be stored in another file and not in the harbor credentials config file. Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Added changes according to PR Signed-off-by: qcserestipy <patrickeschenbach96@gmail.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * docs(config): update cli docs Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * fix(mod): Patch error in go.mod missing ) Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * docs(config): update cli docs Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * fix(config): make changes to satisfy vulncheck Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * doc(config): remove messed up cli config directory Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * fix(config): remove obsolete vscode settings folder Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: qcserestipy <patrickeschenbach96@gmail.com> Signed-off-by: Patrick Eschenbach <45457307+qcserestipy@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: bupd <bupdprasanth@gmail.com>

…oharbor#521) * build(deps): bump golang.org/x/text from 0.23.0 to 0.27.0 (goharbor#519) Bumps [golang.org/x/text](https://github.com/golang/text) from 0.23.0 to 0.27.0. - [Release notes](https://github.com/golang/text/releases) - [Commits](golang/text@v0.23.0...v0.27.0) --- updated-dependencies: - dependency-name: golang.org/x/text dependency-version: 0.27.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * add system `config get` command This command fetches and stores the system config in the harbor config file. Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * add system config `update` command Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Rebase on main; moved command to its own package; added reflection for api configurationsok types; Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Updated get function to sort for categories; update api handler for different categories; todo: update from config runs into swagger api errors Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * .. Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * feat(configurations): Added configurations view command, clean up get and update command, extend reflection for view functionality - In this commit the view command is added that supports setting categories aligned with the UI - Reflection is cleaned up to also handle secret values stored in the config file - Reflection is used for table view of configurations Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Add Support for System-Level Robot Accounts (goharbor#507) Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Updated github.com/go-viper/mapstructure/v2 to avoid vulnerability Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Renamed config update to config apply; added -f flag for config apply command to support specifiying configurations in a separate file than the harbor-cli global config Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * feat: Remove get command, refactor view command The get command is removed since not necessary. The view command is updated to make category selection available for piping. The apply command is adapted to not use harbor config but external config file that can be chosen via flag. Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * refactor(harbor-cli): Remove add configurations to harbor config function. This function is not longer needed since the configurations settings will be stored in another file and not in the harbor credentials config file. Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Added changes according to PR Signed-off-by: qcserestipy <patrickeschenbach96@gmail.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * docs(config): update cli docs Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * fix(mod): Patch error in go.mod missing ) Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * docs(config): update cli docs Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * fix(config): make changes to satisfy vulncheck Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * doc(config): remove messed up cli config directory Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * fix(config): remove obsolete vscode settings folder Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: qcserestipy <patrickeschenbach96@gmail.com> Signed-off-by: Patrick Eschenbach <45457307+qcserestipy@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: bupd <bupdprasanth@gmail.com>

qcserestipy added 6 commits June 29, 2025 15:49

Added namespace and slighlty changed robot config spec

9dcf796

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

Changed format of robot permission model to prepare for system robots

0fae077

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

Made changes to satisfy linter

3d296b7

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

Added stuff for system robot

ba0cf8c

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

Added examples for system robot accounts

081e01d

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

Add shared robot utility functions and improve update command

b3ffba9

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

qcserestipy force-pushed the full-system-robots branch from 07a0d9f to b3ffba9 Compare June 29, 2025 13:49

qcserestipy mentioned this pull request Jul 9, 2025

Implement 'replication start/stop' commands #500

Closed

Merged upstream main

5928187

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

qcserestipy marked this pull request as ready for review July 9, 2025 17:58

qcserestipy changed the title ~~WIP: Add Support for System-Level Robot Accounts~~ Add Support for System-Level Robot Accounts Jul 9, 2025

bupd self-requested a review July 21, 2025 08:54

bupd approved these changes Jul 21, 2025

View reviewed changes

qcserestipy added 2 commits July 21, 2025 14:39

fix: handle empty access for system or project in case the other is n…

43e63c7

…on empty Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

Merged upstream main, re-exported docs

b0b0216

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

chethanm99 mentioned this pull request Jul 26, 2025

📌 Tracker: Missing and To-Be-Added CLI Commands #94

Open

16 tasks

bupd merged commit 3c8e623 into goharbor:main Jul 29, 2025
7 of 9 checks passed

qcserestipy added a commit to qcserestipy/harbor-cli that referenced this pull request Sep 2, 2025

Add Support for System-Level Robot Accounts (goharbor#507)

4f79294

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

qcserestipy mentioned this pull request Nov 5, 2025

557 null configs #567

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Support for System-Level Robot Accounts#507

Add Support for System-Level Robot Accounts#507
bupd merged 9 commits into
goharbor:mainfrom
qcserestipy:full-system-robots

qcserestipy commented Jun 29, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Jun 29, 2025 •

edited

Loading

Uh oh!

bupd left a comment

Uh oh!

qcserestipy commented Jul 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

qcserestipy commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Features Added:

Benefits:

ToDo

Screenshots & Videos

Uh oh!

codecov Bot commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bupd left a comment

Choose a reason for hiding this comment

Uh oh!

qcserestipy commented Jul 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

qcserestipy commented Jun 29, 2025 •

edited

Loading

codecov Bot commented Jun 29, 2025 •

edited

Loading