From db84ef4667e9b0299b07e4bb6df1779a8a7cef06 Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Wed, 7 Jun 2023 09:25:54 -0600 Subject: [PATCH] docs: Add generic secret store usage (#13400) --- docs/includes/secret_usage.md | 7 +++++++ plugins/secretstores/docker/README.md | 10 ++++++++++ plugins/secretstores/http/README.md | 10 ++++++++++ plugins/secretstores/jose/README.md | 10 ++++++++++ plugins/secretstores/os/README.md | 10 ++++++++++ 5 files changed, 47 insertions(+) create mode 100644 docs/includes/secret_usage.md diff --git a/docs/includes/secret_usage.md b/docs/includes/secret_usage.md new file mode 100644 index 000000000..6738a5741 --- /dev/null +++ b/docs/includes/secret_usage.md @@ -0,0 +1,7 @@ +Secrets defined by a store are referenced with `@{:}` +the Telegraf configuration. Only certain Telegraf plugins and options of +support secret stores. To see which plugins and options support +secrets, see their respective documentation (e.g. +`plugins/outputs/influxdb/README.md`). If the plugin's README has the +`Secret-store support` section, it will detail which options support secret +store usage. diff --git a/plugins/secretstores/docker/README.md b/plugins/secretstores/docker/README.md index eee30d73e..8afce0cb6 100644 --- a/plugins/secretstores/docker/README.md +++ b/plugins/secretstores/docker/README.md @@ -6,6 +6,16 @@ under the `/run/secrets` directory within the container. > NOTE: This plugin can ONLY read the mounted secrets from Docker and NOT set them. +## Usage + +Secrets defined by a store are referenced with `@{:}` +the Telegraf configuration. Only certain Telegraf plugins and options of +support secret stores. To see which plugins and options support +secrets, see their respective documentation (e.g. +`plugins/outputs/influxdb/README.md`). If the plugin's README has the +`Secret-store support` section, it will detail which options support secret +store usage. + ## Configuration ```toml @sample.conf diff --git a/plugins/secretstores/http/README.md b/plugins/secretstores/http/README.md index 47b7aef4a..baf98a043 100644 --- a/plugins/secretstores/http/README.md +++ b/plugins/secretstores/http/README.md @@ -11,6 +11,16 @@ telegraf secrets help to get more information on how to do this. +## Usage + +Secrets defined by a store are referenced with `@{:}` +the Telegraf configuration. Only certain Telegraf plugins and options of +support secret stores. To see which plugins and options support +secrets, see their respective documentation (e.g. +`plugins/outputs/influxdb/README.md`). If the plugin's README has the +`Secret-store support` section, it will detail which options support secret +store usage. + ## Configuration ```toml @sample.conf diff --git a/plugins/secretstores/jose/README.md b/plugins/secretstores/jose/README.md index 15ff7394b..6420e0275 100644 --- a/plugins/secretstores/jose/README.md +++ b/plugins/secretstores/jose/README.md @@ -11,6 +11,16 @@ telegraf secrets help to get more information on how to do this. +## Usage + +Secrets defined by a store are referenced with `@{:}` +the Telegraf configuration. Only certain Telegraf plugins and options of +support secret stores. To see which plugins and options support +secrets, see their respective documentation (e.g. +`plugins/outputs/influxdb/README.md`). If the plugin's README has the +`Secret-store support` section, it will detail which options support secret +store usage. + ## Configuration ```toml @sample.conf diff --git a/plugins/secretstores/os/README.md b/plugins/secretstores/os/README.md index 883782ce6..daa678dba 100644 --- a/plugins/secretstores/os/README.md +++ b/plugins/secretstores/os/README.md @@ -13,6 +13,16 @@ telegraf secrets help to get more information on how to do this with Telegraf. +## Usage + +Secrets defined by a store are referenced with `@{:}` +the Telegraf configuration. Only certain Telegraf plugins and options of +support secret stores. To see which plugins and options support +secrets, see their respective documentation (e.g. +`plugins/outputs/influxdb/README.md`). If the plugin's README has the +`Secret-store support` section, it will detail which options support secret +store usage. + ## Configuration The configuration differs slightly depending on the Operating System. We first