Skip to content

Fix remaining CRD field issues across K8s and vMCP docs#723

Merged
ChrisJBurns merged 3 commits intomainfrom
fix-remaining-crd-issues
Apr 15, 2026
Merged

Fix remaining CRD field issues across K8s and vMCP docs#723
ChrisJBurns merged 3 commits intomainfrom
fix-remaining-crd-issues

Conversation

@ChrisJBurns
Copy link
Copy Markdown
Contributor

Summary

Fixes the 10 remaining CRD validation failures found during full dry-run
testing of all 26 K8s Operator and vMCP docs (108 YAML blocks total).

These are issues that were not covered by PRs #715, #720, or #722.

Fixes:

  • mcp-server-entry.mdx: remoteURL -> remoteUrl on MCPServerEntry
    resources (5 occurrences)
  • configuration.mdx: remoteURL -> remoteUrl on MCPRemoteProxy and
    MCPServerEntry resources (2 occurrences)
  • backend-discovery.mdx: incomingAuth.oidc -> oidcConfigRef on
    VirtualMCPServer (unknown field oidc)
  • failure-handling.mdx: incomingAuth.oidc -> oidcConfigRef on
    VirtualMCPServer (unknown field oidc)
  • optimizer.mdx: modelCache.storageSize -> modelCache.size on
    EmbeddingServer (unknown field storageSize)

Not addressed (CRD bug, not doc issue):

One additional failure in vmcp/telemetry-and-metrics.mdx is caused by a CEL
validation rule on the VirtualMCPServer CRD that checks
self.config.telemetry even when config is not present on the resource.
The doc correctly uses telemetryConfigRef without config.telemetry, but
the CEL rule !(has(self.config.telemetry) && has(self.telemetryConfigRef))
errors because self.config doesn't exist. This should be fixed in the CRD,
not the docs.

Test plan

🤖 Generated with Claude Code

- mcp-server-entry: Fix remoteURL -> remoteUrl (5 occurrences)
- configuration: Fix remoteURL -> remoteUrl (2 occurrences)
- backend-discovery: Fix incomingAuth.oidc -> oidcConfigRef
- failure-handling: Fix incomingAuth.oidc -> oidcConfigRef
- optimizer: Fix modelCache.storageSize -> modelCache.size

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 15, 2026 19:12
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 15, 2026

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

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Apr 15, 2026 7:56pm

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates ToolHive K8s Operator and vMCP documentation YAML examples to match current CRD field names, resolving remaining validation failures discovered via dry-run testing.

Changes:

  • Replace remoteURL with remoteUrl in MCPRemoteProxy and MCPServerEntry examples.
  • Replace incomingAuth.oidc with incomingAuth.oidcConfigRef in VirtualMCPServer examples.
  • Replace modelCache.storageSize with modelCache.size in the EmbeddingServer example.

Reviewed changes

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

Show a summary per file
File Description
docs/toolhive/guides-vmcp/optimizer.mdx Updates EmbeddingServer model cache field name to the current CRD schema.
docs/toolhive/guides-vmcp/failure-handling.mdx Updates VirtualMCPServer incoming OIDC auth example to use oidcConfigRef.
docs/toolhive/guides-vmcp/configuration.mdx Fixes remoteUrl casing in MCPRemoteProxy and MCPServerEntry examples.
docs/toolhive/guides-vmcp/backend-discovery.mdx Updates discovered-mode VirtualMCPServer auth example to use oidcConfigRef.
docs/toolhive/guides-k8s/mcp-server-entry.mdx Fixes remoteUrl casing across MCPServerEntry examples.

Comment thread docs/toolhive/guides-vmcp/backend-discovery.mdx
Comment thread docs/toolhive/guides-k8s/mcp-server-entry.mdx
Update remoteURL references in prose text to match the remoteUrl
YAML fixes, and replace deprecated inline oidcConfig with
oidcConfigRef in the optimizer complete example.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The complete example referenced engineering-oidc via oidcConfigRef
but never defined the MCPOIDCConfig resource, making the example
incomplete for copy-paste usage.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ChrisJBurns ChrisJBurns merged commit 2d1a73a into main Apr 15, 2026
8 checks passed
@ChrisJBurns ChrisJBurns deleted the fix-remaining-crd-issues branch April 15, 2026 20:34
yrobla pushed a commit that referenced this pull request Apr 16, 2026
* Fix remaining CRD field issues across K8s and vMCP docs

- mcp-server-entry: Fix remoteURL -> remoteUrl (5 occurrences)
- configuration: Fix remoteURL -> remoteUrl (2 occurrences)
- backend-discovery: Fix incomingAuth.oidc -> oidcConfigRef
- failure-handling: Fix incomingAuth.oidc -> oidcConfigRef
- optimizer: Fix modelCache.storageSize -> modelCache.size

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Fix stale field names in prose and deprecated oidcConfig usage

Update remoteURL references in prose text to match the remoteUrl
YAML fixes, and replace deprecated inline oidcConfig with
oidcConfigRef in the optimizer complete example.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Add missing MCPOIDCConfig to backend discovery complete example

The complete example referenced engineering-oidc via oidcConfigRef
but never defined the MCPOIDCConfig resource, making the example
incomplete for copy-paste usage.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.

3 participants