adds operator crds helm/kubectl installation guide #435
Conversation
Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR enhances the CRD installation and management documentation by adding kubectl installation methods as an alternative to Helm. The documentation now provides users with two installation paths: Helm (recommended) for full lifecycle management, and kubectl for simpler, static manifest-based installations suitable for GitOps workflows.
Changes:
- Added tabbed interface (Helm/kubectl) for CRD installation, upgrade, and uninstall sections
- Documented Helm chart configuration options for selective CRD installation (
crds.install.server,crds.install.registry,crds.install.virtualMcp,crds.keep) - Added kubectl commands for installing, upgrading, and removing individual CRDs via GitHub raw URLs
|
@ChrisJBurns I've opened a new pull request, #436, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Initial plan * Add complete helm command for setting crds.keep=false Co-authored-by: ChrisJBurns <29541485+ChrisJBurns@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ChrisJBurns <29541485+ChrisJBurns@users.noreply.github.com>
| - **kubectl**: Uses static manifests for a simple installation. Useful for | ||
| environments where Helm isn't available or for GitOps workflows. | ||
|
|
||
| <Tabs> |
There was a problem hiding this comment.
Adding this to all the Tabs tags will make them change together, and also add it to the URL string so you can directly link to one or the other:
| <Tabs> | |
| <Tabs groupId="method" queryString="method"> |
| - **kubectl**: Uses static manifests for a simple installation. Useful for | ||
| environments where Helm isn't available or for GitOps workflows. | ||
|
|
||
| <Tabs> |
There was a problem hiding this comment.
| <Tabs> | |
| <Tabs groupId="method" queryString="method"> |
|
|
||
| ::: | ||
|
|
||
| <Tabs> |
There was a problem hiding this comment.
| <Tabs> | |
| <Tabs groupId="method" queryString="method"> |
There was a problem hiding this comment.
Looks like you have an old version of npm locally, mind removing the package-lock.json changes from the branch?
| Helm is the officially supported method to install the ToolHive operator in a | ||
| Kubernetes cluster. |
There was a problem hiding this comment.
Should this be updated too?
| --- | ||
| title: Deploy the operator | ||
| description: | ||
| How to deploy the ToolHive operator in a Kubernetes cluster using Helm |
There was a problem hiding this comment.
| How to deploy the ToolHive operator in a Kubernetes cluster using Helm or | |
| kubectl |
Description
We have added some additional toggles for CRDs Helm Chart. This PR adds documentation for those extra toggles.
Type of change
Screenshots
Submitter checklist
Content and formatting
Reviewer checklist
Content