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 cfb9afdf05a..d493094467a 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" /%} @@ -643,6 +643,95 @@ 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, replacing `` with the version you want to use, such as `2.17.0`: + +```json +"image": "datadog/observability-pipelines-worker:" +``` + +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. + +{% /if %} + + +{% if equals($platform, "docker") %} + +## Upgrade the Worker + +To upgrade the Worker: + +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 + ``` + ``` + docker rm + ``` + + +{% if equals($secrets_source, "environment_variables") %} + +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= \ + -e \ + -e \ + -p 8088:8088 \ + datadog/observability-pipelines-worker run + ``` + + 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`. + - 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 updated 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 + ``` + + 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 %} + + +{% if equals($platform, "cloudformation") %} + +## Upgrade the Worker + +To upgrade the Worker, update the Worker image version in your CloudFormation stack and redeploy it. + {% /if %} @@ -740,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