> User Documentation Home

User Handbook
Tutorials
Resources

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.

Consul KV Builder

View this plugin on the Plugins site

step([$class: 'ConsulKVBuilder']): Consul K/V Builder

  • hostUrl
    Host URL should contain protocol (HTTP/HTTPS)://<HOST_NAME>.
    • Type: String
  • key
    Key is used in GET/PUT requests to lookup the value from, or right the key/value pair to the Consul key/value store.
    • Type: String
  • aclToken (optional)
    Token is used to supply UUID token for Consul ACL token calls. Token can be supplied by build parameters.
    • Type: String
  • apiUri (optional)
    URL Override is used to override the K,V API URL.
    • Type: String
  • debugMode (optional)
    Enable Debug messages for more verbose logging.
    • Values: ENABLED, DISABLED
  • envVarKey (optional)
    ENV Varaible Key is used to store the retrieved value in the build ENV variables to be used downstream.
    • Type: String
  • ignoreGlobalSettings (optional)
    • Type: boolean
  • keyValue (optional)
    Value is used in PUT calls to insert/update a key/value pair.
    • Type: String
  • requestMode (optional)
    Request Mode set to READ will execute a GET to lookup the value, WRITE will execute a PUT to insert/update the value.
    • Values: READ, WRITE, DELETE
  • timeoutConnection (optional)
    Connection timeout in milliseconds, default is 10000.
    • Type: int
  • timeoutResponse (optional)
    Response timeout in milliseconds, default is 30000.
    • Type: int

wrap([$class: 'ConsulKVReadWrapper']): Add Consul K/V Read Config(s)

  • reads
      Array / List of Nested Object
    • aclToken
      Token is used to supply UUID token for Consul ACL token calls. Token can be supplied by build parameters.
      • Type: String
    • hostUrl
      Host URL should contain protocol (HTTP/HTTPS)://<HOST_NAME>.
      • Type: String
    • key
      Key is used in GET/PUT requests to lookup the value from, or right the key/value pair to the Consul key/value store.
      • Type: String
    • envKey
      ENV Varaible Key is used to store the retrieved value in the build ENV variables to be used downstream.
      • Type: String
    • apiUri (optional)
      URL Override is used to override the K,V API URL.
      • Type: String
    • debugMode (optional)
      Enable Debug messages for more verbose logging.
      • Values: ENABLED, DISABLED
    • ignoreGlobalSettings (optional)
      • Type: boolean
    • timeoutConnect (optional)
      Connection timeout in milliseconds, default is 10000.
      • Type: int
    • timeoutResponse (optional)
      Response timeout in milliseconds, default is 30000.
      • Type: int

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.