From 7902d9c4469a841212c6c648869796ab3511444a Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 08:36:37 -0700 Subject: [PATCH 01/13] Change tab from Agentv7.21+/v6.21+ to Host Install --- content/en/agent/guide/use-community-integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index 09e475eafb528..29277e7da79d4 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -23,7 +23,7 @@ For new users, download and install the latest version of the [Datadog Agent][2] ### Installation {{< tabs >}} -{{% tab "Agent v7.21+ / v6.21+" %}} +{{% tab "Host Install" %}} For Agent v7.21+ / v6.21+: From fd9f325845a4ef3f570a1dfcfc821802ead951ba Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 08:53:02 -0700 Subject: [PATCH 02/13] add sudo -u dd-agent to host install command and remove note --- content/en/agent/guide/use-community-integrations.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index 29277e7da79d4..32cf0a24f658e 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -30,9 +30,8 @@ For Agent v7.21+ / v6.21+: 1. Run the following command to install the Agent integration: ``` - datadog-agent integration install -t datadog-== + sudo -u dd-agent datadog-agent integration install -t datadog-== ``` - **Note**: If necessary, prepend `sudo -u dd-agent` to the installation command. The version for the integration can be found in the respective changelog on the integration's Github repository 2. Configure your integration similar to core [integrations][1]. From 4d1666d2af515921ef970b1ce35551c5088ac585 Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 09:02:00 -0700 Subject: [PATCH 03/13] add extra sentence explaining why customer should build custom image --- content/en/agent/guide/use-community-integrations.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index 32cf0a24f658e..8b18fc7311e22 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -42,7 +42,9 @@ For Agent v7.21+ / v6.21+: {{% /tab %}} {{% tab "Containerized" %}} -To use a community or Marketplace integration in a containerized environment, you must build a custom image that includes your desired community integration. +To use a community or Marketplace integration in a containerized environment, you must build a custom image that includes your desired community integration. + +Building a custom image ensures that the integration persists across deployments each time a new container starts. Use the following Dockerfile to build a custom version of the Agent that includes the `` from [integrations-extras][2]. If you are installing a Marketplace integration, the `` is available in the configuration instructions. From a666753906b215c5acaed373af1c43c37c5fa7d3 Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 09:02:45 -0700 Subject: [PATCH 04/13] Remove note regarding error in containerized tab --- content/en/agent/guide/use-community-integrations.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index 8b18fc7311e22..c58b4267c955f 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -53,8 +53,6 @@ FROM gcr.io/datadoghq/agent:latest RUN agent integration install -r -t datadog-== ``` -The `agent integration install` command (run inside Docker) issues the following harmless warning: `Error loading config: Config File "datadog" Not Found in "[/etc/datadog-agent]": warn`. You can ignore this warning. - If you are using Kubernetes, update your Helm chart or Datadog Operator configuration to pull your custom image. Use [Autodiscovery][1] to enable and configure the integration. From 7669bfd6c40e82075bd49cf22424e4924feaed75 Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 09:17:34 -0700 Subject: [PATCH 05/13] Include note regarding multi arch images and add link to docker KB --- content/en/agent/guide/use-community-integrations.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index c58b4267c955f..dad196a15e169 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -52,6 +52,7 @@ Use the following Dockerfile to build a custom version of the Agent that include FROM gcr.io/datadoghq/agent:latest RUN agent integration install -r -t datadog-== ``` +If you are using a both `amd64` and `arm` based host architectures, you can [build multi-architecture images][3] as well. If you are using Kubernetes, update your Helm chart or Datadog Operator configuration to pull your custom image. @@ -59,6 +60,7 @@ Use [Autodiscovery][1] to enable and configure the integration. [1]: /agent/autodiscovery/ [2]: https://github.com/DataDog/integrations-extras +[3]: https://docs.docker.com/build/building/multi-platform/ {{% /tab %}} {{% tab "Agent earlier versions" %}} From 5844b6c8805a3325517145c8f6e0004bbfc8c07e Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 09:45:57 -0700 Subject: [PATCH 06/13] Provide sample image build command and add section for using this custom image via Helm/Operator --- .../agent/guide/use-community-integrations.md | 34 ++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index dad196a15e169..b3d41031d288e 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -52,9 +52,41 @@ Use the following Dockerfile to build a custom version of the Agent that include FROM gcr.io/datadoghq/agent:latest RUN agent integration install -r -t datadog-== ``` +Then build the image and push: + +``` +docker build -t /agent:-custom . +docker push /agent:-custom +``` + If you are using a both `amd64` and `arm` based host architectures, you can [build multi-architecture images][3] as well. -If you are using Kubernetes, update your Helm chart or Datadog Operator configuration to pull your custom image. +If you are using Kubernetes, update your Helm chart or Datadog Operator configuration to pull your custom image: + +#### Helm: +``` +agents: + image: + tag: + tagSuffix: "custom" + repository: //agent +``` +#### Operator: +``` +apiVersion: datadoghq.com/v2alpha1 +kind: DatadogAgent +metadata: + name: datadog +spec: + global: + registry: / + #(...) + override: + nodeAgent: + image: + name: agent + tag: -custom +``` Use [Autodiscovery][1] to enable and configure the integration. From 03ad8b05031207eb966cf0016df3178768f18c4a Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 09:53:52 -0700 Subject: [PATCH 07/13] Remove agent earlier versions section and add Building Image and Deploying Image sections --- .../agent/guide/use-community-integrations.md | 27 ++++--------------- 1 file changed, 5 insertions(+), 22 deletions(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index b3d41031d288e..2c99d512878be 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -41,6 +41,7 @@ For Agent v7.21+ / v6.21+: [2]: /agent/configuration/agent-commands/#restart-the-agent {{% /tab %}} {{% tab "Containerized" %}} +#### Building Image To use a community or Marketplace integration in a containerized environment, you must build a custom image that includes your desired community integration. @@ -61,9 +62,11 @@ docker push /agent:-custom If you are using a both `amd64` and `arm` based host architectures, you can [build multi-architecture images][3] as well. +#### Deploying Image + If you are using Kubernetes, update your Helm chart or Datadog Operator configuration to pull your custom image: -#### Helm: +##### Helm: ``` agents: image: @@ -71,7 +74,7 @@ agents: tagSuffix: "custom" repository: //agent ``` -#### Operator: +##### Operator: ``` apiVersion: datadoghq.com/v2alpha1 kind: DatadogAgent @@ -94,26 +97,6 @@ Use [Autodiscovery][1] to enable and configure the integration. [2]: https://github.com/DataDog/integrations-extras [3]: https://docs.docker.com/build/building/multi-platform/ {{% /tab %}} - -{{% tab "Agent earlier versions" %}} - -For Agent < v7.21 / v6.21: - -1. Download the files in the `/datadog_checks//` folder from the [integrations-extra repository][1]. -2. Place `.py` and any other Python files in the Agent's `checks.d` directory. -3. Create a new `.d/` folder in your [Agent configuration directory][2]. -4. Place the `conf.yaml.example` file from the `/datadog_checks//data/` folder in the created directory. -4. Rename this file to `conf.yaml`. -5. Configure your integration similar to core [integrations][3]. -6. [Restart the Agent][4]. - - - -[1]: https://github.com/DataDog/integrations-extras -[2]: /agent/configuration/agent-configuration-files/#agent-configuration-directory -[3]: /getting_started/integrations/ -[4]: /agent/configuration/agent-commands/#restart-the-agent -{{% /tab %}} {{< /tabs >}} If your site restricts network access, ensure you have added all of the [`ip-ranges`][3] to your inclusion list, or download the integration manually. From c3df00148209fd77a823d46460f1d573a25862fb Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 10:19:17 -0700 Subject: [PATCH 08/13] Improve Setup section to better point towards host vs containzerized install --- content/en/agent/guide/use-community-integrations.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index 2c99d512878be..f8789e3da44fe 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -18,7 +18,11 @@ Community developed integrations for the Datadog Agent are stored in the Datadog ## Setup -For new users, download and install the latest version of the [Datadog Agent][2]. +For new users, follow the installation method for your environment. +For host installation, download and install the latest version of the [Datadog Agent][2]. + For containzerized environments, use the [Datadog Agent container image][4]. + + ### Installation @@ -112,3 +116,4 @@ If your site restricts network access, ensure you have added all of the [`ip-ran [1]: https://github.com/DataDog/integrations-extras [2]: https://app.datadoghq.com/account/settings/agent/latest [3]: /agent/configuration/network +[4]: /containers/guide/container-images-for-docker-environments/?tab=gcr From efd9dfad4eb3a3835574f6a4dcdfb017e20e431a Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 10:19:59 -0700 Subject: [PATCH 09/13] Improve Setup section formatting --- content/en/agent/guide/use-community-integrations.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index f8789e3da44fe..37f864bdb9802 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -18,9 +18,7 @@ Community developed integrations for the Datadog Agent are stored in the Datadog ## Setup -For new users, follow the installation method for your environment. -For host installation, download and install the latest version of the [Datadog Agent][2]. - For containzerized environments, use the [Datadog Agent container image][4]. +For new users, follow the installation method for your environment. For host installation, download and install the latest version of the [Datadog Agent][2]. For containzerized environments, use the [Datadog Agent container image][4]. From c23339005e17ea65fc503b588bc3d553ee3d5005 Mon Sep 17 00:00:00 2001 From: Young Heon Koh <92887935+kohyoungheon@users.noreply.github.com> Date: Thu, 13 Nov 2025 12:26:28 -0700 Subject: [PATCH 10/13] Apply suggestions from code review Applying suggested changes! Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> --- .../agent/guide/use-community-integrations.md | 23 +++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index 37f864bdb9802..e098b7642e7dd 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -18,14 +18,13 @@ Community developed integrations for the Datadog Agent are stored in the Datadog ## Setup -For new users, follow the installation method for your environment. For host installation, download and install the latest version of the [Datadog Agent][2]. For containzerized environments, use the [Datadog Agent container image][4]. +Follow the installation method for your environment. -### Installation {{< tabs >}} -{{% tab "Host Install" %}} +{{% tab "Host installation" %}} For Agent v7.21+ / v6.21+: @@ -35,19 +34,19 @@ For Agent v7.21+ / v6.21+: sudo -u dd-agent datadog-agent integration install -t datadog-== ``` - The version for the integration can be found in the respective changelog on the integration's Github repository + The version for the integration can be found in the respective changelog on the integration's Github repository. 2. Configure your integration similar to core [integrations][1]. 3. [Restart the Agent][2]. [1]: /getting_started/integrations/ [2]: /agent/configuration/agent-commands/#restart-the-agent {{% /tab %}} -{{% tab "Containerized" %}} -#### Building Image +{{% tab "Containerized installation" %}} +#### Building the image -To use a community or Marketplace integration in a containerized environment, you must build a custom image that includes your desired community integration. +To use a community or Marketplace integration in a containerized environment, build a custom Agent image that includes your desired integration. -Building a custom image ensures that the integration persists across deployments each time a new container starts. +Building a custom image ensures the integration persists across deployments each time a container starts. Use the following Dockerfile to build a custom version of the Agent that includes the `` from [integrations-extras][2]. If you are installing a Marketplace integration, the `` is available in the configuration instructions. @@ -55,18 +54,18 @@ Use the following Dockerfile to build a custom version of the Agent that include FROM gcr.io/datadoghq/agent:latest RUN agent integration install -r -t datadog-== ``` -Then build the image and push: +Build and push the image: ``` docker build -t /agent:-custom . docker push /agent:-custom ``` -If you are using a both `amd64` and `arm` based host architectures, you can [build multi-architecture images][3] as well. +If you use both `amd64` and `arm` host architectures, you can also [build multi-architecture images][3]. -#### Deploying Image +#### Deploying the image -If you are using Kubernetes, update your Helm chart or Datadog Operator configuration to pull your custom image: +To deploy the custom image in Kubernetes, update your Helm chart or Datadog Operator configuration to pull the image. ##### Helm: ``` From 8bb82c83be3a94a731fc3d7aa3c6c6df37b5d59e Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 14:55:50 -0700 Subject: [PATCH 11/13] Specify code helm/operator code snippets as YAML for syntax highlighting --- content/en/agent/guide/use-community-integrations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index e098b7642e7dd..bf4620ab38db2 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -68,7 +68,7 @@ If you use both `amd64` and `arm` host architectures, you can also [build multi- To deploy the custom image in Kubernetes, update your Helm chart or Datadog Operator configuration to pull the image. ##### Helm: -``` +```yaml agents: image: tag: @@ -76,7 +76,7 @@ agents: repository: //agent ``` ##### Operator: -``` +```yaml apiVersion: datadoghq.com/v2alpha1 kind: DatadogAgent metadata: From 2b3114f577824fd992a02762e0877f19cb9b1e68 Mon Sep 17 00:00:00 2001 From: kohyoungheon Date: Thu, 13 Nov 2025 17:45:55 -0700 Subject: [PATCH 12/13] Include a bit more information on managing community integration files for host installation --- content/en/agent/guide/use-community-integrations.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index bf4620ab38db2..12290498da40e 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -20,9 +20,6 @@ Community developed integrations for the Datadog Agent are stored in the Datadog Follow the installation method for your environment. - - - {{< tabs >}} {{% tab "Host installation" %}} @@ -35,7 +32,7 @@ For Agent v7.21+ / v6.21+: ``` The version for the integration can be found in the respective changelog on the integration's Github repository. -2. Configure your integration similar to core [integrations][1]. +2. Manage your integration configuration files similar to [core integrations][1]—at their respective `/etc/datadog-agent/conf.d/.d/conf.yaml` file. 3. [Restart the Agent][2]. [1]: /getting_started/integrations/ From 033385cfcf0580705dadba3e237318b5df6153b8 Mon Sep 17 00:00:00 2001 From: domalessi <111786334+domalessi@users.noreply.github.com> Date: Fri, 14 Nov 2025 12:47:43 -0500 Subject: [PATCH 13/13] Apply suggestions from code review --- content/en/agent/guide/use-community-integrations.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/agent/guide/use-community-integrations.md b/content/en/agent/guide/use-community-integrations.md index 12290498da40e..8549cdd93cb82 100644 --- a/content/en/agent/guide/use-community-integrations.md +++ b/content/en/agent/guide/use-community-integrations.md @@ -31,15 +31,15 @@ For Agent v7.21+ / v6.21+: sudo -u dd-agent datadog-agent integration install -t datadog-== ``` - The version for the integration can be found in the respective changelog on the integration's Github repository. -2. Manage your integration configuration files similar to [core integrations][1]—at their respective `/etc/datadog-agent/conf.d/.d/conf.yaml` file. + The version for the integration can be found in the respective changelog on the integration's GitHub repository. +2. Manage your integration configuration files in the same way as [core integrations][1], placing each configuration in `/etc/datadog-agent/conf.d/.d/conf.yaml`. 3. [Restart the Agent][2]. [1]: /getting_started/integrations/ [2]: /agent/configuration/agent-commands/#restart-the-agent {{% /tab %}} {{% tab "Containerized installation" %}} -#### Building the image +#### Build the image To use a community or Marketplace integration in a containerized environment, build a custom Agent image that includes your desired integration. @@ -60,7 +60,7 @@ docker push /agent:-custom If you use both `amd64` and `arm` host architectures, you can also [build multi-architecture images][3]. -#### Deploying the image +#### Deploy the image To deploy the custom image in Kubernetes, update your Helm chart or Datadog Operator configuration to pull the image.