Document private Git repository authentication for Registry Server#513
Document private Git repository authentication for Registry Server#513ChrisJBurns wants to merge 7 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Adds documentation describing how to configure authentication when using private Git repositories as a ToolHive Registry Server registry source.
Changes:
- Documents the
git.authconfiguration block for private repos, includingauth.usernameandauth.passwordFile. - Adds a Kubernetes example demonstrating mounting a Secret and referencing the mounted token file.
Add documentation for configuring authentication when using private Git repositories as a registry source. Includes configuration options for username and passwordFile, along with a Kubernetes deployment example showing how to mount secrets. Closes stacklok/toolhive-registry-server#439 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
880b4bc to
9f17fb9
Compare
| name: git-credentials | ||
| type: Opaque | ||
| stringData: | ||
| token: ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
There was a problem hiding this comment.
| token: ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| token: <YOUR_GITHUB_TOKEN> |
| - key: token | ||
| path: token | ||
| - name: data | ||
| emptyDir: {} |
There was a problem hiding this comment.
Above we recommend a persistent directory, then the example uses emptyDir; maybe add a quick comment here about using a PersistentVolumeClaim in production?
There was a problem hiding this comment.
The empty dir is only for a clone which the registry ends up putting into a DB. The PVC in prod may be an overkill as the data is cloned on start up anyways
There was a problem hiding this comment.
Should we just nuke the note about it then? Since even the emptyDir was removed from the Helm chart as you found, and based on my environment it seems not necessary at all, I agree it seems overkill.
There was a problem hiding this comment.
Any further clarity around this? From my own environment (using Helm deployment), it really seems it's not needed - so can we confirm, and remove the note above and the emptyDir config so as not to confuse users?
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
@danbarr Coming back to this. I push up some changes not sure if you had a chance to look during the offsite up to now |
@ChrisJBurns I think this one (being more targeted/technical) falls in a "peer review" category that someone on the registry team can validate better than I. I did reply to the thread above to see if the question of the /data path had been clarified? |
Summary
auth.usernameandauth.passwordFileconfiguration optionsCloses stacklok/toolhive-registry-server#439
Test plan
npm run build)stacklok/toolhive-registry-server#439
🤖 Generated with Claude Code