Package io.vertx.config.consul Description
=== Consul Configuration Store
The Consul Configuration Store extends the Vert.x Configuration Retriever and provides the
way to retrieve configuration from a https://www.consul.io[Consul].
==== Using the Consul Configuration Store
To use the Consul Configuration Store, add the following dependency to the
_dependencies_ section of your build descriptor:
* Maven (in your `pom.xml`):
[source,xml,subs="+attributes"]
----
${maven.groupId}
${maven.artifactId}
${maven.version}
${maven.groupId}
vertx-config
${maven.version}
----
* Gradle (in your `build.gradle` file):
[source,groovy,subs="+attributes"]
----
compile '${maven.groupId}:vertx-config:${maven.version}'
compile '${maven.groupId}:${maven.artifactId}:${maven.version}'
----
==== Configuring the store
Once added to your classpath or dependencies, you need to configure the
ConfigRetriever to use this store:
[source, $lang]
----
examples.Examples#example1(io.vertx.core.Vertx)
----
The store configuration is used to create an instance of
ConsulClient. Check the documentation of the Vert.x Consul Client
for further details. And this is the parameters specific to the Consul Configuration Store:
`prefix`:: A prefix that will not be taken into account when building the configuration tree. Defaults to empty.
`delimiter`:: Symbol that used to split keys in the Consul storage to obtain levels in the configuration tree. Defaults to "/".