Skip to content

Add sizing table with more accurate hardware requirements - #363

Open
jeff-matthews wants to merge 1 commit into
mainfrom
on-prem-specs
Open

Add sizing table with more accurate hardware requirements#363
jeff-matthews wants to merge 1 commit into
mainfrom
on-prem-specs

Conversation

@jeff-matthews

@jeff-matthews jeff-matthews commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

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

  • Documentation
    • Added disk latency requirements for on-premises deployments, including SSDs and P99 write latency guidance.
    • Added Small, Medium, and Large sizing recommendations covering compute, memory, storage, collectors, and high availability.
    • Replaced outdated hardware sizing statements with clearer deployment guidance.

@jeff-matthews jeff-matthews self-assigned this Jul 27, 2026
@jeff-matthews jeff-matthews added the on-prem Docs related to managing self-hosted BloodHound Enterprise deployments (on-premises) label Jul 27, 2026
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The 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.

Changes

On-premises requirements

Layer / File(s) Summary
Requirements and sizing guidance
docs/on-premises/system-requirements.mdx
Adds a P99 write latency requirement of ≤10ms for SSDs that blocks installation, and introduces Small/Medium/Large sizing guidance for CPU, RAM, storage, collectors, HA posture, and recommendations.

Estimated code review effort: 2 (Simple) | ~10 minutes

Poem

I’m a rabbit with a tidy chart,
SSDs now pass the latency part.
Small, Medium, Large in rows aligned,
Clearer hardware clues to find.
Hop, hop—requirements start!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the main change: adding a sizing table and updated hardware requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch on-prem-specs

Comment @coderabbitai help to get the list of available commands.

@jeff-matthews jeff-matthews added the feedback Updates based on internal and external feedback label Jul 27, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2045fc8 and 3bf153b.

📒 Files selected for processing (1)
  • docs/on-premises/system-requirements.mdx

Comment on lines +39 to +43
| 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 |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feedback Updates based on internal and external feedback on-prem Docs related to managing self-hosted BloodHound Enterprise deployments (on-premises)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant