The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

HashiCorp Vault Plugin

withVault: Vault Plugin

  • vaultSecrets
      Array/List
      Nested Object
    • path
      The path of the secret in the vault server as described here.
      • Type: String
    • secretValues
        Array/List
        Nested Object
      • vaultKey
        The vault key whose value with populate the environment variable.
        • Type: String
      • envVar (optional)
        The environment variable to set with the value of the vault key.
        If field is left empty. The value from vault key will be used for environment variable.
        • Type: String
    • engineVersion (optional)
      The vault K/V engine version. Currently supports versions 1 or 2. (Only applicable when using vaults Key/Value secrets engine. See here)
      If set to default it will use what is configured on folder or global configuration.
      • Type: int
  • configuration (optional)
      Nested Object
    • engineVersion (optional)
      The vault K/V engine version. Currently supports versions 1 or 2. (Only applicable when using vaults Key/Value secrets engine. See here)
      If set to default it will use what is configured on folder or global configuration.
      • Type: int
    • failIfNotFound (optional)
      • Type: boolean
    • skipSslVerification (optional)
      • Type: boolean
    • vaultCredentialId (optional)
      • Type: String
    • vaultUrl (optional)
      • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.