From d25192b3c23ce0277f3cb8534fab8a9cc73a6ef2 Mon Sep 17 00:00:00 2001 From: May Lee Date: Tue, 23 Jun 2026 15:59:47 -0400 Subject: [PATCH 1/7] add info --- .../install_the_worker/_index.mdoc.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md index 77ec00ad706..8314129b581 100644 --- a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md +++ b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md @@ -643,6 +643,36 @@ An example task definition: Depending on your use case, configure either an [Application Load Balancer][22] or a [Network Load Balancer][23] to target the group of Fargate tasks you defined earlier. Configure the health check against the Observability Pipelines' API port that was set in the task definition. +## Upgrade the Worker + +To upgrade the Worker, update the `image` field in your container definition to the new version, replacing `` with the version you want to use (such as `2.17.0`): + +```json +"image": "datadog/observability-pipelines-worker:" +``` + +After updating the task definition, restart the ECS tasks to use the updated image. + +**Note**: If your container definition uses the `latest` tag instead of a pinned version, restarting the ECS tasks automatically upgrades the Worker to the latest available version. + +{% /if %} + + +{% if equals($platform, "docker") %} + +## Upgrade the Worker + +To upgrade the Worker, update the image version in your `docker run` command or `docker-compose.yml` file to `datadog/observability-pipelines-worker:`, replacing `` with the version you want to use (such as `2.17.0`). Then restart the container. + +{% /if %} + + +{% if equals($platform, "cloudformation") %} + +## Upgrade the Worker + +To upgrade the Worker, update the Worker image version in your CloudFormation stack and redeploy it. + {% /if %} From 0a92f1cee3e77278656a69638dfec826d1b319a1 Mon Sep 17 00:00:00 2001 From: May Lee Date: Tue, 23 Jun 2026 17:49:49 -0400 Subject: [PATCH 2/7] small edits --- .../configuration/install_the_worker/_index.mdoc.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md index 8314129b581..d088e307acb 100644 --- a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md +++ b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md @@ -645,7 +645,7 @@ Depending on your use case, configure either an [Application Load Balancer][22] ## Upgrade the Worker -To upgrade the Worker, update the `image` field in your container definition to the new version, replacing `` with the version you want to use (such as `2.17.0`): +To upgrade the Worker, update the `image` field in your container definition to the new version, replacing `` with the version you want to use, such as `2.17.0`: ```json "image": "datadog/observability-pipelines-worker:" @@ -662,7 +662,7 @@ After updating the task definition, restart the ECS tasks to use the updated ima ## Upgrade the Worker -To upgrade the Worker, update the image version in your `docker run` command or `docker-compose.yml` file to `datadog/observability-pipelines-worker:`, replacing `` with the version you want to use (such as `2.17.0`). Then restart the container. +To upgrade the Worker, update the image version in your `docker run` command or `docker-compose.yml` file to `datadog/observability-pipelines-worker:`, replacing `` with the version you want to use, such as `2.17.0`. Then restart the container. {% /if %} From a6351a0512c84a6b4394c1044bb74decc4d9cf32 Mon Sep 17 00:00:00 2001 From: May Lee Date: Wed, 24 Jun 2026 11:06:44 -0400 Subject: [PATCH 3/7] edit ecs fargate note --- .../configuration/install_the_worker/_index.mdoc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md index d088e307acb..7876873ee41 100644 --- a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md +++ b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md @@ -653,7 +653,7 @@ To upgrade the Worker, update the `image` field in your container definition to After updating the task definition, restart the ECS tasks to use the updated image. -**Note**: If your container definition uses the `latest` tag instead of a pinned version, restarting the ECS tasks automatically upgrades the Worker to the latest available version. +**Note**: If your container definition doesn't specify a version, restarting the ECS tasks automatically upgrades the Worker to the latest available version. {% /if %} From 976fa9511644a2ea83b95c056cdbe27528da9268 Mon Sep 17 00:00:00 2001 From: May Lee Date: Wed, 1 Jul 2026 15:47:18 -0400 Subject: [PATCH 4/7] update docker upgrade --- .../install_the_worker/_index.mdoc.md | 55 ++++++++++++++++++- 1 file changed, 54 insertions(+), 1 deletion(-) diff --git a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md index 8c0b249e18c..8fd35f71b82 100644 --- a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md +++ b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md @@ -662,7 +662,60 @@ After updating the task definition, restart the ECS tasks to use the updated ima ## Upgrade the Worker -To upgrade the Worker, update the image version in your `docker run` command or `docker-compose.yml` file to `datadog/observability-pipelines-worker:`, replacing `` with the version you want to use, such as `2.17.0`. Then restart the container. +To upgrade the Worker: + +1. Run `docker pull datadog/observability-pipelines-worker:`, replacing `` with the version you want to use, such as `2.17.0`. +2. Run these commands to stop and remove the container: + ``` + docker stop + ``` + ``` + docker rm + ``` + +{% if equals($secrets_source, "environment_variables") %} +3. Run the following command to install the Worker: + ```shell + docker run -i -e DD_API_KEY= \ + -e DD_OP_PIPELINE_ID= \ + -e DD_SITE= \ + -e \ + -e \ + -p 8088:8088 \ + datadog/observability-pipelines-worker run + ``` + + You must replace the placeholders with these values: + - ``: Your Datadog API key. + - **Note**: The API key must be [enabled for Remote Configuration][10]. + - ``: The ID of your pipeline. + - ``: The [Datadog site][11]. + - ``: The environment variables required by the source you are using for your pipeline. + - For example: `DD_OP_SOURCE_DATADOG_AGENT_ADDRESS=0.0.0.0:8282` + - See [Environment Variables][7] for a list of source environment variables. + - ``: The environment variables required by the destinations you are using for your pipeline. + - For example: `DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL=https://hec.splunkcloud.com:8088` + - See [Environment Variables][7] for a list of destination environment variables. +{% /if %} + +{% if equals($secrets_source, "secrets_management") %} + +3. Run the following command to install the Worker: + ``` + docker run -i -e DD_API_KEY= \ + -e DD_OP_PIPELINE_ID= \ + -e DD_SITE= \ + -v /path/to/local/bootstrap.yaml:/etc/observability-pipelines-worker/bootstrap.yaml \ + datadog/observability-pipelines-worker run + ``` + + You must replace the placeholders with the following values: + - ``: Your Datadog API key. + - **Note**: The API key must be [enabled for Remote Configuration][10]. + - ``: The ID of your pipeline. + - ``: The [Datadog site][11]. + +{% /if %} {% /if %} From 2a8b1d8cdf966d5b3d025a4be71cc754c2098dbf Mon Sep 17 00:00:00 2001 From: May Lee Date: Wed, 15 Jul 2026 11:39:17 -0400 Subject: [PATCH 5/7] apply suggestions --- .../install_the_worker/_index.mdoc.md | 24 ++++++++++++------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md index 8fd35f71b82..d0a44cb4d0b 100644 --- a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md +++ b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md @@ -657,15 +657,18 @@ After updating the task definition, restart the ECS tasks to use the updated ima {% /if %} - + {% if equals($platform, "docker") %} ## Upgrade the Worker To upgrade the Worker: -1. Run `docker pull datadog/observability-pipelines-worker:`, replacing `` with the version you want to use, such as `2.17.0`. -2. Run these commands to stop and remove the container: +1. Run the following command, replacing `` with the version you want to use, such as `2.17.0`: + ``` + docker pull datadog/observability-pipelines-worker: + ``` +2. Run the following commands to stop and remove the container: ``` docker stop ``` @@ -673,9 +676,11 @@ To upgrade the Worker: docker rm ``` + {% if equals($secrets_source, "environment_variables") %} -3. Run the following command to install the Worker: - ```shell + +3. Run the following command to install the updated Worker: + ``` docker run -i -e DD_API_KEY= \ -e DD_OP_PIPELINE_ID= \ -e DD_SITE= \ @@ -685,7 +690,7 @@ To upgrade the Worker: datadog/observability-pipelines-worker run ``` - You must replace the placeholders with these values: + You must replace the placeholders with the following values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. - ``: The ID of your pipeline. @@ -698,9 +703,10 @@ To upgrade the Worker: - See [Environment Variables][7] for a list of destination environment variables. {% /if %} + {% if equals($secrets_source, "secrets_management") %} -3. Run the following command to install the Worker: +3. Run the following command to install the updated Worker: ``` docker run -i -e DD_API_KEY= \ -e DD_OP_PIPELINE_ID= \ @@ -719,7 +725,7 @@ To upgrade the Worker: {% /if %} - + {% if equals($platform, "cloudformation") %} ## Upgrade the Worker @@ -823,7 +829,7 @@ image: ### Upgrade with the chart's default image tag -Run these commands to update the Helm repo and upgrade the release to the chart's default image, applying any overrides you previously set. Replace `` with the name of your `values.yaml` file: +Run the following commands to update the Helm repo and upgrade the release to the chart's default image, applying any overrides you previously set. Replace `` with the name of your `values.yaml` file: ```shell helm repo update From 35b02f54635273b311c7553ac64fcded2f4080c1 Mon Sep 17 00:00:00 2001 From: May Lee Date: Wed, 15 Jul 2026 15:11:00 -0400 Subject: [PATCH 6/7] Apply suggestions from code review Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> --- .../configuration/install_the_worker/_index.mdoc.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md index d0a44cb4d0b..77a5c67658e 100644 --- a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md +++ b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md @@ -645,13 +645,13 @@ Depending on your use case, configure either an [Application Load Balancer][22] ## Upgrade the Worker -To upgrade the Worker, update the `image` field in your container definition to the new version, replacing `` with the version you want to use, such as `2.17.0`: +To upgrade the Worker, update the `image` field in your container definition, replacing `` with the version you want to use, such as `2.17.0`: ```json "image": "datadog/observability-pipelines-worker:" ``` -After updating the task definition, restart the ECS tasks to use the updated image. +Restart the ECS tasks to use the updated image. **Note**: If your container definition doesn't specify a version, restarting the ECS tasks automatically upgrades the Worker to the latest available version. @@ -690,16 +690,16 @@ To upgrade the Worker: datadog/observability-pipelines-worker run ``` - You must replace the placeholders with the following values: + Replace the placeholders with the following values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. - ``: The ID of your pipeline. - ``: The [Datadog site][11]. - ``: The environment variables required by the source you are using for your pipeline. - - For example: `DD_OP_SOURCE_DATADOG_AGENT_ADDRESS=0.0.0.0:8282` + - For example: `DD_OP_SOURCE_DATADOG_AGENT_ADDRESS=0.0.0.0:8282`. - See [Environment Variables][7] for a list of source environment variables. - ``: The environment variables required by the destinations you are using for your pipeline. - - For example: `DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL=https://hec.splunkcloud.com:8088` + - For example: `DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL=https://hec.splunkcloud.com:8088`. - See [Environment Variables][7] for a list of destination environment variables. {% /if %} @@ -715,7 +715,7 @@ To upgrade the Worker: datadog/observability-pipelines-worker run ``` - You must replace the placeholders with the following values: + Replace the placeholders with the following values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. - ``: The ID of your pipeline. From d8ba0bbffc7d988d1cb54cd029c75558df693548 Mon Sep 17 00:00:00 2001 From: May Lee Date: Wed, 15 Jul 2026 15:13:40 -0400 Subject: [PATCH 7/7] edits for consistency --- .../install_the_worker/_index.mdoc.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md index 77a5c67658e..6208305b454 100644 --- a/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md +++ b/content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md @@ -87,7 +87,7 @@ This page describes how you can set up the Observability Pipelines Worker in ECS datadog/observability-pipelines-worker run ``` - You must replace the placeholders with the following values: + Replace the placeholders with the following values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. - ``: The ID of your pipeline. @@ -114,16 +114,16 @@ docker run -i -e DD_API_KEY= \ datadog/observability-pipelines-worker run ``` -You must replace the placeholders with these values: +Replace the placeholders with these values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. - ``: The ID of your pipeline. - ``: The [Datadog site][11]. - ``: The environment variables required by the source you are using for your pipeline. - - For example: `DD_OP_SOURCE_DATADOG_AGENT_ADDRESS=0.0.0.0:8282` + - For example: `DD_OP_SOURCE_DATADOG_AGENT_ADDRESS=0.0.0.0:8282`. - See [Environment Variables][7] for a list of source environment variables. - ``: The environment variables required by the destinations you are using for your pipeline. - - For example: `DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL=https://hec.splunkcloud.com:8088` + - For example: `DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL=https://hec.splunkcloud.com:8088`. - See [Environment Variables][7] for a list of destination environment variables. {% /if %} @@ -165,7 +165,7 @@ See [Update Existing Pipelines][13] if you want to make changes to your pipeline --set datadog.pipelineId= \ datadog/observability-pipelines-worker ``` - You must replace the placeholders with the following values: + Replace the placeholders with the following values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. @@ -188,16 +188,16 @@ See [Update Existing Pipelines][13] if you want to make changes to your pipeline --set service.ports[0].protocol=TCP,service.ports[0].port=,service.ports[0].targetPort= \ datadog/observability-pipelines-worker ``` - You must replace the placeholders with the following values: + Replace the placeholders with the following values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. - ``: The ID of your pipeline. - ``: The environment variables required by the source you are using for your pipeline. - - For example: `--set env[0].name=DD_OP_SOURCE_DATADOG_AGENT_ADDRESS,env[0].value='0.0.0.0' \` + - For example: `--set env[0].name=DD_OP_SOURCE_DATADOG_AGENT_ADDRESS,env[0].value='0.0.0.0' \`. - See [Environment Variables][7] for a list of source environment variables. - ``: The environment variables required by the destinations you are using for your pipeline. - - For example: `--set env[1].name=DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL,env[1].value='https://hec.splunkcloud.com:8088' \` + - For example: `--set env[1].name=DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL,env[1].value='https://hec.splunkcloud.com:8088' \`. - See [Environment Variables][7] for a list of destination environment variables. {% /if %} @@ -215,7 +215,7 @@ Follow these steps if you want to use the one-line installation script to instal ```bash DD_API_KEY= DD_OP_PIPELINE_ID= DD_SITE= bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_op_worker2.sh)" ``` - You must replace the placeholders with the following values: + Replace the placeholders with the following values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. - ``: The ID of your pipeline. @@ -240,16 +240,16 @@ Run this one-step command to install the Worker: ```bash DD_API_KEY= DD_OP_PIPELINE_ID= DD_SITE= bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_op_worker2.sh)" ``` -You must replace the placeholders with the following values: +Replace the placeholders with the following values: - ``: Your Datadog API key. - **Note**: The API key must be [enabled for Remote Configuration][10]. - ``: The ID of your pipeline. - ``: The [Datadog site][11]. - ``: The environment variables required by the source you are using for your pipeline. - - For example: `DD_OP_SOURCE_DATADOG_AGENT_ADDRESS=0.0.0.0:8282` + - For example: `DD_OP_SOURCE_DATADOG_AGENT_ADDRESS=0.0.0.0:8282`. - See [Environment Variables][7] for a list of source environment variables. - ``: The environment variables required by the destinations you are using for your pipeline. - - For example: `DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL=https://hec.splunkcloud.com:8088` + - For example: `DD_OP_DESTINATION_SPLUNK_HEC_ENDPOINT_URL=https://hec.splunkcloud.com:8088`. - See [Environment Variables][7] for a list of destination environment variables. {% partial file="observability_pipelines/install_the_worker/install-script-notes.mdoc.md" /%}