Skip to content

Commit c3eaaaa

Browse files
ChrisJBurnsclaude
authored andcommitted
Fix CRD field and version issues in K8s guides (#722)
- remote-mcp-proxy: Fix tokenURL/clientID casing to tokenUrl/clientId - remote-mcp-proxy: Fix groupRef from string to object format - deploy-operator: Update kubectl CRD lists from v0.12.1 to v0.20.0 - deploy-operator: Add missing CRDs (mcpoidcconfigs, mcpserverentries, mcptelemetryconfigs) - run-mcp-k8s: Update health check to show JSON response format Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent c44e07e commit c3eaaaa

3 files changed

Lines changed: 40 additions & 30 deletions

File tree

docs/toolhive/guides-k8s/deploy-operator.mdx

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -99,18 +99,21 @@ To install the CRDs using `kubectl`, run the following, ensuring you only apply
9999
the CRDs you need for the features you plan to use:
100100

101101
```bash
102-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_embeddingservers.yaml
103-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpexternalauthconfigs.yaml
104-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcptoolconfigs.yaml
105-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpremoteproxies.yaml
106-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpservers.yaml
107-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpgroups.yaml
108-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpregistries.yaml
109-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_virtualmcpcompositetooldefinitions.yaml
110-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_virtualmcpservers.yaml
111-
```
112-
113-
Replace `v0.12.1` in the commands above with your target CRD version.
102+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_embeddingservers.yaml
103+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpexternalauthconfigs.yaml
104+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpgroups.yaml
105+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpoidcconfigs.yaml
106+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpregistries.yaml
107+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpremoteproxies.yaml
108+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpserverentries.yaml
109+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpservers.yaml
110+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcptelemetryconfigs.yaml
111+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcptoolconfigs.yaml
112+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_virtualmcpcompositetooldefinitions.yaml
113+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_virtualmcpservers.yaml
114+
```
115+
116+
Replace `v0.20.0` in the commands above with your target CRD version.
114117

115118
</TabItem>
116119
</Tabs>
@@ -334,21 +337,24 @@ To upgrade the CRDs using `kubectl`, run the following, ensuring you only apply
334337
the CRDs you need for the features you want:
335338

336339
```bash
337-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_embeddingservers.yaml
338-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpexternalauthconfigs.yaml
339-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcptoolconfigs.yaml
340-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpremoteproxies.yaml
341-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpservers.yaml
342-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpgroups.yaml
343-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpregistries.yaml
344-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_virtualmcpcompositetooldefinitions.yaml
345-
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.12.1/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_virtualmcpservers.yaml
340+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_embeddingservers.yaml
341+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpexternalauthconfigs.yaml
342+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpgroups.yaml
343+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpoidcconfigs.yaml
344+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpregistries.yaml
345+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpremoteproxies.yaml
346+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpserverentries.yaml
347+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcpservers.yaml
348+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcptelemetryconfigs.yaml
349+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_mcptoolconfigs.yaml
350+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_virtualmcpcompositetooldefinitions.yaml
351+
kubectl apply -f https://raw.githubusercontent.com/stacklok/toolhive/refs/tags/v0.20.0/deploy/charts/operator-crds/crds/toolhive.stacklok.dev_virtualmcpservers.yaml
346352
```
347353

348354
</TabItem>
349355
</Tabs>
350356

351-
Replace `v0.12.1` in the commands above with your target CRD version.
357+
Replace `v0.20.0` in the commands above with your target CRD version.
352358

353359
### Upgrade the operator Helm release
354360

@@ -419,11 +425,14 @@ To remove the CRDs using `kubectl`, run the following:
419425
```bash
420426
kubectl delete crd embeddingservers.toolhive.stacklok.dev
421427
kubectl delete crd mcpexternalauthconfigs.toolhive.stacklok.dev
422-
kubectl delete crd mcptoolconfigs.toolhive.stacklok.dev
423-
kubectl delete crd mcpremoteproxies.toolhive.stacklok.dev
424-
kubectl delete crd mcpservers.toolhive.stacklok.dev
425428
kubectl delete crd mcpgroups.toolhive.stacklok.dev
429+
kubectl delete crd mcpoidcconfigs.toolhive.stacklok.dev
426430
kubectl delete crd mcpregistries.toolhive.stacklok.dev
431+
kubectl delete crd mcpremoteproxies.toolhive.stacklok.dev
432+
kubectl delete crd mcpserverentries.toolhive.stacklok.dev
433+
kubectl delete crd mcpservers.toolhive.stacklok.dev
434+
kubectl delete crd mcptelemetryconfigs.toolhive.stacklok.dev
435+
kubectl delete crd mcptoolconfigs.toolhive.stacklok.dev
427436
kubectl delete crd virtualmcpcompositetooldefinitions.toolhive.stacklok.dev
428437
kubectl delete crd virtualmcpservers.toolhive.stacklok.dev
429438
```

docs/toolhive/guides-k8s/remote-mcp-proxy.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -394,8 +394,8 @@ metadata:
394394
spec:
395395
type: tokenExchange
396396
tokenExchange:
397-
tokenURL: https://auth.company.com/protocol/openid-connect/token
398-
clientID: token-exchange-client
397+
tokenUrl: https://auth.company.com/protocol/openid-connect/token
398+
clientId: token-exchange-client
399399
clientSecretRef:
400400
name: token-exchange-creds
401401
key: client-secret
@@ -783,7 +783,8 @@ metadata:
783783
name: context7-proxy
784784
namespace: toolhive-system
785785
spec:
786-
groupRef: my-group # Reference to an MCPGroup
786+
groupRef:
787+
name: my-group # Reference to an MCPGroup
787788
remoteUrl: https://mcp.context7.com/mcp
788789
transport: streamable-http
789790
proxyPort: 8080

docs/toolhive/guides-k8s/run-mcp-k8s.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -760,8 +760,8 @@ To test connectivity between components:
760760
# Port-forward to test direct access to the proxy
761761
kubectl -n <NAMESPACE> port-forward service/<MCPSERVER_NAME> 8080:8080
762762
763-
# Test the connection locally
764-
curl http://localhost:8080/health
763+
# Test the connection locally (should return {"status":"healthy",...})
764+
curl -s http://localhost:8080/health | jq .status
765765
766766
# Check service endpoints
767767
kubectl -n <NAMESPACE> get endpoints

0 commit comments

Comments
 (0)