Skip to content

Commit c5c7bdb

Browse files
authored
DOCS-10224 added an example to securely pass API key (#19760)
1 parent 69b7735 commit c5c7bdb

File tree

1 file changed

+169
-0
lines changed

1 file changed

+169
-0
lines changed

ecs_fargate/README.md

+169
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,175 @@ partial -->
497497
{{< /site-region >}}
498498
partial -->
499499

500+
{{% collapse-content title="Example using secretOptions to avoid exposing the API Key in plain text" level="h4" %}}
501+
<!-- partial
502+
{{< site-region region="us" >}}
503+
```json
504+
{
505+
"logConfiguration": {
506+
"logDriver": "awsfirelens",
507+
"options": {
508+
"Name": "datadog",
509+
"Host": "http-intake.logs.datadoghq.com",
510+
"dd_service": "firelens-test",
511+
"dd_source": "redis",
512+
"dd_message_key": "log",
513+
"dd_tags": "project:fluentbit",
514+
"TLS": "on",
515+
"provider": "ecs"
516+
},
517+
"secretOptions": [
518+
{
519+
"name": "apikey",
520+
"valueFrom": "<API_SECRET_ARN>"
521+
}
522+
]
523+
}
524+
}
525+
```
526+
{{< /site-region >}}
527+
partial -->
528+
<!-- partial
529+
{{< site-region region="us3" >}}
530+
```json
531+
{
532+
"logConfiguration": {
533+
"logDriver": "awsfirelens",
534+
"options": {
535+
"Name": "datadog",
536+
"Host": "http-intake.logs.us3.datadoghq.com",
537+
"dd_service": "firelens-test",
538+
"dd_source": "redis",
539+
"dd_message_key": "log",
540+
"dd_tags": "project:fluentbit",
541+
"TLS": "on",
542+
"provider": "ecs"
543+
},
544+
"secretOptions": [
545+
{
546+
"name": "apikey",
547+
"valueFrom": "<API_SECRET_ARN>"
548+
}
549+
]
550+
}
551+
}
552+
```
553+
{{< /site-region >}}
554+
partial -->
555+
<!-- partial
556+
{{< site-region region="us5" >}}
557+
```json
558+
{
559+
"logConfiguration": {
560+
"logDriver": "awsfirelens",
561+
"options": {
562+
"Name": "datadog",
563+
"Host": "http-intake.logs.us5.datadoghq.com",
564+
"dd_service": "firelens-test",
565+
"dd_source": "redis",
566+
"dd_message_key": "log",
567+
"dd_tags": "project:fluentbit",
568+
"TLS": "on",
569+
"provider": "ecs"
570+
},
571+
"secretOptions": [
572+
{
573+
"name": "apikey",
574+
"valueFrom": "<API_SECRET_ARN>"
575+
}
576+
]
577+
}
578+
}
579+
```
580+
{{< /site-region >}}
581+
partial -->
582+
<!-- partial
583+
{{< site-region region="eu" >}}
584+
```json
585+
{
586+
"logConfiguration": {
587+
"logDriver": "awsfirelens",
588+
"options": {
589+
"Name": "datadog",
590+
"Host": "http-intake.logs.datadoghq.eu",
591+
"dd_service": "firelens-test",
592+
"dd_source": "redis",
593+
"dd_message_key": "log",
594+
"dd_tags": "project:fluentbit",
595+
"TLS": "on",
596+
"provider": "ecs"
597+
},
598+
"secretOptions": [
599+
{
600+
"name": "apikey",
601+
"valueFrom": "<API_SECRET_ARN>"
602+
}
603+
]
604+
}
605+
}
606+
```
607+
{{< /site-region >}}
608+
partial -->
609+
<!-- partial
610+
{{< site-region region="ap1" >}}
611+
```json
612+
{
613+
"logConfiguration": {
614+
"logDriver": "awsfirelens",
615+
"options": {
616+
"Name": "datadog",
617+
"Host": "http-intake.logs.ap1.datadoghq.com",
618+
"dd_service": "firelens-test",
619+
"dd_source": "redis",
620+
"dd_message_key": "log",
621+
"dd_tags": "project:fluentbit",
622+
"TLS": "on",
623+
"provider": "ecs"
624+
},
625+
"secretOptions": [
626+
{
627+
"name": "apikey",
628+
"valueFrom": "<API_SECRET_ARN>"
629+
}
630+
]
631+
}
632+
}
633+
```
634+
{{< /site-region >}}
635+
partial -->
636+
<!-- partial
637+
{{< site-region region="gov" >}}
638+
```json
639+
{
640+
"logConfiguration": {
641+
"logDriver": "awsfirelens",
642+
"options": {
643+
"Name": "datadog",
644+
"Host": "http-intake.logs.ddog-gov.datadoghq.com",
645+
"dd_service": "firelens-test",
646+
"dd_source": "redis",
647+
"dd_message_key": "log",
648+
"dd_tags": "project:fluentbit",
649+
"TLS": "on",
650+
"provider": "ecs"
651+
},
652+
"secretOptions": [
653+
{
654+
"name": "apikey",
655+
"valueFrom": "<API_SECRET_ARN>"
656+
}
657+
]
658+
}
659+
}
660+
```
661+
{{< /site-region >}}
662+
partial -->
663+
664+
665+
To provide your Datadog API key as a secret, see [Using secrets](#using-secrets).
666+
667+
{{% /collapse-content %}}
668+
500669
<!-- partial
501670
{{< site-region region="us,us3,us5,eu,ap1,gov" >}}
502671
**Note**: Set your `apikey` as well as the `Host` relative to your respective site `http-intake.logs.`{{< region-param key="dd_site" code="true" >}}. The full list of available parameters is described in the [Datadog Fluent Bit documentation][24].

0 commit comments

Comments
 (0)