Document MCPServer operations and overrides#947
Open
danbarr wants to merge 2 commits into
Open
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the Kubernetes operator guide for MCPServer with practical operational and configuration workflows that are currently under-documented, helping readers manage RBAC, customize proxy resources, perform safe restarts, and troubleshoot using status conditions.
Changes:
- Document using a pre-existing ServiceAccount via
spec.serviceAccount(instead of operator-managed RBAC). - Document
spec.resourceOverridesfor proxy Deployment/Service customization (metadata, env vars, image pull secrets). - Add operational guidance for restart annotations,
groupRefaggregation with MCPGroup, and a status conditions reference table.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds operational and configuration coverage for MCPServer to the Kubernetes operator guide (
run-mcp-k8s.mdx):spec.serviceAccount) instead of operator-managed RBAC, for locked-down clusters and cloud IAM (IRSA / Workload Identity).spec.resourceOverrides): labels, annotations, proxy env vars, and image pull secrets for private registries.mcpserver.toolhive.stacklok.dev/restarted-atannotation, with therolling(default) andimmediatestrategies.spec.groupRef), linking to the existing MCPGroup creation steps.Field names and the status conditions were verified against the MCPServer CRD schema (
static/api-specs/crds/mcpservers.schema.json) and the operator source (mcpserver_types.go, restart annotation docs). The conditions table reflects current source: it includesReadyplus the active*Validated/*Validconditions and excludes the removedImageValidated.Type of change
Related issues/PRs
Addresses gaps in #655.
Submitter checklist
Content and formatting
Reviewer checklist
Content