Skip to content

[DOCS-14683] Add Secrets Management to MySQL source#37418

Open
maycmlee wants to merge 4 commits into
masterfrom
may/DOCS-14683-mysql-secrets
Open

[DOCS-14683] Add Secrets Management to MySQL source#37418
maycmlee wants to merge 4 commits into
masterfrom
may/DOCS-14683-mysql-secrets

Conversation

@maycmlee

@maycmlee maycmlee commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

  • Adds Secrets Management to MySQL destination doc
  • Adds MySQL env vars to the Env Var doc
  • Creates a shortcode for MySQL env var

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

AI assistance

Additional notes

@maycmlee maycmlee requested a review from a team as a code owner June 10, 2026 18:20
@maycmlee maycmlee added the WORK IN PROGRESS No review needed, it's a wip ;) label Jun 10, 2026
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Jun 10, 2026
@github-actions github-actions Bot added the Guide Content impacting a guide label Jun 10, 2026
@datadog-official

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

@maycmlee

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.

Changes look clean and consistent with the established pattern used across other Observability Pipelines source pages (danger alert + secrets_env_var_note shortcode + tabbed Secret defaults section). Naming for the new env var (DD_OP_SOURCE_MYSQL_CONNECTION_STRING) and secret identifier (SOURCE_MYSQL_CONNECTION_STRING) follows the documented convention. The MySQL entry in environment_variables.md is correctly placed alphabetically. No blockers; no style violations in the changed lines.

Reviewed 9120747574bfc4181a578be78544c34b8dfdc4baworkflow run

@maycmlee maycmlee removed the WORK IN PROGRESS No review needed, it's a wip ;) label Jun 10, 2026

@domalessi domalessi 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.

Two minor suggestions. Otherwise, looks good!

After you select the MySQL source in the pipeline UI:

1. Enter the connection string.
1. Enter the identifier for your URI connection string. If you leave it blank, the [default](#secret-defaults) is used.

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.

Suggested change
1. Enter the identifier for your URI connection string. If you leave it blank, the [default](#secret-defaults) is used.
1. Enter the identifier for your URI connection string. If you leave it blank, the [default](#secret-defaults) applies.


Ensure you have completed the [prerequisite steps](#prerequisites) first. Then, set up the MySQL source and its environment variables when you [set up a pipeline][1]. The information below is configured in the pipelines UI.

<div class="alert alert-danger">For Secrets Management: Only enter the identifier for the MySQL URI connection string. Do <b>not</b> enter the actual value.</div>

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.

The identifier/actual distinction is what's most important here, so I think it makes more sense to bold that.

Suggested change
<div class="alert alert-danger">For Secrets Management: Only enter the identifier for the MySQL URI connection string. Do <b>not</b> enter the actual value.</div>
<div class="alert alert-danger">When using Secrets Management, only enter the <b>identifier</b> for the MySQL URI connection string, not the actual value.</div>

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 Guide Content impacting a guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants