Skip to content

Add MCPRegistry to Helm migration guide#927

Open
ChrisJBurns wants to merge 1 commit into
mainfrom
add-mcpregistry-migration-guide
Open

Add MCPRegistry to Helm migration guide#927
ChrisJBurns wants to merge 1 commit into
mainfrom
add-mcpregistry-migration-guide

Conversation

@ChrisJBurns

Copy link
Copy Markdown
Contributor

Description

Follow-up to #926. Adds a dedicated guide for migrating an operator-managed MCPRegistry deployment to the standalone toolhive-registry-server Helm chart, and wires it into the existing deprecation notices.

Changes:

  • New page guides-registry/migrate-to-helm.mdx: a parallel-cutover how-to guide (capture config → map configYAML to the chart's config block → deploy the release → verify → repoint clients → remove the MCPRegistry). Includes a field-mapping table and reuses the existing PostgreSQL database, so no data migration is required.
  • Sidebar: reordered the "Deploy the Registry Server" children to lead with Helm (recommended), followed by manual, the deprecated operator method, and the new migration guide.
  • Deprecation notices: linked the migration guide from the warnings in deployment.mdx and deploy-operator.mdx.
  • Helm page: reapplied the deprecation note in the intro callout (recommending Helm, flagging the operator method as deprecated, linking the migration guide). This edit was part of Add MCPRegistry CRD deprecation notices #926's branch but did not land in the squash merge, so it's reintroduced here.

Type of change

  • New documentation

Related issues/PRs

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Navigation

  • New pages include a frontmatter section with title and description at a minimum
  • Sidebar navigation (sidebars.ts) updated for added, deleted, reordered, or renamed files
  • Redirects added to vercel.json for moved, renamed, or deleted pages (n/a - no URLs changed)

🤖 Generated with Claude Code

Add a migration guide for moving operator-managed MCPRegistry
deployments to the toolhive-registry-server Helm chart, and link it
from the existing deprecation notices. Also reorder the deployment
sidebar to lead with Helm and reapply the Helm-page deprecation note
that did not land in #926.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 9, 2026 22:06
@vercel

vercel Bot commented Jun 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Jun 9, 2026 10:07pm

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a dedicated how-to guide for migrating an operator-managed MCPRegistry deployment to the standalone toolhive-registry-server Helm chart, and links it from existing deprecation callouts so readers have an actionable migration path.

Changes:

  • Added a new migration page that walks through a parallel cutover from MCPRegistry to Helm.
  • Updated registry docs to link to the migration guide from deprecation warnings and the Helm page intro callout.
  • Reordered the registry deployment sidebar items to lead with Helm (recommended) and include the migration guide.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
sidebars.ts Reorders Registry Server deployment docs and adds the new migration page to navigation.
docs/toolhive/guides-registry/migrate-to-helm.mdx New migration how-to guide from operator-managed MCPRegistry to Helm.
docs/toolhive/guides-registry/deployment.mdx Links the migration guide from the top-level CRD deprecation warning.
docs/toolhive/guides-registry/deploy-operator.mdx Links the migration guide from the operator deployment deprecation notice.
docs/toolhive/guides-registry/deploy-helm.mdx Reintroduces the operator deprecation + migration link in the Helm page intro callout.

Comment on lines +149 to +150
kubectl -n <NAMESPACE> port-forward svc/registry-server 8080:80
curl http://localhost:8080/v0/servers
Comment on lines +153 to +155
The Helm release creates a service named after the release (for example,
`registry-server`), which differs from the service the operator created for your
`MCPRegistry`. Note the new service name and endpoint for the next step.
| --------------------------------- | ------------------------------------------- |
| `spec.configYAML` | `config` (as structured YAML, not a string) |
| `spec.pgpassSecretRef` | pgpass Secret + init container (see below) |
| `spec.podTemplateSpec.…resources` | `resources` |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants