CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add generic secret store usage (#13400)

This commit is contained in:
Joshua Powers 2023-06-07 09:25:54 -06:00 committed by GitHub
parent 820fa1e311
commit db84ef4667
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/includes/secret_usage.md Normal file
View File

@ -0,0 +1,7 @@
Secrets defined by a store are referenced with `@{<store-id>:<secret_key>}`
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.

10
plugins/secretstores/docker/README.md
View File

@ -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. > NOTE: This plugin can ONLY read the mounted secrets from Docker and NOT set them.
## Usage <!-- @/docs/includes/secret_usage.md -->
Secrets defined by a store are referenced with `@{<store-id>:<secret_key>}`
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 ## Configuration
```toml @sample.conf ```toml @sample.conf

10
plugins/secretstores/http/README.md
View File

@ -11,6 +11,16 @@ telegraf secrets help
to get more information on how to do this. to get more information on how to do this.
## Usage <!-- @/docs/includes/secret_usage.md -->
Secrets defined by a store are referenced with `@{<store-id>:<secret_key>}`
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 ## Configuration
```toml @sample.conf ```toml @sample.conf

10
plugins/secretstores/jose/README.md
View File

@ -11,6 +11,16 @@ telegraf secrets help
to get more information on how to do this. to get more information on how to do this.
## Usage <!-- @/docs/includes/secret_usage.md -->
Secrets defined by a store are referenced with `@{<store-id>:<secret_key>}`
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 ## Configuration
```toml @sample.conf ```toml @sample.conf

10
plugins/secretstores/os/README.md
View File

@ -13,6 +13,16 @@ telegraf secrets help
to get more information on how to do this with Telegraf. to get more information on how to do this with Telegraf.
## Usage <!-- @/docs/includes/secret_usage.md -->
Secrets defined by a store are referenced with `@{<store-id>:<secret_key>}`
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 ## Configuration
The configuration differs slightly depending on the Operating System. We first The configuration differs slightly depending on the Operating System. We first