Consul Configuration Provider

The Consul config provider reads settings from the KV version 1 consul plugin. It currently supports two separate read paths: default and service-specific. These read paths are expected to exist directly under the KV mount point.

The provider will, by default, load KV settings from the following locations:

  • userviceconfiguration/defaultapplication - default settings
  • userviceconfiguration/${info.app.name} - service-specific settings

Provider Configuration

KeyDefaultRequiredDescription
spring.cloud.consul.config.enabledfalseOptionalEnable loading configuration from consul KV
spring.cloud.consul.config.disconnectedfalseOptionalActivate "disconnected" mode for CLI commands
spring.cloud.consul.config.prefixuserviceconfigurationOptionalConsul KV mount point
spring.cloud.consul.config.default-contextdefaultapplicationOptionalKV folder path under mount point containing global settings
spring.cloud.consul.config.poolfalseOptionalPool consul connections
spring.cloud.consul.config.delay3sOptionalRetry delay after KV setting retrieval failure
spring.cloud.consul.config.required- ${spring.cloud.consul.config.prefix}/${spring.cloud.consul.config.default-context}OptionalKV settings paths that must return KV values