Documentation

telegraf secrets set

The telegraf secrets set command creates or modify a secret in a specified secret store.

This command requires your configuration file that contains the secret store definitions you want to access. If the --config or --config-directory flags are not included in the command, Telegraf checks the default configuration file location.

Use telegraf secrets list to get the IDs of available secret stores and the available secret keys.

If you haven’t configured a secret store, use telegraf plugins secretstores to list available secret store plugins. View secret store plugin configuration documentation in the Telegraf GitHub repository.

Usage

telegraf [global-flags] secrets set [flags] <SECRET_STORE_ID> <SECRET_KEY> <SECRET_VALUE>

Arguments

ArgumentDescription
SECRET_STORE_IDID of the secret store to set the secret in
SECRET_KEYKey of the secret to set
SECRET_VALUEValue of the secret to set

Flags

FlagDescription
-h--helpShow command help

Examples

In the examples below, replace the following:

  • SECRET_STORE_ID: The ID of the secret store to store the secret in.
  • SECRET_KEY: The key of the secret to set.
  • SECRET_VALUE: The value of the secret to set.
  • CUSTOM_CONFIG_PATH: The non-default filepath to your Telegraf configuration file containing your secret store definitions.

Set a secret using the default configuration location

The following example assumes the Telegraf configuration file that contains the secret store definition is at the default location.

telegraf secrets set 
SECRET_STORE_ID
SECRET_KEY
SECRET_VALUE

Set a secret using a non-default configuration location

telegraf \
  --config 
CUSTOM_CONFIG_PATH
\
secrets set \
SECRET_STORE_ID
\
SECRET_KEY
\
SECRET_VALUE

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: