Add platform-wide Redis defaults callouts to operator guides#980
Add platform-wide Redis defaults callouts to operator guides#980claude[bot] wants to merge 1 commit into
Conversation
Point full-platform users from the Kubernetes operator deploy and Redis session storage guides to the umbrella-level global.redis defaults on the Stacklok Enterprise platform deployment page. Companion to the registry server global.postgres callout in PR #979.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Automated editorial review (
|
| Observation | Note |
|---|---|
| Slight wording divergence between the two callouts | The deploy-operator.mdx callout adds "A local operator.defaultRedis still wins when set." while the redis-session-storage.mdx callout omits the precedence sentence and instead qualifies with "that have no explicit spec.sessionStorage." Both are individually accurate and each fits its local context (the operator page is already discussing operator.defaultRedis; the session-storage page is discussing per-CR spec.sessionStorage). This is a reasonable context-sensitive difference, not an inconsistency to "fix" - flagged only so a reviewer can confirm the intent is deliberate. |
| "set this once at the umbrella level instead" | "instead" reads naturally in context (instead of the per-component OSS approach just described). Clear; no change needed. |
What works well
- Both callouts are OSS-neutral: they describe where to set a default for full-platform users without removing or weakening the existing OSS instructions, so the underlying feature docs remain accurate and complete for OSS readers.
- Single source of truth is respected - the callouts link to the canonical
global.redisdocumentation rather than duplicating the YAML block. - Conservative scope (the PR description's "skipped" rationale is sound: embedded auth token storage is correctly excluded since it does not inherit
global.redis).
Recommendation: No merge-blocking changes. The two secondary observations are for reviewer awareness only.
Requested by Daniel Barr · Slack thread
Before / After
Before: the Kubernetes operator deployment guides explain how to configure Redis for horizontal scaling session storage at the OSS level (per-CR
spec.sessionStorageand the operator-wideoperator.defaultRedis), but they don't point full-platform users to the umbrella-level platform-wide defaults. Someone running the full Stacklok Enterprise platform has no signal that they can set this once at the umbrella level instead of per component.After: each relevant operator guide carries a short enterprise-context callout that tells full-platform users to set this once at the umbrella level via
global.redis, and links to the platform-wide Redis/Valkey defaults on the platform deployment page. The underlying OSS feature descriptions are unchanged and remain accurate.How
This mirrors the
:::enterpriseadmonition idiom (perCLAUDE.md): a brief, OSS-neutral callout that routes full-platform users to the canonical supported path without implying the feature is Enterprise-gated. No<EnterpriseBadge />is added to any feature heading. Each callout cross-links to the existing#global-redisvalkey-defaultssection ondocs/platform/enterprise-platform/deployment.mdx(anchor verified with github-slugger).Files touched and which
global.*each covers:docs/toolhive/guides-k8s/deploy-operator.mdx(global.redis) - callout at the end of the "Set a cluster-wide default Redis" section, the OSS analog of the umbrella default thatglobal.redisoverrides.docs/toolhive/guides-k8s/redis-session-storage.mdx(global.redis) - callout in the "Horizontal scaling session storage" section, alongside the existing cluster-wide-default tip.This is the companion to PR #979's pattern: #979 establishes the
global.postgrescallout on the registry server'sdeploy-helm.mdxand adds the "Global PostgreSQL defaults" section to the platform deployment page; this PR extends the same idiom to theglobal.redisdefaults that the operator subchart honors.Scope / skipped
Deliberately left out, because the
global.*fallback does not genuinely apply or is handled elsewhere:docs/toolhive/guides-registry/deploy-helm.mdx- theglobal.postgrescallout is being handled in PR Update stacklok/toolhive-registry-server to v1.4.11 #979; not duplicated here.docs/toolhive/guides-registry/deploy-operator.mdx- uses the deprecatedMCPRegistryCRD. Theglobal.postgresfallback is a feature of the registry-server Helm subchart, not the CRD, so the CRD-based path does not honor it.docs/toolhive/guides-registry/database.mdx,deploy-manual.mdx- standalone/manual registry deployments, not umbrella-subchart context.redis-session-storage.mdxandauth-k8s.mdx) - the platform deployment page states embedded auth token storage is configured separately viaMCPExternalAuthConfigand does not inheritglobal.redis, so no callout there.rate-limiting.mdxand the vMCP scaling page - neither references the operator-level/umbrella default; the two operator deploy pages above are the canonical, conservative spots (one callout per page).For Daniel's judgment:
global.postgresgenuinely applies to only the registry server, which PR #979 already covers, so there was no additional postgres page to add here.global.redisis the only platform-wide default with extra OSS guide surface, and the two pages above are the accurate targets.🤖 Generated with Claude Code
https://claude.ai/code/session_014pdgd5wypAXDCqR4zFk7Gj
Generated by Claude Code