8000 Synthetics Private locations: restructure install collapse section in… · DataDog/documentation@37f0a57 · GitHub
[go: up one dir, main page]
Skip to content

Commit 37f0a57

Browse files
aliciascottdrichards-87
aliciascott
and
drichards-87
authored
Synthetics Private locations: restructure install collapse section into tabs (#29327)
* convert from collapse to tabs yay * fix links in tabs * Update content/en/synthetics/platform/private_locations/_index.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> --------- Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
1 parent e410e48 commit 37f0a57

File tree

1 file changed

+37
-28
lines changed
  • content/en/synthetics/platform/private_locations

1 file changed

+37
-28
lines changed

‎content/en/synthetics/platform/private_locations/_index.md

Lines changed: 37 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,8 @@ You can use `DATADOG_API_KEY`, `DATADOG_ACCESS_KEY`, `DATADOG_SECRET_ACCESS_KEY`
229229

230230
Launch your private location on:
231231

232-
{{% collapse-content title="Docker" level="h4" expanded=false %}}
232+
{{< tabs >}}
233+
{{% tab "Docker" %}}
233234

234235
Run this command to boot your private location worker by mounting your configuration file to the container. Ensure that your `<MY_WORKER_CONFIG_FILE_NAME>.json` file is in `/etc/docker`, not the root home folder:
235236

@@ -241,9 +242,11 @@ docker run -d --restart unless-stopped -v $PWD/<MY_WORKER_CONFIG_FILE_NAME>.json
241242

242243
This command starts a Docker container and makes your private location ready to run tests. **Datadog recommends running the container in detached mode with proper restart policy.**
243244

244-
{{% /collapse-content %}}
245+
[26]: https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities
245246

246-
{{% collapse-content title="Docker Compose" level="h4" expanded=false %}}
247+
{{< /tab >}}
248+
249+
{{% tab "Docker Compose" %}}
247250

248251
1. Create a `docker-compose.yml` file with:
249252

@@ -262,9 +265,11 @@ This command starts a Docker container and makes your private location ready to
262265
```shell
263266
docker-compose -f docker-compose.yml up
264267
```
265-
{{% /collapse-content %}}
268+
[26]: https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities
269+
270+
{{< /tab >}}
266271

267-
{{% collapse-content title="Podman" level="h4" expanded=false %}}
272+
{{% tab "Podman" %}}
268273
The Podman configuration is very similar to Docker, however, you must set `NET_RAW` as an additional capability to support ICMP tests.
269274

270275
1. Run `sysctl -w "net.ipv4.ping_group_range = 0 2147483647"` from the host where the container runs.
@@ -277,10 +282,9 @@ The Podman configuration is very similar to Docker, however, you must set `NET_R
277282
If you have configured blocked reserved IP addresses, add the `NET_ADMIN` Linux capabilities to your private location container.
278283

279284
This command starts a Podman container and makes your private location ready to run tests. Datadog recommends running the container in detached mode with proper restart policy.
280-
{{% /collapse-content %}}
285+
{{< /tab >}}
281286

282-
283-
{{% collapse-content title="Kubernetes Deployment" level="h4" expanded=false %}}
287+
{{% tab "Kubernetes Deployment" %}}
284288

285289
To deploy the private locations worker in a secure manner, set up and mount a Kubernetes Secret resource in the container under `/etc/datadog/synthetics-check-runner.json`.
286290

@@ -331,17 +335,17 @@ To deploy the private locations worker in a secure manner, set up and mount a Ku
331335

332336
For OpenShift, run the private location with the `anyuid` SCC. This is required for your browser test to run.
333337

334-
[1]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
338+
[26]: https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities
335339

336-
{{% /collapse-content %}}
340+
{{< /tab >}}
337341

338-
{{% collapse-content title="Helm Chart" level="h4" expanded=false %}}
342+
{{% tab "Helm Chart" %}}
339343

340344
You can set environment variables in your configuration parameters that point to secrets you have already configured. To create environment variables with secrets, see the [Kubernetes documentation][3].
341345

342346
Alternatively:
343347

344-
1. Add the [Datadog Synthetics Private Location][30] to your Helm repositories:
348+
1. Add the [Datadog Synthetics Private Location][2] to your Helm repositories:
345349

346350
```shell
347351
helm repo add datadog https://helm.datadoghq.com
@@ -356,12 +360,13 @@ Alternatively:
356360

357361
**Note:** If you have blocked reserved IPs, add the `NET_ADMIN` [Linux capabilities][26] to your private location container.
358362

359-
[2]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
363+
[2]: https://github.com/DataDog/helm-charts/tree/main/charts/synthetics-private-location
360364
[3]: https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#define-container-environment-variables-using-secret-data
365+
[26]: https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities
361366

362-
{{% /collapse-content %}}
367+
{{< /tab >}}
363368

364-
{{% collapse-content title="ECS" level="h4" expanded=false %}}
369+
{{% tab "ECS" %}}
365370

366371
Create a new EC2 task definition that matches the following. Replace each parameter with the corresponding value found in your previously generated private location configuration file:
367372

@@ -392,15 +397,16 @@ Create a new EC2 task definition that matches the following. Replace each parame
392397
...
393398
}
394399
```
395-
396400
**Notes:**
397401

398402
- If you have blocked reserved IPs, configure a [linuxParameters][31] to grant `NET_ADMIN` capabilities to your private location containers.
399403
- If you use the `DATADOG_API_KEY`, `DATADOG_ACCESS_KEY`, `DATADOG_SECRET_ACCESS_KEY`, `DATADOG_PUBLIC_KEY_PEM` and `DATADOG_PRIVATE_KEY` environment variables, you do not need to include them in the `"command": [ ]` section.
400404

401-
{{% /collapse-content %}}
405+
[31]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LinuxParameters.html
406+
407+
{{< /tab >}}
402408

403-
{{% collapse-content title="Fargate" level="h4" expanded=false %}}
409+
{{% tab "Fargate" %}}
404410

405411
Create a new Fargate task definition that matches the following. Replace each parameter with the corresponding value found in your previously generated private location configuration file:
406412

@@ -435,9 +441,9 @@ Create a new Fargate task definition that matches the following. Replace each pa
435441

436442
**Note:** Because the private location firewall option is not supported on AWS Fargate, the `enableDefaultBlockedIpRanges` parameter cannot be set to `true`.
437443

438-
{{% /collapse-content %}}
444+
{{< /tab >}}
439445

440-
{{% collapse-content title="Fargate with AWS Secret Manager" level="h4" expanded=false %}}
446+
{{% tab "Fargate with AWS Secret Manager" %}}
441447

442448
Create a secret in AWS secret manager to store all or part of the previously generated private location configuration. Keep in mind that the `publicKey` cannot be kept as it is in the configuration file. For example:
443449

@@ -522,9 +528,11 @@ If you didn't save all the configuration in the secret manager, you can still pa
522528

523529
**Note:** Because the private location firewall option is not supported on AWS Fargate, the `enableDefaultBlockedIpRanges` parameter cannot be set to `true`.
524530

525-
{{% /collapse-content %}}
531+
[25]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-tutorial.html
532+
533+
{{< /tab >}}
526534

527-
{{% collapse-content title="EKS" level="h4" expanded=false %}}
535+
{{% tab "EKS" %}}
528536

529537
Because Datadog already integrates with Kubernetes and AWS, it is ready-made to monitor EKS.
530538

@@ -573,11 +581,11 @@ Because Datadog already integrates with Kubernetes and AWS, it is ready-made to
573581
kubectl apply -f private-location-worker-deployment.yaml
574582
```
575583

