docs(cerebro): add deployment runbook#757
Conversation
Deploying corvus with
|
| Latest commit: |
8c86f2c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7de383c2.corvus-42x.pages.dev |
| Branch Preview URL: | https://docs-cerebro-deployment-runb.corvus-42x.pages.dev |
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a comprehensive Cerebro Deployment Runbook documenting production posture (single-node, local-first), required secrets, configuration, probe setup, deployment checklist, token rotation, readiness troubleshooting, storage recovery, and incident response. Includes English and Spanish versions with sidebar navigation integration and README link. ChangesCerebro Operational Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 47 minutes and 11 seconds.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@clients/web/apps/docs/src/content/docs/es/cerebro/deployment-runbook.md`:
- Around line 135-153: The Spanish runbook is missing three EN→ES parity
sections: insert a translated "Rollback triggers" subsection immediately after
the "During the rollout" numbered steps (mirroring the EN list of five abort
conditions), add the translated "Expected post-rotation symptoms" subsection
into the token rotation section where the EN symptoms appear, and add the
missing incident-response table row "Storage errors spike by operation" into the
ES incident response table so it matches the EN six-row table; locate these by
the heading names "Rollback triggers", "Expected post-rotation symptoms", and
the incident-response table and copy the exact EN content translated into
Spanish, preserving order and formatting consistent with surrounding sections.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 3c811dbe-82f8-4941-8727-3ba85210d189
📒 Files selected for processing (4)
clients/cerebro/README.mdclients/web/apps/docs/astro.config.mjsclients/web/apps/docs/src/content/docs/cerebro/deployment-runbook.mdclients/web/apps/docs/src/content/docs/es/cerebro/deployment-runbook.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: submit-gradle
- GitHub Check: pr-checks
- GitHub Check: sonar
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Cloudflare Pages
🧰 Additional context used
📓 Path-based instructions (2)
**/*
⚙️ CodeRabbit configuration file
**/*: Security first, performance second.
Validate input boundaries, auth/authz implications, and secret management.
Look for behavioral regressions, missing tests, and contract breaks across modules.
Files:
clients/web/apps/docs/astro.config.mjsclients/cerebro/README.mdclients/web/apps/docs/src/content/docs/es/cerebro/deployment-runbook.mdclients/web/apps/docs/src/content/docs/cerebro/deployment-runbook.md
**/*.{md,mdx}
⚙️ CodeRabbit configuration file
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes.
For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.
Files:
clients/cerebro/README.mdclients/web/apps/docs/src/content/docs/es/cerebro/deployment-runbook.mdclients/web/apps/docs/src/content/docs/cerebro/deployment-runbook.md
🪛 LanguageTool
clients/web/apps/docs/src/content/docs/es/cerebro/deployment-runbook.md
[style] ~32-~32: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...uestador y la red de monitoreo; - expón POST /mcp solo detrás de ingress, gateway, ...
(POST)
[style] ~102-~102: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...o** escucha en la red privada y protege POST /mcp con bearer auth, límites de tamañ...
(POST)
[style] ~116-~116: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...públicamente. | | Smoke de aplicación | POST /mcp autenticado con mem_stats o `me...
(POST)
🔇 Additional comments (2)
clients/cerebro/README.md (1)
42-43: LGTM. Relative path is correct and consistent with existing links in this file.clients/web/apps/docs/astro.config.mjs (1)
304-310: LGTM. Sidebar entry slug, EN label, and ES translation are all consistent with the new doc files and the existing sidebar pattern.
|
1 participant
Related Issues
Fixes #698
Summary
Adds a dedicated Cerebro operational deployment runbook for production operators, covering required secrets, production configuration, deployment topology, probes, rollout checks, token rotation, readiness troubleshooting, storage recovery, incident response, and alerting guidance.
Also links the runbook from the primary Cerebro README and adds it to the docs sidebar with an ES locale counterpart so docs metadata validation passes.
Tested Information
pnpm --filter @corvus/docs run validate:contentDocumentation Impact
clients/web/apps/docs/src/content/docs/cerebro/deployment-runbook.mdclients/web/apps/docs/src/content/docs/es/cerebro/deployment-runbook.mdclients/cerebro/README.mdclients/web/apps/docs/astro.config.mjsBreaking Changes
None.
Checklist