Skip to content

[DBMON-6566] Add Set up Database Monitoring with Terraform page - #36421

Merged
sangeetashivaji merged 24 commits into
masterfrom
sangeeta.shivajirao/dbm-agent-terraform-docs
May 19, 2026
Merged

[DBMON-6566] Add Set up Database Monitoring with Terraform page#36421
sangeetashivaji merged 24 commits into
masterfrom
sangeeta.shivajirao/dbm-agent-terraform-docs

Conversation

@sangeetashivaji

@sangeetashivaji sangeetashivaji commented May 1, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Fixes DBMON-6566

Adds a new Markdoc page at /database_monitoring/setup_agent_terraform/ with three filter dropdowns (Database, Database hosting, Agent runtime). Three combinations are populated end-to-end (architecture, prerequisites, apply, inputs, verify, troubleshooting), all for Postgres on AWS:

Database hosting Agent runtime Backing Terraform example
RDS / Aurora / self-hosted on EC2 ECS Fargate terraform/postgres/aws/ecs-fargate/
RDS / Aurora / self-hosted on EC2 Amazon EKS (EC2 nodes) terraform/postgres/aws/amazon-eks/
RDS / Aurora / self-hosted on EC2 Amazon EC2 terraform/postgres/aws/ec2/

The dropdowns only expose the values the page currently has content for: Postgres as the database; RDS / Aurora / self-hosted as the hosting; ECS Fargate / Amazon EKS / Amazon EC2 as the Agent runtime. There is no longer a "Coming soon" stub — every combination the dropdowns produce renders real content. As more databases / clouds / runtimes land in DataDog/dd-database-monitoring-example, this page (and its option groups) is extended.

Also adds the supporting option IDs, traits, and option groups in customization_config/ so the dropdowns render with the right labels.

Merge instructions

Merge readiness:

  • Ready for merge

@sangeetashivaji
sangeetashivaji requested review from a team as code owners May 1, 2026 15:08
@github-actions github-actions Bot added the cdocs label May 1, 2026
@github-actions

github-actions Bot commented May 1, 2026

Copy link
Copy Markdown
Contributor

@hestonhoffman hestonhoffman added the editorial review Waiting on a more in-depth review label May 1, 2026
@sangeetashivaji
sangeetashivaji force-pushed the sangeeta.shivajirao/dbm-agent-terraform-docs branch from 2bcd06d to cb5650d Compare May 6, 2026 19:14
@sangeetashivaji
sangeetashivaji requested a review from a team as a code owner May 11, 2026 13:43
sangeetashivaji and others added 8 commits May 11, 2026 10:07
New Markdoc page at /database_monitoring/setup_agent_terraform/ with
three filter dropdowns: database, db_hosting, agent_runtime. The
Postgres + RDS + AWS Fargate combination has full content;
other combinations render a Coming soon stub that links to the
per-database setup pages.

The page links to Terraform examples in
DataDog/dd-database-monitoring-example, which use the path scheme
<database>/<hosting>/<agent-runtime>/. As examples land there, the
matching combinations are filled out on this page.

Adds supporting option IDs, traits, and option groups in
customization_config so the dropdowns render with the right labels.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Updates the page to match what dd-database-monitoring-example actually
ships now that PR #8 has landed there.

- Path links updated from postgres/rds/* to terraform/postgres/rds/*,
  reflecting the new top-level terraform/ tree in the example repo.

- Renames option ID aws_fargate -> ecs_fargate (and adds the matching
  "ECS Fargate" label in options/general.yaml). The previous name was
  ambiguous since EKS Fargate is also AWS Fargate; the slug already
  said ecs-fargate, so the option ID now matches.

- Adds a full Postgres + Amazon EKS branch (architecture, prereqs for
  BYO and greenfield modes, apply, required inputs, verify, and
  troubleshooting), parallel to the ECS Fargate branch. Both modes are
  supported by the new terraform/postgres/rds/amazon-eks/ example.

- Both runtime branches now render for db_hosting in {rds, aurora,
  self_hosted}, not just rds. The AWS-side Terraform module is
  hosting-agnostic on the database side -- Aurora customers point
  rds_endpoint at the cluster writer endpoint, self-hosted-on-EC2
  customers point at the EC2 instance. A "Hosting note" block at the
  top of each runtime section spells this out so customers don't have
  to infer it from variable names. Cloud SQL, AlloyDB, and Azure still
  fall through to "Coming soon" -- those need cloud-native examples.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Public-repo PR #8 renamed terraform/postgres/rds/ -> terraform/postgres/aws/
because one Terraform module covers RDS, Aurora, and self-hosted-on-EC2
(everything reachable inside an AWS VPC by SG). Update all path
references on this page to match, and adjust the path-scheme in the
overview to read as <database>/<cloud>/<agent-runtime>/.

The docs filter values for db_hosting (rds, aurora, self_hosted) are
unchanged -- they remain the customer-facing dropdown -- but all three
filter values now link to the same terraform/postgres/aws/<runtime>/
directory.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The public repo (PR #8) renamed the RDS-flavored variable names to
db_endpoint / db_security_group_id / db_port. Update this page to
match: variable mentions in the Hosting note, the Apply blocks, and
the Required inputs tables for both ECS Fargate and Amazon EKS
branches.

Also rewrites the "Hosting note" sections in both branches. They no
longer open with "uses RDS-flavored variable names" since the names
are no longer RDS-flavored. The new framing reads as a direct
mapping:

  Point db_endpoint and db_security_group_id at:
    - RDS:           ...
    - Aurora:        ...
    - self-hosted:   ...

The inputs tables likewise spell out the RDS row explicitly so all
three hostings get parallel treatment.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Backs the new terraform/postgres/aws/ec2/ example in
DataDog/dd-database-monitoring-example. Mirrors the structure of the existing
ECS Fargate and Amazon EKS sections (Hosting note, Architecture, Prerequisites,
Apply, Required inputs, Verify, Troubleshooting). Adjusts the "Coming soon"
guard to also exclude the EC2 combination.
The page now ships with content for every combination the dropdowns can
produce, so the conditional Coming soon block is no longer reachable. Prunes
mysql/sql_server, cloud_sql/alloydb/azure, and ecs_ec2 from the option
groups (and the corresponding option labels + trait notes), leaving only the
combinations dd-database-monitoring-example actually backs today: Postgres
on RDS/Aurora/self-hosted, Agent on ECS Fargate / Amazon EKS / Amazon EC2.
Converts the Terraform setup page from Markdoc/cdocs dropdowns to
standard Hugo tabs shortcode, per feedback to hold off on cdocs pilot
for now. Reverts customization_config changes (option_groups, options,
traits) added for cdocs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds a landing _index.md for /database_monitoring/setup_agent_terraform/
and moves the Postgres content to a postgres.md sub-page, following the
structure Jeff suggested: top-level section per database, with tabs per
agent runtime within each DB page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@sangeetashivaji
sangeetashivaji force-pushed the sangeeta.shivajirao/dbm-agent-terraform-docs branch from 5b6a76a to 288c385 Compare May 11, 2026 14:09
@github-actions github-actions Bot removed the cdocs label May 11, 2026
@jeff-morgan-dd jeff-morgan-dd self-assigned this May 11, 2026

Select your database to get started:

- [Postgres][2]

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

more DBs to be added soon

@jeff-morgan-dd jeff-morgan-dd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for this PR, Sangeeta! Mostly some style guide-type fixes throughout, please also see what looks like merge conflict artifacts in traits/general.yaml.

Comment thread content/en/database_monitoring/setup_agent_terraform/_index.md Outdated

Select your database to get started:

- [Postgres][2]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This would be nice with tiles and logos by DBMS, in a similar format to pages like https://docs.datadoghq.com/database_monitoring/setup_postgres/

Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
- id: secrets_source
label: Secrets source
type: text
<<<<<<< HEAD

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This and below looks like some merge conflict artifacts, please resolve - thanks!

@jeff-morgan-dd jeff-morgan-dd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for this PR, Sangeeta! Mostly some style guide-type fixes throughout, please also see what looks like merge conflict artifacts in traits/general.yaml.

@sangeetashivaji
sangeetashivaji removed the request for review from a team May 14, 2026 12:58
@sangeetashivaji
sangeetashivaji force-pushed the sangeeta.shivajirao/dbm-agent-terraform-docs branch from 3e4442f to 68bfe02 Compare May 14, 2026 13:28
@gh-worker-ownership-write-b05516
gh-worker-ownership-write-b05516 Bot removed the request for review from a team May 14, 2026 13:41
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label May 14, 2026
sangeetashivaji and others added 2 commits May 14, 2026 11:05
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Rename index title: "Provision the Datadog Agent with Terraform"
- Rename postgres title: "Provision the Datadog Agent for Postgres with Terraform"
- Add main.en.yaml entry so the section appears in the left nav after ClickHouse

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@jeff-morgan-dd jeff-morgan-dd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please also address reference links for shortcodes that we discussed in Slack - thank you!

Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
Comment thread content/en/database_monitoring/setup_agent_terraform/postgres.md Outdated
sangeetashivaji and others added 8 commits May 18, 2026 10:24
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
- Move link reference definitions inside each tab shortcode so Hugo
  resolves them correctly (references outside shortcodes don't resolve
  within tab scope)
- Update page title per reviewer suggestion to be more specific for
  search and AI agents: distinguish DBM setup from generic Postgres
  integration

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@jeff-morgan-dd jeff-morgan-dd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good! Thank you for working through all the changes @sangeetashivaji!

@sangeetashivaji

Copy link
Copy Markdown
Contributor Author

/merge

@gh-worker-devflow-routing-ef8351

gh-worker-devflow-routing-ef8351 Bot commented May 18, 2026

Copy link
Copy Markdown

View all feedbacks in Devflow UI.

2026-05-18 20:47:25 UTC ℹ️ Start processing command /merge


2026-05-18 20:47:31 UTC ℹ️ MergeQueue: waiting for PR to be ready

This pull request is not mergeable according to GitHub. Common reasons include pending required checks, missing approvals, or merge conflicts — but it could also be blocked by other repository rules or settings.
It will be added to the queue as soon as checks pass and/or get approvals. View in MergeQueue UI.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2026-05-18 21:51:16 UTC ℹ️ MergeQueue: queue is disabled

Added to the queue but the mergequeue is not enabled for now.


2026-05-19 13:34:14 UTC ⚠️ MergeQueue: This merge request was unqueued

sangeeta.shivajirao@datadoghq.com unqueued this merge request

@sangeetashivaji

Copy link
Copy Markdown
Contributor Author

/merge -c

@gh-worker-devflow-routing-ef8351

gh-worker-devflow-routing-ef8351 Bot commented May 19, 2026

Copy link
Copy Markdown

View all feedbacks in Devflow UI.

2026-05-19 13:34:06 UTC ℹ️ Start processing command /merge -c

@sangeetashivaji
sangeetashivaji merged commit 08f8d19 into master May 19, 2026
19 of 24 checks passed
@sangeetashivaji
sangeetashivaji deleted the sangeeta.shivajirao/dbm-agent-terraform-docs branch May 19, 2026 13:34
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 editorial review Waiting on a more in-depth review mergequeue-status: removed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants