Add sizing table with more accurate hardware requirements - #363
Add sizing table with more accurate hardware requirements#363jeff-matthews wants to merge 1 commit into
Conversation
WalkthroughThe on-premises system requirements page adds a disk latency preflight requirement and replaces fixed hardware notes with Small, Medium, and Large sizing guidance covering compute, memory, storage, collectors, high availability, and recommendations. ChangesOn-premises requirements
Estimated code review effort: 2 (Simple) | ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/on-premises/system-requirements.mdx`:
- Around line 39-43: Reconcile the sizing table with the documented
embedded-cluster deployment model: either change the Medium and Large profiles
to single-host sizing, or document the supported multi-node architecture,
provisioning requirements, HA prerequisites, and clarify that vCPU, RAM, and
storage values are per-node or aggregate. Update the surrounding deployment
guidance and the table consistently.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9024a8f6-5d3e-4f18-a69e-53e57544a7eb
📒 Files selected for processing (1)
docs/on-premises/system-requirements.mdx
| | Size | Good fit | App nodes | vCPU per node | RAM per node | Storage | Collectors | HA posture | Recommendation | | ||
| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | ||
| | Small | Smaller enterprise, 1-2 domains, lighter concurrent use | 1 | 8 | 32GB | 250GB SSD | 1 | Backup/restore only | Best entry production size | | ||
| | Medium | Typical enterprise, multiple domains, regular use | 2 | 8-12 | 32-48GB | 500GB SSD | 2 | Basic resilience | Best default starting point | | ||
| | Large | Large or complex enterprise, heavy graph, more concurrency | 3 | 12-16 | 64GB | 1-2TB SSD/NVMe | 3+ | Full HA-oriented design | Best for scale and growth headroom | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift
Reconcile the sizing table with the documented deployment model.
The page currently says embedded-cluster installations use one Linux VM with the application, Kubernetes, and optionally PostgreSQL on the same host, but Medium and Large now recommend two and three app nodes. The table does not explain whether multi-node deployments are supported, how to provision them, or whether resources and storage are per-node or aggregate. Either keep these profiles single-host, or document the supported multi-node architecture and HA prerequisites before publishing.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/on-premises/system-requirements.mdx` around lines 39 - 43, Reconcile the
sizing table with the documented embedded-cluster deployment model: either
change the Medium and Large profiles to single-host sizing, or document the
supported multi-node architecture, provisioning requirements, HA prerequisites,
and clarify that vCPU, RAM, and storage values are per-node or aggregate. Update
the surrounding deployment guidance and the table consistently.
Purpose
This pull request (PR) adds a separate system requirements table for on-premises instances. It includes the latest hardware spec recommendations for small, medium, and large instances.
Summary by CodeRabbit