Skip to content

Add Docker setup to the self-hosted Db2 DBM guide - #42045

Open
jasonmp85 wants to merge 3 commits into
masterfrom
jason.petersen/db2-selfhosted-docker
Open

jasonmp85 wants to merge 3 commits into
masterfrom
jason.petersen/db2-selfhosted-docker

Conversation

@jasonmp85

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Adds Docker deployment instructions to the self-hosted IBM Db2 Database Monitoring guide, including password resolution, driver configuration mounts, and validation. Includes EC2 networking guidance within the shared setup, with Host, Docker, and Kubernetes tabs following the existing DBM guide structure.

Alternative to #42029: treats Db2 on EC2 as a self-hosted deployment and keeps the database setup in one place.

Merge readiness

  • Ready for merge

AI assistance

Used Codex to compare existing DBM guides, draft the documentation, and run validation checks.

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.

Additional notes

Validation: Vale 3.9.1 reported zero errors, warnings, or suggestions. A targeted Hugo render passed; rendered tabs, local anchors, YAML, shell syntax, and Docker secret/driver mount paths were checked. The container example has not been tested against a running Db2 instance.

@github-actions

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@jasonmp85
jasonmp85 marked this pull request as ready for review November 20, 2026 19:16
@jasonmp85
jasonmp85 requested review from a team as code owners November 20, 2026 19:16
jasonmp85 and others added 2 commits November 20, 2026 12:31
Revert unrelated heading changes, restore the Docker Autodiscovery and
Step 4 links, and point the Amazon Linux Docker install link to the
Amazon ECS guide.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace the file-based secret backend example with the standard DBM
guidance on secret management and template variables.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@git-thuerk-done git-thuerk-done 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 adding the Docker setup! The main fix is moving link definitions into the tabs (see the inline suggestions).

  • This PR is described as an alternative to #42029, which adds a separate EC2 page. Could you confirm with the DBM team which approach should go forward, so only one merges?

  • After the definitions move into the tabs, these page-bottom definitions are no longer used outside a tab: [6], [7], [8], [9], [11], [12], [13], [21], [22], [24], [26]. Consider removing them so they don't become orphans.

For Windows, follow the IBM Db2 integration's [Windows driver installation instructions][13].

#### Optional: Prepare an Agent container image
{{% /tab %}}

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.

Reference links inside a tab need their definitions inside the same tab, or they render as broken text. This adds the definitions this tab uses.

Suggested change
{{% /tab %}}
[6]: /agent/
[7]: /integrations/ibm-db2/#dependencies
[8]: /integrations/ibm-db2/#installing-ibm_db-client-library-offline
[13]: /integrations/ibm-db2/#windows
{{% /tab %}}


Continue with the shared check and driver configuration in [Step 4](#step-4-configure-the-agent), then [run the Agent container](#run-the-agent-in-docker). For other Docker Agent options, see the [Docker Agent documentation][21]. To configure the check with container labels instead of a mounted configuration file, follow the [Docker Autodiscovery instructions][9] and specify `ibm_db2` as the integration name.

{{% /tab %}}

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.

Same as the Host tab: this adds the definitions this tab uses.

Suggested change
{{% /tab %}}
[8]: /integrations/ibm-db2/#installing-ibm_db-client-library-offline
[9]: /containers/docker/integrations/
[21]: /containers/docker/
[24]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-container-image.html#create-container-image-install-docker
{{% /tab %}}


Set up the [secret backend][10] on the Agent that runs the check. With cluster checks, this is the Cluster Checks Runner, which also needs the custom image and the [automatic client reroute (ACR) configuration](#disable-automatic-client-reroute).

{{% /tab %}}

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.

Same as the Host tab: this adds the definitions this tab uses.

Suggested change
{{% /tab %}}
[10]: /agent/configuration/secrets-management/
[11]: /containers/cluster_agent/clusterchecks/
[12]: /containers/kubernetes/integrations/
[22]: /containers/kubernetes/
{{% /tab %}}


Follow the [Kubernetes Agent status instructions][26]. With cluster checks, check the status of the Cluster Checks Runner that runs the Db2 check.

{{% /tab %}}

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.

Same as the Host tab: this adds the definitions this tab uses.

Suggested change
{{% /tab %}}
[26]: /agent/configuration/agent-commands/#agent-information
{{% /tab %}}

### Step 4: Configure the Agent

On Linux, save this configuration in `/etc/datadog-agent/conf.d/ibm_db2.d/conf.yaml`. For other platforms, see the [Agent configuration directory][20]. For a containerized Agent, apply the instance settings using the configuration method selected in Step 3.
For a Linux host or the Docker example below, save this configuration on the Agent host in `/etc/datadog-agent/conf.d/ibm_db2.d/conf.yaml`. Create the directory if it does not exist. For other host platforms, see the [Agent configuration directory][20]. For Kubernetes, apply the instance settings using the configuration method selected in Step 3.

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.

Optional: consider linking the Docker section instead of using the directional "below".

Suggested change
For a Linux host or the Docker example below, save this configuration on the Agent host in `/etc/datadog-agent/conf.d/ibm_db2.d/conf.yaml`. Create the directory if it does not exist. For other host platforms, see the [Agent configuration directory][20]. For Kubernetes, apply the instance settings using the configuration method selected in Step 3.
For a Linux host or a [Docker Agent](#run-the-agent-in-docker), save this configuration on the Agent host in `/etc/datadog-agent/conf.d/ibm_db2.d/conf.yaml`. Create the directory if it does not exist. For other host platforms, see the [Agent configuration directory][20]. For Kubernetes, apply the instance settings using the configuration method selected in Step 3.

: IBM Db2 for Linux, UNIX, and Windows (Db2 LUW).

Network access
: Allow the Agent to reach each Db2 server's direct address on the Db2 service port (`50000` by default). Allow outbound HTTPS connections to [Datadog][23]. On Amazon EC2, configure security groups and VPC routing to allow connections from the Agent host to the Db2 servers. The Agent can run on a database server or a separate instance.

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.

Optional: the last sentence repeats the first line of Step 3, so consider dropping it here.

Suggested change
: Allow the Agent to reach each Db2 server's direct address on the Db2 service port (`50000` by default). Allow outbound HTTPS connections to [Datadog][23]. On Amazon EC2, configure security groups and VPC routing to allow connections from the Agent host to the Db2 servers. The Agent can run on a database server or a separate instance.
: Allow the Agent to reach each Db2 server's direct address on the Db2 service port (`50000` by default). Allow outbound HTTPS connections to [Datadog][23]. On Amazon EC2, configure security groups and VPC routing to allow connections from the Agent host to the Db2 servers.

[22]: /containers/kubernetes/
[23]: /agent/configuration/network/#destinations
[24]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-container-image.html#create-container-image-install-docker
[25]: /agent/faq/template_variables/

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.

Optional: this links to the canonical page instead of the redirect alias.

Suggested change
[25]: /agent/faq/template_variables/
[25]: /containers/guide/template_variables/

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