Skip to content

Commit 0fafb06

Browse files
maycmleedomalessi
andauthored
[DOCS-13623] Migrate Install the Worker to cdocs (#35124)
* rename doc * add docker * add k8s, linux, cf for api and tf * ui setup * move image * add ui instructions * add comments * fix cloudformation * add ecs fargate * add shortcodes for ui kubernetes * shortcode fix * add ui shortcode and clean up links * add k8s upgrade worker * updates and fixes * updates based on suggestions * fix issues * updates after review * update option to secrets management * add ecs fargate secrets * remove ecs fargate worker guide * remove ecs fargate from guide index * add notes shortcode * updates * remove unnecessary commands * small edits * Apply suggestions from code review Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> * update add domains for firewall * Apply suggestions from code review Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> * apply suggestions * update .gitignore * May/update anchor links cdocs (#37524) * update anchor links for cdocs * fix mistake --------- Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
1 parent d930665 commit 0fafb06

19 files changed

Lines changed: 1084 additions & 1670 deletions

File tree

content/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,3 +104,4 @@
104104
/*/tracing/trace_collection/custom_instrumentation/server-side/_index.md
105105
/*/dd_e2e/cdocs/components/card_grid.md
106106
/*/real_user_monitoring/application_monitoring/browser/setup/_index.md
107+
/*/observability_pipelines/configuration/install_the_worker/_index.md

content/en/observability_pipelines/configuration/export_and_import_pipeline_configurations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ To help build your pipelines and transfer pipeline configurations across Datadog
8181
{{< img src="observability_pipelines/export_pipeline/import_access.png" alt="The settings menu showing Import Pipeline" style="width:100%;" >}}
8282
1. Choose a pipeline configuration as a JSON file from your computer.
8383
{{< img src="observability_pipelines/export_pipeline/import_select.png" alt="The import modal giving the option to select a JSON file" style="width:100%;" >}}
84-
1. Click Import. This replaces your current pipeline configuration with the imported JSON's pipeline configuration.
84+
1. Click Import. This replaces your current pipeline configuration with the imported JSON's pipeline configuration.
8585
1. [Install the Observability Pipelines Worker and deploy your pipeline using the UI][8].
8686

8787
## Further reading
@@ -95,4 +95,4 @@ To help build your pipelines and transfer pipeline configurations across Datadog
9595
[5]: https://docs.datadoghq.com/api/latest/observability-pipelines/#update-a-pipeline
9696
[6]: /observability_pipelines/packs/
9797
[7]: /observability_pipelines/configuration/install_the_worker/#api-or-terraform-pipeline-setup
98-
[8]: https://docs.datadoghq.com/observability_pipelines/configuration/install_the_worker/?tab=docker#pipeline-ui-setup
98+
[8]: https://docs.datadoghq.com/observability_pipelines/configuration/install_the_worker/?interface=ui&platform=docker&secrets_source=secrets_management

content/en/observability_pipelines/configuration/install_the_worker/_index.md

Lines changed: 0 additions & 716 deletions
This file was deleted.

content/en/observability_pipelines/configuration/install_the_worker/_index.mdoc.md

Lines changed: 1004 additions & 0 deletions
Large diffs are not rendered by default.

content/en/observability_pipelines/configuration/secrets_management.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ backend_config:
4747
aws_region: <region_name>
4848
```
4949
50-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=docker#install-the-worker
50+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=docker&secrets_source=secrets_management
5151
[2]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/
5252
5353
{{% /tab %}}
@@ -64,7 +64,7 @@ bootstrap:
6464
aws_region: <region_name>
6565
```
6666

67-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=kubernetes#install-the-worker
67+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=kubernetes&secrets_source=secrets_management
6868
[2]: https://github.com/DataDog/helm-charts/blob/main/charts/observability-pipelines-worker/values.yaml#L46
6969

7070
{{% /tab %}}
@@ -106,7 +106,7 @@ secret:
106106
aws_region: <region_name>
107107
```
108108

109-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=docker#install-the-worker
109+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=docker&secrets_source=secrets_management
110110
[2]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/
111111

112112
{{% /tab %}}
@@ -123,7 +123,7 @@ bootstrap:
123123
aws_region: <region_name>
124124
```
125125

126-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=kubernetes#install-the-worker
126+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=kubernetes&secrets_source=secrets_management
127127
[2]: https://github.com/DataDog/helm-charts/blob/main/charts/observability-pipelines-worker/values.yaml#L46
128128

129129
{{% /tab %}}
@@ -152,7 +152,7 @@ backend_config:
152152
keyvaulturl: <key_vault_url>
153153
```
154154

155-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=docker#install-the-worker
155+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=docker&secrets_source=secrets_management
156156
[2]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/
157157

158158
{{% /tab %}}
@@ -168,7 +168,7 @@ bootstrap:
168168
keyvaulturl: <key_vault_url>
169169
```
170170

171-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=kubernetes#install-the-worker
171+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=kubernetes&secrets_source=secrets_management
172172
[2]: https://github.com/DataDog/helm-charts/blob/main/charts/observability-pipelines-worker/values.yaml#L46
173173

174174
{{% /tab %}}
@@ -229,7 +229,7 @@ secret:
229229
# ... additional session settings
230230
```
231231

232-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=docker#install-the-worker
232+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=docker&secrets_source=secrets_management
233233
[2]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/
234234

235235
{{% /tab %}}
@@ -250,7 +250,7 @@ bootstrap:
250250
# ... additional session settings
251251
```
252252

253-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=kubernetes#install-the-worker
253+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=kubernetes&secrets_source=secrets_management
254254
[2]: https://github.com/DataDog/helm-charts/blob/main/charts/observability-pipelines-worker/values.yaml#L46
255255

256256
{{% /tab %}}
@@ -287,7 +287,7 @@ Create the file `/path/to/json/file.json` to store the identifiers and their sec
287287
}
288288
```
289289

290-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=docker#install-the-worker
290+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=docker&secrets_source=secrets_management
291291
[2]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/
292292

293293

@@ -338,7 +338,7 @@ us1_api: "<api_key>"
338338
secret_identifier1: "<secret1>"
339339
```
340340

341-
[1]: /observability_pipelines/configuration/install_the_worker/?tab=docker#install-the-worker
341+
[1]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=docker&secrets_source=secrets_management
342342
[2]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/
343343

344344
{{% /tab %}}
@@ -391,7 +391,7 @@ kubectl exec <pod_name> -- kill -HUP 1
391391

392392
[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html
393393
[2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
394-
[3]: /observability_pipelines/configuration/install_the_worker/?tab=docker#install-the-worker
394+
[3]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=docker&secrets_source=secrets_management
395395
[4]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html
396396
[5]: https://developer.hashicorp.com/
397397
[6]: https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#configure-all-key-value-pairs-in-a-secret-as-container-environment-variables

content/en/observability_pipelines/configuration/set_up_pipelines.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ See [Advanced Worker Configurations][5] for bootstrapping options.
146146

147147
1. You can use the [datadog_observability_pipeline][10] module to create a pipeline using Terraform.
148148

149-
1. After creating the pipeline, [install the Worker][7] to send data through the pipeline.
149+
1. After creating the pipeline, [install the Worker][16] to send data through the pipeline.
150150
- See [Environment Variables][9] for the list of environment variables you need for the different sources, processor, and destinations when you install the Worker.
151151

152152
Use the [datadog_observability_pipeline][10] module to make any changes to an existing pipeline.
@@ -187,11 +187,12 @@ To delete a pipeline in the UI:
187187
[4]: https://app.datadoghq.com/observability-pipelines
188188
[5]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/
189189
[6]: /api/latest/observability-pipelines/#create-a-new-pipeline
190-
[7]: /observability_pipelines/configuration/install_the_worker/?tab=docker#api-or-terraform-pipeline-setup
190+
[7]: /observability_pipelines/configuration/install_the_worker/?interface=api&platform=docker&secrets_source=secrets_management
191191
[8]: /api/latest/observability-pipelines/#update-a-pipeline
192192
[9]: /observability_pipelines/guide/environment_variables/
193193
[10]: https://registry.terraform.io/providers/DataDog/datadog/latest/docs
194194
[11]: /observability_pipelines/configuration/update_existing_pipelines/?
195195
[12]: /observability_pipelines/configuration/install_the_worker/
196196
[13]: /monitors/types/metric/
197197
[14]: /observability_pipelines/configuration/export_pipeline_configuration/
198+
[16]: /observability_pipelines/configuration/install_the_worker/?interface=terraform&platform=docker&secrets_source=secrets_management

content/en/observability_pipelines/guide/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ disable_toc: false
55

66
{{< whatsnext desc="General guides:" >}}
77
{{< nextlink href="observability_pipelines/guide/strategies_for_reducing_log_volume" >}}Strategies for reducing log volume{{< /nextlink >}}
8-
{{< nextlink href="observability_pipelines/guide/set_up_the_worker_in_ecs_fargate" >}}Set up the Worker in ECS Fargate{{< /nextlink >}}
98
{{< nextlink href="observability_pipelines/guide/environment_variables" >}}Environment variables for sources, processors, and destinations{{< /nextlink >}}
109
{{< nextlink href="/byoc-logs/guides/send_otel_logs_observability_pipelines" >}}Send OpenTelemetry logs to BYOC Logs with Observability Pipelines{{< /nextlink >}}
1110
{{< /whatsnext >}}

content/en/observability_pipelines/guide/set_up_the_worker_in_ecs_fargate.md

Lines changed: 0 additions & 117 deletions
This file was deleted.

content/en/observability_pipelines/guide/upgrade_worker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ Worker version 2.7.0 gives you access to the following:
453453
[34]: /observability_pipelines/destinations/datadog_metrics/?tab=secretsmanagement
454454
[35]: /observability_pipelines/processors/filter/?tab=metrics
455455
[36]: /observability_pipelines/processors/tag_control/metrics
456-
[37]: /observability_pipelines/configuration/install_the_worker/?tab=kubernetes#upgrade-the-worker
456+
[37]: /observability_pipelines/configuration/install_the_worker/?interface=ui&platform=kubernetes&secrets_source=secrets_management#upgrade-the-worker
457457
[38]: https://hub.docker.com/r/datadog/observability-pipelines-worker/tags?name=2.14.0
458458
[39]: https://hub.docker.com/r/datadog/observability-pipelines-worker/tags?name=2.13.2
459459
[40]: https://hub.docker.com/r/datadog/observability-pipelines-worker/tags?name=2.15.0

content/en/observability_pipelines/sources/cloudflare_logpush.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ After your Logpush job has been successfully created, you can view your Cloudfla
8787
[1]: https://www.cloudflare.com/en-in/ips/
8888
[2]: https://app.datadoghq.com/observability-pipelines
8989
[3]: /observability_pipelines/sources/http_server/?tab=secretsmanagement#secret-defaults
90-
[4]: /observability_pipelines/configuration/install_the_worker/?tab=docker#pipeline-ui-setup
90+
[4]: /observability_pipelines/configuration/install_the_worker/
9191
[5]: https://developers.cloudflare.com/logs/logpush/logpush-job/enable-destinations/http/
9292
[6]: https://app.datadoghq.com/logs
9393
[7]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/

0 commit comments

Comments
 (0)