Skip to content

DOCS-42: Create a collector client (openhound) - #411

Open
jeff-matthews wants to merge 1 commit into
mainfrom
DOCS-42-openhound-collector-client
Open

DOCS-42: Create a collector client (openhound)#411
jeff-matthews wants to merge 1 commit into
mainfrom
DOCS-42-openhound-collector-client

Conversation

@jeff-matthews

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

Copy link
Copy Markdown
Contributor

Summary

This pull request (PR) adds a new OpenHound section to the Create a collector client docs.

Adding new screenshots for OpenHound made me realize that the SharpHound and AzureHound screenshots also need to be updated since we rolled out some recent UI improvements. That's beyond the scope of this PR.

Summary by CodeRabbit

  • Documentation
    • Expanded the collector creation guide to support SharpHound Enterprise, AzureHound Enterprise, and OpenHound.
    • Added requirements links, creation steps, token configuration guidance, and updated outcome imagery.
    • Clarified AzureHound Token ID and credential requirements.
    • Added OpenHound feature-flag information and updated collector terminology.

@jeff-matthews jeff-matthews self-assigned this Aug 27, 2026
@jeff-matthews jeff-matthews added the data-collection Docs related to nodes, edges, and general data collection label Aug 27, 2026
@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2eaf8b99-66a2-43a6-be54-91986ab1579f

📥 Commits

Reviewing files that changed from the base of the PR and between 0b5ed19 and 2b4bab3.

⛔ Files ignored due to path filters (3)
  • docs/images/data_collectors/create-collector-outcome.png is excluded by !**/*.png
  • docs/images/data_collectors/create-openhound-client-token-info.png is excluded by !**/*.png
  • docs/images/data_collectors/create-openhound.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/collect-data/enterprise-collection/create-collector.mdx

Included review availability: 4 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


Walkthrough

The enterprise collection guide now covers SharpHound Enterprise, AzureHound Enterprise, and OpenHound. It adds requirements, client creation steps, API-token details, feature-flag messaging, and secrets.toml configuration guidance.

Changes

Enterprise collector documentation

Layer / File(s) Summary
Guide scope and terminology
docs/collect-data/enterprise-collection/create-collector.mdx
The guide adds OpenHound to its supported collectors, requirements, and introductory content.
Collector creation and configuration
docs/collect-data/enterprise-collection/create-collector.mdx
The guide adds AzureHound and OpenHound client creation steps, Token ID and Token details, feature-flag messaging, outcome imagery, and secrets.toml configuration instructions.

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

Merge Risk: ⚪ Minimal · up to 2b4ba

This PR adds OpenHound collector documentation and screenshots without introducing an actionable merge-blocking risk; it is merge-ready after normal checks and review.

Poem

A rabbit reads the collector guide,
With tokens tucked safely inside.
AzureHound joins the trail,
OpenHound follows the trail,
SharpHound keeps pace with pride.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change: adding documentation for creating an OpenHound collector client. It is concise and specific.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOCS-42-openhound-collector-client

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 Aug 27, 2026
@jeff-matthews jeff-matthews changed the title DOCs-42: Create a collector client (openhound) DOCS-42: Create a collector client (openhound) Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

data-collection Docs related to nodes, edges, and general data collection feedback Updates based on internal and external feedback

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant