On This Page

Home / Stream/ Reference/ Config Files/secrets.yml

secrets.yml

secrets.yml stores secrets for Cribl Stream.

The secrets are decrypted and encrypted using a cribl.secret file. cribl.secret is unique per Worker Group and resides in the $CRIBL_HOME/groups/<groupName>/local/cribl/auth directory on Leader nodes, or in $CRIBL_HOME/local/cribl/auth for Workers or single-instance deployments.

Cribl automatically decrypts plaintext secrets from secrets.yml on startup and stores them in memory, keeping your data secure.

<secret-id>:
  secretType: # [string] One of: keypair | text | credentials
  secrets: # [object] 

  # -------------- if secretType is text ---------------

    value: # [string] Value

  # --------------------------------------------------------


  # -------------- if secretType is keypair ---------------

    apiKey: # [string] API key
    secretKey: # [string] [required] Secret key

  # --------------------------------------------------------


  # -------------- if secretType is credentials ---------------

    username: # [string] Username
    password: # [string] [required] Password

  # --------------------------------------------------------

  description: # [string] Description
  tags: # [string] Tags - One or more tags related to this secret