Skip to content

Operator Documentation Update for SQL Server #29216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 117 commits into
base: master
Choose a base branch
from

Conversation

aldrickdev
Copy link
Contributor

What does this PR do? What is the motivation?

This PR is meant to update our Kubernetes Documentation to include instructions for the Datadog Operator. It also updates a couple configurations to provide more up to date examples. The motivation comes from This Card.

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in 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.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

@aldrickdev aldrickdev requested review from a team as code owners May 7, 2025 16:55
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label May 7, 2025
@drichards-87 drichards-87 self-requested a review May 7, 2025 16:58
@drichards-87 drichards-87 added the editorial review Waiting on a more in-depth review label May 7, 2025
aldrick.castro and others added 17 commits May 7, 2025 13:47
…Es (#28830)

Co-authored-by: joepeeples <joe.peeples@datadoghq.com>
* Clarify tag extraction docs

* Fix linter

* Update content/en/cloud_cost_management/container_cost_allocation.md

Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>

* Move inside the tabs

---------

Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
* add note

* update all instances

* update text

* add advanced configuration links

* remove go files
* Change name of Env Var and OTel API in nav.

* Change Direct OTLP Ingest to Agentless Deployment in nav.

* Change Direct OTLP Ingest to Agentless Deployment in content.

* Add example app + demo under Getting Started.

* Tweak wording.

* Make wording consistent for Getting Started landing page.

* Revert agentless deployment outside of nav and setup page.

* Revert change.
Co-authored-by: renteria1010 <111309302+renteria1010@users.noreply.github.com>
Co-authored-by: buraizu <bryce.eadie@datadoghq.com>
* Fix link to resource-based sampling guide

* Update content/en/tracing/trace_pipeline/ingestion_mechanisms.md

---------

Co-authored-by: Esther Kim <esther.kim@datadoghq.com>
Co-authored-by: estherk15 <esther.kim@datadoghq.com>
Co-authored-by: mabdinur <munir.abdinur@datadoghq.com>
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
maycmlee and others added 3 commits May 7, 2025 14:31
* Update libraries.yaml

Add descriptions to libraries that were missing them

* combine API, dogstatds, and official columns

* fix table layout to accomodate longer descriptions

* minor layout tweaks

* Remove extra "swift" categories

* Update libraries.yaml

Add missing or improved descriptions for all "non-classic" libraries
@aldrickdev aldrickdev requested review from a team as code owners May 7, 2025 18:32
@aldrickdev aldrickdev requested a review from liashenko May 7, 2025 18:32
@github-actions github-actions bot added Github Related to Github configurations Images Images are added/removed with this PR Guide Content impacting a guide FAQ Content impacting a FAQ labels May 7, 2025
@github-actions github-actions bot removed Github Related to Github configurations Images Images are added/removed with this PR Guide Content impacting a guide FAQ Content impacting a FAQ labels May 7, 2025
@drichards-87 drichards-87 removed request for a team and liashenko May 9, 2025 15:24
Copy link
Contributor

@drichards-87 drichards-87 left a comment

Choose a reason for hiding this comment

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

Left some suggestions on the PR.

@@ -302,7 +306,66 @@ Use the `service` and `env` tags to link your database telemetry to other teleme
{{% tab "Kubernetes" %}}
If you have a Kubernetes cluster, use the [Datadog Cluster Agent][1] for Database Monitoring.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you have a Kubernetes cluster, use the [Datadog Cluster Agent][1] for Database Monitoring.
If you're running a Kubernetes cluster, use the [Datadog Cluster Agent][1] to enable Database Monitoring. If cluster checks aren’t already enabled, [follow these instructions][2] to enable them before proceeding.

Comment on lines +309 to +310
If cluster checks are not already enabled in your Kubernetes cluster, follow the instructions to [enable cluster checks][2]:

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If cluster checks are not already enabled in your Kubernetes cluster, follow the instructions to [enable cluster checks][2]:


### Operator

Using the [Operator instructions in Kubernetes and Integrations][6] as a reference, follow the steps below to set up the SQL Server integration:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Using the [Operator instructions in Kubernetes and Integrations][6] as a reference, follow the steps below to set up the SQL Server integration:
Follow the steps below to set up the SQL Server integration, using the [Operator instructions in Kubernetes and Integrations][6] as a reference.

@@ -314,19 +377,20 @@ Complete the following steps to install the [Datadog Cluster Agent][1] on your K
clusterAgent:
confd:
sqlserver.yaml: |-
cluster_check: true
cluster_check: true # Make sure to include this flag
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
cluster_check: true # Make sure to include this flag
cluster_check: true # Required for cluster checks

@@ -224,7 +224,66 @@ Use the `service` and `env` tags to link your database telemetry to other teleme
{{% tab "Kubernetes" %}}
If you have a Kubernetes cluster, use the [Datadog Cluster Agent][1] for Database Monitoring.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you have a Kubernetes cluster, use the [Datadog Cluster Agent][1] for Database Monitoring.
If you're using a Kubernetes cluster, use the [Datadog Cluster Agent][1] for Database Monitoring. If cluster checks aren’t already enabled, [follow these instructions][2] to enable them before proceeding..

@@ -1,38 +1,98 @@
If you have a Kubernetes cluster, use the [Datadog Cluster Agent][1] for Database Monitoring.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you have a Kubernetes cluster, use the [Datadog Cluster Agent][1] for Database Monitoring.
If you're running a Kubernetes cluster, use the [Datadog Cluster Agent][1] to enable Database Monitoring. If cluster checks aren’t already enabled, [follow these instructions][2] to enable them before proceeding.

Comment on lines +3 to 4
If cluster checks are not already enabled in your Kubernetes cluster, follow the instructions to [enable cluster checks][2]:

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If cluster checks are not already enabled in your Kubernetes cluster, follow the instructions to [enable cluster checks][2]:


Execute the following [Helm][3] command to install the [Datadog Cluster Agent][1] on your Kubernetes cluster. Replace the values to match your account and environment:
Using the [Operator instructions in Kubernetes and Integrations][5] as a reference, follow the steps below to set up the SQL Server integration:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Using the [Operator instructions in Kubernetes and Integrations][5] as a reference, follow the steps below to set up the SQL Server integration:
Follow the steps below to set up the SQL Server integration, using the [Operator instructions in Kubernetes and Integrations][5] as a reference.

extraConfd:
configDataMap:
sqlserver.yaml: |-
cluster_check: true # Make sure to include this flag
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
cluster_check: true # Make sure to include this flag
cluster_check: true # Required for cluster checks

clusterAgent:
confd:
sqlserver.yaml: |-
cluster_check: true # Make sure to include this flag
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
cluster_check: true # Make sure to include this flag
cluster_check: true # Required for cluster checks

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.