576-
[1]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
584+
[26]: https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities
577585

578-
{{% /collapse-content %}}
586+
{{< /tab >}}
579587

580-
{{% collapse-content title="Windows via GUI" level="h4" expanded=false %}}
588+
{{% tab "Windows via GUI" %}}
581589

582590
1. Download the [`datadog-synthetics-worker-{{< synthetics-worker-version "synthetics-windows-pl" >}}.amd64.msi` file][101] and run this file from the machine you want to install the private location on.
583591
1. Click **Next** on the welcome page, read the EULA, and accept the terms and conditions. Click **Next**.
@@ -617,9 +625,9 @@ Once the process is complete, click **Finish** on the installation completion pa
617625
[101]: https://ddsynthetics-windows.s3.amazonaws.com/datadog-synthetics-worker-{{< synthetics-worker-version "synthetics-windows-pl" >}}.amd64.msi
618626
[102]: https://app.datadoghq.com/synthetics/settings/private-locations
619627

620-
{{% /collapse-content %}}
628+
{{< /tab >}}
621629

622-
{{% collapse-content title="Windows via CLI" level="h4" expanded=false %}}
630+
{{% tab "Windows via CLI" %}}
623631

624632
1. Download the [`datadog-synthetics-worker-{{< synthetics-worker-version "synthetics-windows-pl" >}}.amd64.msi` file][101] and run this file from the machine you want to install the private location on.
625633
2. Run one of the following commands inside the directory where you downloaded the installer:
@@ -649,7 +657,8 @@ Additional parameters can be added:
649657

650658
[101]: https://ddsynthetics-windows.s3.amazonaws.com/datadog-synthetics-worker-{{< synthetics-worker-version "synthetics-windows-pl" >}}.amd64.msi
651659

652-
{{% /collapse-content %}}
660+
{{< /tab >}}
661+
{{< /tabs >}}
653662

654663
For more information about private locations parameters for admins, see [Configuration][32].
655664

0 commit comments

Comments
 (0)
0