Add docs about Registry deployment via Operator #386
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
ChrisJBurns
reviewed
Dec 10, 2025
| ## Overview | ||
|
|
||
| The ToolHive operator deploys the Registry server in Kubernetes by creating | ||
| `MCPRegistry` resources. This is the recommended method for deploying the |
Contributor
There was a problem hiding this comment.
I'm not sure we want to say that its the recommended way. We probably should have a discussion about what we recommend. Personally, I'd recommend a helm chart installation over an Operator one. But I'd like to get others opinions on this.
|
|
||
| ## Create a registry | ||
|
|
||
| You can create `MCPRegistry` resources in namespaces based on how the operator |
Contributor
There was a problem hiding this comment.
Suggested change
| You can create `MCPRegistry` resources in namespaces based on how the operator | |
| You can create `MCPRegistry` resources in the namespaces where the ToolHive Operator is deployed |
| You can create `MCPRegistry` resources in namespaces based on how the operator | ||
| was deployed. | ||
|
|
||
| - **Cluster mode (default)**: Create MCPRegistry resources in any namespace |
Contributor
There was a problem hiding this comment.
We don't have multi-tenanted support for the registry yet - only operator installation and MCP server installation. Currently it is only scoped to the namespace it is installed in
|
|
||
| When customizing containers in `podTemplateSpec`, you must use | ||
| `name: registry-api` for the main container to ensure the operator can properly | ||
| manage the Registry server. |
Contributor
There was a problem hiding this comment.
Suggested change
| manage the Registry server. | |
| manage the Registry server. The container name is hardcoded to avoid conflict issues with user provided containers. Mandating a container name on the Operator side explicitly tells the Operator it is the main registry server container and any other containers provided by the use are sidecars/init containers. |
Contributor
Author
|
@ChrisJBurns thanks for the review, I should have addressed all your comments, PTAL. |
This change adds how to use the Operator to deploy a Registry Server instance. Specifically, documentation under `docs/toolhive/guides-registry` only mentions that you can use the Operator to deploy a Registry Server instance and links back to a page under `docs/toolhive/guides-k8s` containing all the documentation. Documentation about using Postgres password file is not there because we're working to make that transparent to the User. I left documentation using plain Kubernetes resources untouched in the `docs/toolhive/guides-registry` guide.
blkt
force-pushed
the
docs/registry-operator-docs
branch
from
431ed5d to
e95c212
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change adds how to use the Operator to deploy a Registry Server instance. Specifically, documentation under
docs/toolhive/guides-registryonly mentions that you can use the Operator to deploy a Registry Server instance and links back to a page underdocs/toolhive/guides-k8scontaining all the documentation.Documentation about using Postgres password file is not there because we're working to make that transparent to the User.
I left documentation using plain Kubernetes resources untouched in the
docs/toolhive/guides-registryguide.Type of change
Related issues/PRs
Submitter checklist
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed filesvercel.jsonfor moved, renamed, or deleted pages (i.e., if the URL slug changed)Reviewer checklist
Content