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.

Table of Contents

Consul Plugin

Consul: ConsulStep

  • installationName : String
  • consulSettingsProfileName : String
  • operationList (optional)
      Array / List of Nested Choice of Objects
    • $class: 'ConsulGetKV'
      • valuePath : String
        Consul path for the required value.
        e.g. mysql/config/users/admin
      • environmentVariableName : String
        Environment variable name for the value.
    • $class: 'ConsulServiceDiscoveryOperation'
      • serviceName : String
        Service name to look in consul
      • serviceTag : String
        Service tag - leave empty for no tag filtering.
      • environmentVariableName : String
        Environment variable name for the response.
        Leave empty to use the same name of the service.
      • healthStatus : String
        Service health status.
      • addPort : boolean
        Add port number to response?
        The port will be added for every ip address - {ip}:{port}
    • $class: 'ConsulSetKV'
      • valuePath : String
        Consul path to set with your value.
        e.g. mysql/config/users/admin
      • value : String
        Value or ENV var name to use.

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.