DOCS-26: On-premises upgrade process (headless) - #375
Conversation
jeff-matthews
added
the
on-prem
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughAdded an On-premises BloodHound Enterprise upgrade page. The guide covers embedded-cluster prerequisites, health checks, headless upgrades, validation, support bundles, troubleshooting, and retries. The page was added to the documentation navigation. ChangesOn-premises upgrade guide
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
| System upgraded. Daemon service restarted. | ||
| Downloading new release... | ||
| Downloaded release version: 0.0.1 | ||
| 2026/08/03 20:34:24 WARN revision directory already exists, removing revision=pending |
There was a problem hiding this comment.
See my comment in DOCS-26 (Aha!), but I believe that this indicates a new version was not available to upgrade to at the time of testing. I think I need to try again after confirming that a new release is available in the portal under the Release History tab.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/upgrade.mdx`:
- Around line 82-95: Update the version-comparison examples in the “Check the
installed version” step and its corresponding post-upgrade example so the
Application version strings differ, while preserving the revision details and
surrounding output. Ensure the examples clearly demonstrate that a successful
upgrade changes the application version rather than only the revision.
- Around line 268-281: Update the “Check the installed version” Step to make the
post-upgrade comparison explicit, clearly identifying the embedded cluster and
BloodHound Enterprise application versions that must be compared with the
corresponding pre-upgrade values. Keep the existing version command and example
output, while matching the clarified comparison guidance from the earlier
upgrade step.
🪄 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: 6101eaf7-be84-4d00-84ce-2510df7fc8a0
📒 Files selected for processing (2)
docs/docs.jsondocs/on-premises/upgrade.mdx
| <Step title="Check the installed version"> | ||
| Print the embedded cluster and BloodHound Enterprise application versions. Save the output so you can compare it with the post-upgrade version. | ||
|
|
||
| ```bash | ||
| sudo ./bloodhound-enterprise version | ||
| ``` | ||
|
|
||
| Expected output looks similar to the following: | ||
|
|
||
| ```text | ||
| Embedded Cluster: 3.0.0-alpha-9 (commit 181fed8, built 2026-01-28_18:35:09) | ||
| Application: bloodhound-enterprise 0.0.1 (revision 1, channel sequence 9) | ||
| ``` | ||
| </Step> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Clarify the version-comparison example.
This step tells the reader to save the pre-upgrade version output to compare with the post-upgrade version. The example output here shows Application: bloodhound-enterprise 0.0.1 (revision 1, channel sequence 9). Compare this to the post-upgrade example at Line 279, which shows Application: bloodhound-enterprise 0.0.1 (revision 2, channel sequence 9). The Application version string is identical in both examples; only revision changes.
Since the entire purpose of this comparison is to confirm the upgrade succeeded, a reader following the example literally may conclude that only the revision value is expected to change, not the version itself, or may mistake an unchanged version for a failed upgrade. Update one of the two example outputs to show a differing application version, so the example clearly demonstrates a successful version change.
🤖 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/upgrade.mdx` around lines 82 - 95, Update the
version-comparison examples in the “Check the installed version” step and its
corresponding post-upgrade example so the Application version strings differ,
while preserving the revision details and surrounding output. Ensure the
examples clearly demonstrate that a successful upgrade changes the application
version rather than only the revision.
There was a problem hiding this comment.
Acknowledged. See my comment on line 197. Will keep this open as a reminder to update the "after" version command output.
There was a problem hiding this comment.
@jeff-matthews, acknowledged. Keeping the thread open is appropriate until the post-upgrade version output shows a different Application version.
You are interacting with an AI system.
| <Step title="Check the installed version"> | ||
| Print the embedded cluster and BloodHound Enterprise application versions again and compare them with the version you recorded before the upgrade. | ||
|
|
||
| ```bash | ||
| sudo ./bloodhound-enterprise version | ||
| ``` | ||
|
|
||
| Example output: | ||
|
|
||
| ```text | ||
| Embedded Cluster: 3.0.0-alpha-9 (commit 181fed8, built 2026-01-28_18:35:09) | ||
| Application: bloodhound-enterprise 0.0.1 (revision 2, channel sequence 9) | ||
| ``` | ||
| </Step> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Same version-comparison clarity concern as Line 82-95.
This is the corresponding post-upgrade output referenced in the Line 82-95 comment. See that comment for the fix.
🤖 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/upgrade.mdx` around lines 268 - 281, Update the “Check the
installed version” Step to make the post-upgrade comparison explicit, clearly
identifying the embedded cluster and BloodHound Enterprise application versions
that must be compared with the corresponding pre-upgrade values. Keep the
existing version command and example output, while matching the clarified
comparison guidance from the earlier upgrade step.
There was a problem hiding this comment.
@jeff-matthews, acknowledged. The finding remains open pending the documentation update.
You are interacting with an AI system.
|
|
||
| ## Upgrade BloodHound Enterprise | ||
|
|
||
| Use the BloodHound Enterprise installer binary for the version you want to install. Each embedded cluster binary targets a specific BloodHound Enterprise release. |
There was a problem hiding this comment.
This text is from an upstream source and implies you must download a new binary specific to the version you want to upgrade to. I need to confirm. If so, requires an extra step before running the upgrade command.
|
|
||
| System upgraded. Daemon service restarted. | ||
| Downloading new release... | ||
| Downloaded release version: 0.0.1 |
There was a problem hiding this comment.
I think this is a known issue, but if we don't print the actual BHE version here, it may not be very helpful to include these verification commands and output.
1 participant
Summary
This pull request (PR) adds instructions for upgrading a BloodHound Enterprise on-premises instance as described in DOCS-26 (Aha!).
I tested all instructions on my own v9.4.0 instance. While none of the instructions failed per se, it didn't result in an upgraded instance because a new version has not yet been made available in the portal. See this comment.
I'm also unsure whether it requires downloading a new binary for the target upgrade version.
Staging
We no longer have access to staging builds on Mintlify 😒
But you can build the site locally to preview the changes.
Summary by CodeRabbit
Documentation