Add Redis Sentinel storage documentation for auth server#3824
Add Redis Sentinel storage documentation for auth server#3824tgrunnagle merged 3 commits intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3824 +/- ##
==========================================
- Coverage 68.03% 67.92% -0.11%
==========================================
Files 438 438
Lines 44000 44033 +33
==========================================
- Hits 29936 29911 -25
- Misses 11722 11779 +57
- Partials 2342 2343 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jhrozek
left a comment
There was a problem hiding this comment.
Documentation review — 4 inline suggestions below. Overall the docs are thorough, accurate, and well cross-referenced. All code file paths, CRD field names, interface names, key patterns, and TTL values were verified against the implementation. Nice work.
Add comprehensive documentation for configuring Redis Sentinel as the storage backend for the embedded authorization server, enabling horizontal scaling across multiple auth server replicas. New files: - docs/redis-storage.md: User-facing configuration guide with CRD examples, Spotahome Redis Operator deployment steps, data model reference, troubleshooting, and configuration reference tables - docs/arch/11-auth-server-storage.md: Architecture documentation covering storage interface design, memory and Redis backends, multi-tenancy via key prefixes, and atomic Lua script operations - examples/operator/redis-storage/: Example manifests for Redis Failover, Sentinel Service, credentials Secret, and MCPExternalAuthConfig with Redis storage Updated architecture docs (README, overview, operator) to reference the new storage documentation. Closes #3790
29846a9 to
cedda09
Compare
There was a problem hiding this comment.
Large PR Detected
This PR exceeds 1000 lines of changes and requires justification before it can be reviewed.
How to unblock this PR:
Add a section to your PR description with the following format:
## Large PR Justification
[Explain why this PR must be large, such as:]
- Generated code that cannot be split
- Large refactoring that must be atomic
- Multiple related changes that would break if separated
- Migration or data transformationAlternative:
Consider splitting this PR into smaller, focused changes (< 1000 lines each) for easier review and reduced risk.
See our Contributing Guidelines for more details.
This review will be automatically dismissed once you add the justification section.
Added large PR justification and request re-review not working.
Closes #3790
Summary
Adds comprehensive documentation for configuring Redis Sentinel as the storage backend for the embedded authorization server. This completes Phase 3 (Documentation) of the Redis storage implementation plan, covering a user-facing configuration guide, architecture documentation, and example Kubernetes manifests.
Changes Made
User-Facing Guide (
docs/redis-storage.md)Architecture Documentation (
docs/arch/11-auth-server-storage.md)Example Manifests (
examples/operator/redis-storage/)redis-failover.yaml— Spotahome RedisFailover CRD with ACL file support and provisioning guidancesentinel-service.yaml— Manual Sentinel Service + StatefulSet with init container for writable configredis-credentials.yaml— Kubernetes Secret template for Redis ACL credentialsmcpexternalauthconfig-redis-storage.yaml— Complete MCPExternalAuthConfig with Redis storage and Sentinel Service discoveryExisting Architecture Docs
docs/arch/README.mdwith new entry (refactor: Separate interfaces from implementation for container runtime #12), architecture map node, and Last Updated datedocs/arch/00-overview.mdRelated Documentation sectiondocs/arch/09-operator-architecture.mdMCPExternalAuthConfig section with Redis storage referenceAdditional Notes
mcpexternalauthconfig_types.goLarge PR Justification