Skip to content

Added docs for config and encryption here from website#487

Merged
bupd merged 3 commits into
goharbor:mainfrom
qcserestipy:docs-test
Jun 5, 2025
Merged

Added docs for config and encryption here from website#487
bupd merged 3 commits into
goharbor:mainfrom
qcserestipy:docs-test

Conversation

@qcserestipy

@qcserestipy qcserestipy commented Jun 4, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Closes #390

Add documentation for Harbor CLI configuration and encryption management

When rendered on the website they look like this:

Screen.Recording.2025-06-04.at.21.55.29.mov
Screen.Recording.2025-06-04.at.21.55.02.mov

Purpose

This PR introduces comprehensive documentation for two critical aspects of Harbor CLI:

  1. Configuration management hierarchy and credential handling
  2. Encryption mechanisms and environment-specific security recommendations

Changes

Configuration Management Documentation

  • Added detailed explanation of configuration hierarchy (--config flag > env var > XDG paths)
  • Documented multi-credential management workflow with practical examples
  • Clarified data storage paths and precedence rules
  • Included scenario-based usage patterns (temporary overrides, environment persistence, reset)

Encryption Management Documentation

  • Added overview of AES-GCM encryption implementation
  • Documented three-tier keyring backend system:
    • Environment-based keys
    • System keyring integration
    • File-based fallback
  • Provided environment-specific guidance with Kubernetes/Docker examples
  • Highlighted security recommendations for different deployment scenarios

@qcserestipy
Added docs for config and encryption here from website
e2f4132 
Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
@codecov

codecov Bot commented Jun 4, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 10.99%. Comparing base (60ad0bd) to head (8b944fa).
Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #487   +/-   ##
=======================================
  Coverage   10.99%   10.99%           
=======================================
  Files         173      173           
  Lines        8671     8671           
=======================================
  Hits          953      953           
  Misses       7612     7612           
  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.

@bupd

bupd commented Jun 5, 2025

Copy link
Copy Markdown
Member

@qcserestipy make sure this don't overwritten by dagger doc generation.

bupd
bupd approved these changes Jun 5, 2025
View reviewed changes

@bupd bupd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm. Also added a suggestion.

Vad1mo
Vad1mo approved these changes Jun 5, 2025
View reviewed changes

@Vad1mo Vad1mo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good, good intro and stepped approach from high level to low level.

on the first glace, what I was missing( or didn't notice) is a guide/example on how to deal with secrets in container or CI/CD setups... I think this needs a special highlight as that is a very common case.

@qcserestipy

qcserestipy commented Jun 5, 2025

Copy link
Copy Markdown
Collaborator Author

Thanks a lot for the kind words!

@Vad1mo I do have a short section on handling secrets, but the fact you didn’t spot it means it’s too hidden. I’ll pull it forward, add a more clear example.

Really appreciate you pointing this out—and the rest of your feedback!

@qcserestipy
Added more clear info to encryption docs about ci/cd and production e…
dbb755d 
…nvironments

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

qcserestipy commented Jun 5, 2025

Copy link
Copy Markdown
Collaborator Author

@bupd I tested, it seems like not to be overwritten by dagger. You mentioned that you made a suggestion, I could not see it in the PR. Is there an open suggestion still?

@qcserestipy
This index for the harborcli docs also has to live here
8b944fa 
Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
@qcserestipy qcserestipy mentioned this pull request Jun 5, 2025
Merged
@bupd

bupd commented Jun 5, 2025

Copy link
Copy Markdown
Member

@bupd I tested, it seems like not to be overwritten by dagger. You mentioned that you made a suggestion, I could not see it in the PR. Is there an open suggestion still?

Everything looks good.

@bupd bupd merged commit ba76710 into goharbor:main Jun 5, 2025
9 checks passed
PrathamX595 pushed a commit to PrathamX595/harbor-cli that referenced this pull request Jun 10, 2025
@qcserestipy @PrathamX595
Added docs for config and encryption here from website (goharbor#487)
4c36383 
* Added docs for config and encryption here from website

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

* Added more clear info to encryption docs about ci/cd and production environments

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

* This index for the harborcli docs also has to live here

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

---------

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
@qcserestipy qcserestipy mentioned this pull request Nov 5, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Vad1mo Vad1mo Vad1mo approved these changes

@bupd bupd bupd approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update Docs explaining keyring usage

3 participants

@qcserestipy @bupd @Vad1mo