Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-9725] Cloudcraft in Datadog #27718

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

aliciascott
Copy link
Contributor

What does this PR do? What is the motivation?

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@aliciascott aliciascott requested a review from a team as a code owner February 19, 2025 23:37
@aliciascott aliciascott added the WORK IN PROGRESS No review needed, it's a wip ;) label Feb 19, 2025
@github-actions github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Feb 19, 2025
Copy link

@srividya-rajagopalan srividya-rajagopalan left a comment

Choose a reason for hiding this comment

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

My review feedback:

  • The explanation of standalone Cloudcraft could be clearer. Consider rephrasing to make it more concise and direct.
  • Group-bys and filters should be explained before presets, as presets reference group-by functionality.
  • The image associated with the infrastructure diagram is incorrect—it should have the infrastructure layer selected.
  • Need to clarify “Filters” vs. “Search and Highlight”
    • Filter: Re-renders the diagram to show only infrastructure that matches the filter criteria.
    • Search and Highlight: Highlights the search criteria in the diagram - does not create a new diagram but the elements that match the search criteria are highlighted and the rest are greyed.
  • Security Overlay:
    • By default, it displays Critical, High, and Medium severity issues.
    • Instead of “can be configured by hovering over”, say “can be filtered.”
  • Agent Overlay
    • The red dot color will be changed to a greyish tone— confirm this before release.

@jamesponddotco
Copy link
Contributor

jamesponddotco commented Mar 11, 2025

@srividya-rajagopalan asked me to take a look, so here I'm. The documentation looks excelent, and Sri already pointed out a few issues, so I don't have much to add.

If you have advanced security requirements, it is possible to create a custom IAM role with more limited permissions, however, this may not be compatible with other Datadog products.

The minimal IAM policy from standalone Cloudcraft won't work for Cloudcraft in Datadog, so this portion should be removed.

Additionally, you can click into a specific security group to see the inbound and outbound rules for that group.

That is true for standalone Cloudcraft, but not for Cloudcraft in Datadog. The connections are displayed in the diagram, though.


I also think we may need to update the menu item for standalone Cloudcraft from "Cloudcraft" to "Standalone Cloudcraft", otherwise we have "Cloudcraft" twice in the menu, which may lead to confusion.

We may also need a warning, note, or something like that on the documentation for both the standalone and in Datadog leading the user to the other one. Something like "If you're looking for documentation for standalone Cloudcraft, look here."

@aliciascott
Copy link
Contributor Author

Hi @srividya-rajagopalan and @jamesponddotco ! thank you both for your detailed review! I have addressed all of your comments except for the Agent overlay - Making a note here to review prior to release for Agent color and updated screenshot. Can you both please re-review when you get a chance? Thanks!

@jamesponddotco
Copy link
Contributor

@aliciascott Looks good to me, but I think @srividya-rajagopalan needs to approve it, since she was the requested reviewer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend Images Images are added/removed with this PR WORK IN PROGRESS No review needed, it's a wip ;)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants