DOCS-33: initial extension config docs - #392
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
jeff-matthews
changed the title
jeff-matthews
added
the
data-collection
StephenHinck
left a comment
StephenHinck
left a comment
There was a problem hiding this comment.
overall, looking good. I left some comments, and I owe you some updates on deployment for pulling the container
| Before you configure the AWS collector, ensure that the following prerequisites are met: | ||
|
|
||
| - OpenHound installed with the AWS collector included. | ||
| - For BloodHound Community Edition, install the [OpenHound CLI](/openhound/community). |
There was a problem hiding this comment.
Beta isn't available for CE, so we can remove this.
|
|
||
| - OpenHound installed with the AWS collector included. | ||
| - For BloodHound Community Edition, install the [OpenHound CLI](/openhound/community). | ||
| - For BloodHound Enterprise, [deploy](/openhound/enterprise) OpenHound as a container. |
There was a problem hiding this comment.
Beta customers won't be able to use the standard deployment of OpenHound. It will be a specific container. I'm getting those instructions from Joey to replace the aws login ones that currently exist there.
| SOURCES__SOURCE__AWS__CREDENTIALS__PROFILE_NAMES='["production","testing"]' | ||
| ``` | ||
| </Tab> | ||
| <Tab title="AWS organization profile"> |
There was a problem hiding this comment.
Is there a good way we can mark this as the recommended path?
There was a problem hiding this comment.
For sure! I think reordering (at a minimum) so the recommended option shows up first.
The optional decoration in the following screenshot is probably too much 🤭; just showing some options
|
|
||
| Before continuing, ensure that a valid `secrets.toml` file is available and contains the BloodHound Enterprise credentials, AWS target profile(s), and optionally bucket collection policies. The Compose examples assume that the secrets file is stored in the user's home directory at `~/.dlt/secrets.toml`. | ||
|
|
||
| ### Internal SO step for BETA ONLY |
There was a problem hiding this comment.
This is the section that contains the deployment instructions for the beta-specific container. Will get those updated instructions for you from Joey.
|
|
||
| The OpenHound AWS collector is the SpecterOps-supported tool for retrieving AWS account and organization data for BloodHound. | ||
|
|
||
| If you are evaluating collector options for the AWS extension, this is the recommended path. An alternative collector ([AWSHound](https://github.com/SpecterOps/AWSHound)) exists, but this documentation section focuses specifically on the OpenHound-based collector. |
There was a problem hiding this comment.
Please delete this line. AWSHound is not supported.
| "group": "Collectors", | ||
| "pages": [ | ||
| { | ||
| "group": "AWS", |
There was a problem hiding this comment.
I believe this needs update to be unlisted/indexed?
There was a problem hiding this comment.
Not necessary since the files use the hidden: true metadata, but I'll remove just to be safe.
2 participants
Summary
Draft extension config docs