Skip to content

[TEEP-5473] Document multi_secret_backends for multiple native secret backends#37920

Open
ian28223 wants to merge 5 commits into
masterfrom
ian.bucad/TEEP-5473-multi-secret-backends-v2
Open

[TEEP-5473] Document multi_secret_backends for multiple native secret backends#37920
ian28223 wants to merge 5 commits into
masterfrom
ian.bucad/TEEP-5473-multi-secret-backends-v2

Conversation

@ian28223

@ian28223 ian28223 commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Fixes TEEP-5473

Documents the multi_secret_backends feature (Agent 7.80+, datadog-agent #47987), which lets you declare multiple named native secret backends and route secrets to a specific backend using the ENC[backendName;secretKey] handle format.

New section added under Option 1 ("Using multiple native backends simultaneously"):

  • Configuration structure (multi_secret_backends with named entries, each with type and config)
  • ENC[backendName;secretKey] handle format, including the first-semicolon-only delimiter rule for keys that contain semicolons
  • Precedence: secret_backend_commandsecret_backend_typemulti_secret_backends
  • Example using two backends (YAML file + AWS Secrets Manager) simultaneously
  • Partial resolution behavior and datadog-agent secret output
  • Step-by-step migration guide from secret_backend_type

Merge readiness

  • Ready for merge

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
  • 🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

AI assistance

Used Claude Code for research (PR diff and release notes extraction), drafting the new section, and applying edits.

Additional notes

… backends

Adds documentation for the multi_secret_backends feature (Agent 7.80+):
- Config structure with named backends (type + config per entry)
- ENC[backendName;secretKey] handle format and semicolon delimiter rules
- Precedence over secret_backend_command / secret_backend_type
- Partial resolution behavior and secret output example
- Step-by-step migration guide from secret_backend_type

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ian28223 ian28223 requested a review from a team as a code owner July 2, 2026 06:22
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@ian28223

ian28223 commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

/review

@github-actions github-actions Bot 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.

🤖 Automated review by Claude. AI-generated; verify before acting.

New section documenting multi_secret_backends (Agent 7.80+). Two clarity issues worth addressing before merge: a numeric inconsistency in the sample output that will confuse users, and a heading that breaks the surrounding Option 1/2/3 structure of the parent section. Also flagged one gap around backend name constraints.

Reviewed 396c49a11fd52999a4f375f4a7b4b5db5010f2faworkflow run

Comment thread content/en/agent/configuration/secrets-management.md Outdated
Comment thread content/en/agent/configuration/secrets-management.md Outdated
Comment thread content/en/agent/configuration/secrets-management.md Outdated
…constraint

- Rename heading to "Option 1b" to preserve Option 1/2/3 numbered flow
- Fix resolved secret count (2 → 1) to match the sample output
- Note that backend names cannot contain semicolons

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jeff-morgan-dd jeff-morgan-dd self-assigned this Jul 2, 2026

@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 see query on "1b" numbering - thank you!

Comment thread content/en/agent/configuration/secrets-management.md Outdated
ian28223 and others added 2 commits July 3, 2026 10:37
…section

- Add Single backend / Multiple backends sub-headings under Option 1
- Remove secret_backend_timeout mentions
- Rephrase precedence as numbered list
- Drop Partial resolution section
- Rename "ENC handle format" to "ENC notation"
- Clarify "backend delimiter" wording

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

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ian28223 ian28223 requested a review from jeff-morgan-dd July 3, 2026 02:11

@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 updating the architecture, this looks great!


#### Multiple backends

**Available in Agent version 7.80+**

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.

Suggestion - maybe this could be italics instead; on the page this basically renders looking identical to the H4 heading name right above it which is a bit difficult to parse.

Also, do we want to say Agent version 7.80+?

These are non-blocking but just items to consider - thanks!

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