
x-service-discovery-backend-consul.4.0.0-milestone4.source-code.consul-backend.adoc Maven / Gradle / Ivy
=== Consul backend
The service discovery has a plug-able backend using the {@link io.vertx.servicediscovery.spi.ServiceDiscoveryBackend} SPI. This is an implementation of the SPI based
on Consul.
==== Using the Consul backend
To use the Consul backend, add the following dependency to the _dependencies_ section of your build
descriptor:
* Maven (in your `pom.xml`):
[source,xml,subs="+attributes"]
----
io.vertx
vertx-service-discovery-backend-consul
${maven.version}
----
* Gradle (in your `build.gradle` file):
[source,groovy,subs="+attributes"]
----
compile 'io.vertx:vertx-service-discovery-backend-consul:${maven.version}'
----
Be aware that you can have only a single implementation of the SPI in your _classpath_. If none,
the default backend is used.
==== Configuration
The backend is based on the http://vertx.io/docs/vertx-consul-client/java[vertx-consul-client].
The configuration is the client configuration.
Here is an example:
[source,$lang]
----
{@link examples.ServiceDiscoveryBackendConsulExamples#configuration1(io.vertx.core.Vertx)}
----