README
¶
ToolHive Operator CRDs Helm Chart
A Helm chart for installing the ToolHive Operator CRDs into Kubernetes.
ToolHive Operator CRDs
TL;DR
helm upgrade -i toolhive-operator-crds oci://ghcr.io/stacklok/toolhive/toolhive-operator-crds
Prerequisites
- Kubernetes 1.25+
- Helm 3.10+ minimum, 3.14+ recommended
Usage
Installing from the Chart
Install one of the available versions:
helm upgrade -i <release_name> oci://ghcr.io/stacklok/toolhive/toolhive-operator-crds --version=<version>
Tip: List all releases using
helm list
Uninstalling the Chart
To uninstall/delete the toolhive-operator-crds deployment:
helm uninstall <release_name>
Why CRDs in templates/?
Helm does not upgrade CRDs placed in the crds/ directory during helm upgrade operations. This is a known Helm limitation to prevent accidental data loss. As a result, users running helm upgrade would silently have stale CRDs.
To ensure CRDs are upgraded alongside the chart, this chart places CRDs in templates/ with Helm conditionals. This follows the pattern used by several popular projects.
However, placing CRDs in templates/ means they would be deleted when the Helm release is uninstalled, which could result in data loss. To prevent this, CRDs are annotated with helm.sh/resource-policy: keep by default (controlled by crds.keep). This ensures CRDs persist even after uninstalling the chart.
Values
| Key | Type | Default | Description |
|---|---|---|---|
| crds | object | {"install":{"registry":true,"server":true,"virtualMcp":true},"keep":true} |
CRD installation configuration |
| crds.install | object | {"registry":true,"server":true,"virtualMcp":true} |
Feature flags for CRD groups |
| crds.install.registry | bool | true |
Install Registry CRDs (mcpregistries) |
| crds.install.server | bool | true |
Install Server CRDs (mcpservers, mcpremoteproxies, mcptoolconfigs, mcpgroups) |
| crds.install.virtualMcp | bool | true |
Install VirtualMCP CRDs (virtualmcpservers, virtualmcpcompositetooldefinitions) |
| crds.keep | bool | true |
Whether to add the "helm.sh/resource-policy: keep" annotation to CRDs When true, CRDs will not be deleted when the Helm release is uninstalled |
Directories
¶
| Path | Synopsis |
|---|---|
|
crd-helm-wrapper wraps Kubernetes CRD YAML files with Helm template conditionals for feature-flagged installation and resource policy annotations.
|
crd-helm-wrapper wraps Kubernetes CRD YAML files with Helm template conditionals for feature-flagged installation and resource policy annotations. |