> 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.

Table of Contents

Consul Plugin

View this plugin on the Plugins site

Consul: ConsulStep

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