Skip to content

BP-2731: On-premises architecture diagram#338

Open
jeff-matthews wants to merge 32 commits into
mainfrom
BP-2731-onprem-architecture
Open

BP-2731: On-premises architecture diagram#338
jeff-matthews wants to merge 32 commits into
mainfrom
BP-2731-onprem-architecture

Conversation

@jeff-matthews

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

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation
    • Updated the on-premises architecture guide to describe a dedicated application host plus one or more separate collector hosts.
    • Added guidance and an embedded diagram clarifying component placement and data flow.
    • Expanded the documentation with an accordion covering collector-initiated session behavior and related firewall/inbound considerations.
    • Refreshed the “Core components” table to label the main application component as BloodHound Enterprise and include REST API, UI, graph analysis, and collector ingestion responsibilities.

Staging

https://specterops-bp-2731-onprem-architecture.mintlify.app/on-premises/architecture#deployment-architecture

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

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • docs/images/on-premises/on-prem-architecture-diagram.drawio.svg is excluded by !**/*.svg

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 17081c79-8049-4818-8073-7e0987b31e39

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

Documentation update to docs/on-premises/architecture.mdx reframing the on-premises setup as a dedicated application host plus separate collector hosts, adding connection and risk notes with a diagram, and renaming the core component in the table.

Changes

Architecture Documentation Update

Layer / File(s) Summary
Architecture description and components table update
docs/on-premises/architecture.mdx
Replaced the "two primary parts" bullet description with a paragraph describing dedicated application and collector hosts, added a diagram note and accordion about session initiation and inbound risk, and renamed "BloodHound Enterprise API" to "BloodHound Enterprise" in the core components table.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • SpecterOps/bloodhound-docs#288: Prior changes to the same on-premises architecture documentation established the surrounding architecture content this PR updates.

Suggested reviewers: computator, Scoubi, rtippitt-specterops

Poem

A rabbit hops through docs so neat,
Two host types now make the treat.
A diagram glows, the table sings,
With BloodHound Enterprise in its wings.
Hop hop—this page feels right! 🐇

🚥 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 matches the main change: an on-premises architecture diagram update.
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 BP-2731-onprem-architecture

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.

❤️ Share

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

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
bloodhound 🟢 Ready View Preview Jul 2, 2026, 4:35 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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

Labels

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