Skip to content

[K9VULN-18095] docs: simplify README + document SaaS mode - #295

Merged
k3nz0 merged 5 commits into
mainfrom
moez.ezzeddine/simplify-readme
Oct 2, 2026
Merged

k3nz0 merged 5 commits into
mainfrom
moez.ezzeddine/simplify-readme

Conversation

@k3nz0

@k3nz0 k3nz0 commented Oct 1, 2026 •

Copy link
Copy Markdown
Member
  • Remove Usage and Uninstall sections (covered by the examples).
  • Link examples for AWS, Azure and GCP.
  • Split the AWS architecture into self-hosted and SaaS modes, and add small documentation for SaaS mode.

Jira: K9VULN-18095

🤖 Generated with Claude Code

… SaaS modes

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@k3nz0
k3nz0 requested a review from a team as a code owner October 1, 2026 16:49
k3nz0 and others added 2 commits October 1, 2026 18:52
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@k3nz0 k3nz0 changed the title docs: simplify README [K9VULN-18095] docs: simplify README Oct 1, 2026
@k3nz0 k3nz0 changed the title [K9VULN-18095] docs: simplify README [K9VULN-18095] docs: simplify README + document SaaS mode Oct 1, 2026
Comment thread README.md

For more information about Agentless Scanning, see the [Datadog Agentless Scanning documentation](https://docs.datadoghq.com/security/cloud_security_management/agentless_scanning/).

## Prerequisites

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can we keep and update the prerequisites?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The requirements for terraform and AWS providers are listed here a bit below so no need to repeat them:

https://github.com/DataDog/terraform-module-datadog-agentless-scanner/pull/295/changes#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L165-L170

I added the mention to the API key in self-hosted mode section as SaaS mode doesn't require the API keys.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We do require an api_key in the saas mode to set the scan options. It is in the example.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

(I meant you can install SaaS mode without terraforming the scan options)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

makes sense!

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

My 2 cents: API and APP keys are indeed required if you want to set up scan options and it's already mentioned in the examples readme, so I think it's enough:

1. Run `terraform apply`, and provide your Datadog [API and application keys](https://docs.datadoghq.com/account_management/api-app-keys/), your [Datadog site](https://docs.datadoghq.com/getting_started/site/) and the Datadog integration role name.

Comment thread README.md
@@ -1,104 +1,48 @@
# Terraform Module Datadog Agentless Scanner

This Terraform module provides a simple and reusable configuration for installing a Datadog Agentless Scanner.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think that we should keep an intro sentence instead of starting with: Terraform modules ...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I find this full sentence a bit useless tbh. I can't see which interesting information it provides? (compared to a straight sentence about what the repo contains)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It's more of a landing sentence but we can not keep it if you find it useless

Comment thread README.md
This Terraform module provides a simple and reusable configuration for installing a Datadog Agentless Scanner.
Terraform modules to set up [Datadog Agentless Scanning](https://docs.datadoghq.com/security/cloud_security_management/agentless_scanning/) on AWS, Azure and GCP.

This document covers installation on AWS. For [Azure](./azure) and [GCP](./gcp) instructions, please see their respective directories.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This statement was making expectations clear, the cutomer won't find Azure and GCP details here and will have to check other directories.

@k3nz0 k3nz0 Oct 2, 2026 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Updated!

k3nz0 and others added 2 commits October 2, 2026 11:07
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…d mode

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@k3nz0
k3nz0 merged commit 4d4caeb into main Oct 2, 2026
3 checks passed
@k3nz0
k3nz0 deleted the moez.ezzeddine/simplify-readme branch October 2, 2026 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants