Skip to content

[DOCS-11780] Add API and app key setup guidance to Terraform integration doc#23875

Open
buraizu wants to merge 2 commits into
masterfrom
docs11780/terraform-api-key-setup
Open

[DOCS-11780] Add API and app key setup guidance to Terraform integration doc#23875
buraizu wants to merge 2 commits into
masterfrom
docs11780/terraform-api-key-setup

Conversation

@buraizu
Copy link
Copy Markdown
Contributor

@buraizu buraizu commented May 28, 2026

What does this PR do? What is the motivation?

Fixes DOCS-11780

Adds a note to the Configuration section of the Terraform integration README explaining that api_key and app_key refer to Datadog API and application keys, with a link to create them and guidance to use TF_VAR_* environment variables to avoid hardcoding credentials.

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

References

  • DOCS-11780 (Hotjar feedback: users couldn't find where to set up API and app keys on the Terraform integration config page)

@datadog-datadog-prod-us1
Copy link
Copy Markdown
Contributor

datadog-datadog-prod-us1 Bot commented May 28, 2026

Pipelines

Fix all issues with BitsAI

⚠️ Warnings

🚦 1 Pipeline job failed

Validate repository | Run Validations / Validate   View in Datadog   GitHub Actions

🛟 This job is unlikely to succeed on retry. Please review your pipeline configuration. Pull Request #23875 is missing a required QA decision label. Must declare if QA validation is needed for the next Agent release.

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 779b019 | Docs | Datadog PR Page | Give us feedback!

@buraizu buraizu marked this pull request as ready for review May 28, 2026 23:58
@buraizu buraizu requested review from a team as code owners May 28, 2026 23:58
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4e034c9e61

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread terraform/README.md Outdated

**Note**: If you are not using the Datadog US1 site, you must set the `api_url` [optional parameter][7] with your [Datadog site][6]. Ensure the documentation site selector on the right of the page is set to your correct Datadog site, then use the following URL as the value of the `api_url` parameter:
**Notes**:
- The `api_key` and `app_key` values are your Datadog API key and application key. See [API and application keys][8] to create these credentials. To avoid storing credentials in your configuration files, set them as Terraform environment variables (`TF_VAR_datadog_api_key` and `TF_VAR_datadog_app_key`) before running any Terraform commands.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Declare variables before recommending TF_VAR credentials

For this exact main.tf snippet, setting TF_VAR_datadog_api_key and TF_VAR_datadog_app_key does not make var.datadog_api_key or var.datadog_app_key exist; Terraform only uses TF_VAR_ values for already-declared input variables (see HashiCorp's input-variable docs). Users following the doc as written will still hit undeclared input variable errors during validation/plan/apply unless the example also includes variable blocks for both names, or the guidance instead uses the Datadog provider's supported DD_API_KEY/DD_APP_KEY environment variables.

Useful? React with 👍 / 👎.

@dd-octo-sts
Copy link
Copy Markdown
Contributor

dd-octo-sts Bot commented May 29, 2026

Validation Report

Validation Description Status
qa-label Validate the pull request declares whether it needs QA for the next Agent release

Run ddev validate all changed --fix to attempt to auto-fix supported validations.

Passed validations (20)
Validation Description Status
agent-reqs Verify check versions match the Agent requirements file
ci Validate CI configuration and code coverage settings
codeowners Validate every integration has a CODEOWNERS entry
config Validate default configuration files against spec.yaml
dep Verify dependency pins are consistent and Agent-compatible
http Validate integrations use the HTTP wrapper correctly
imports Validate check imports do not use deprecated modules
integration-style Validate check code style conventions
jmx-metrics Validate JMX metrics definition files and config
labeler Validate PR labeler config matches integration directories
legacy-signature Validate no integration uses the legacy Agent check signature
license-headers Validate Python files have proper license headers
licenses Validate third-party license attribution list
metadata Validate metadata.csv metric definitions
models Validate configuration data models match spec.yaml
openmetrics Validate OpenMetrics integrations disable the metric limit
package Validate Python package metadata and naming
readmes Validate README files have required sections
saved-views Validate saved view JSON file structure and fields
version Validate version consistency between package and changelog

View full run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants