diff --git a/docs/src/main/asciidoc/spring-cloud-zookeeper.adoc b/docs/src/main/asciidoc/spring-cloud-zookeeper.adoc index 1a2afe1e..ef3d7d7f 100644 --- a/docs/src/main/asciidoc/spring-cloud-zookeeper.adoc +++ b/docs/src/main/asciidoc/spring-cloud-zookeeper.adoc @@ -14,6 +14,54 @@ include::intro.adoc[] See the http://zookeeper.apache.org/doc/current/zookeeperStarted.html[installation documentation] for instructions on how to install Zookeeper. +Spring Cloud Zookeeper uses Apache Curator behind the scenes. +While Zookeeper 3.5.x is still considered "beta" by the Zookeeper development team, +the reality is that it is used in production by many users. +However, Zookeeper 3.4.x is also used in production. +Prior to Apache Curator 4.0, both versions of Zookeeper were supported via two versions of Apache Curator. +Starting with Curator 4.0 both versions of Zookeeper are supported via the same Curator libraries. + +In case you are integrating with version 3.4 you need to change the Zookeeper dependency +that comes shipped with `curator`, and thus `spring-cloud-zookeeper`. +To do so simply exclude that dependency and add the 3.4.x version like shown below. + +.maven +[source,xml,indent=0] +---- + + org.springframework.cloud + spring-cloud-starter-zookeeper-all + + + org.apache.zookeeper + zookeeper + + + + + org.apache.zookeeper + zookeeper + 3.4.12 + + + org.slf4j + slf4j-log4j12 + + + +---- + +.gradle +[source,groovy,indent=0] +---- +compile('org.springframework.cloud:spring-cloud-starter-zookeeper-all') { + exclude group: 'org.apache.zookeeper', module: 'zookeeper' +} +compile('org.apache.zookeeper:zookeeper:3.4.12') { + exclude group: 'org.slf4j', module: 'slf4j-log4j12' +} +---- + [[spring-cloud-zookeeper-discovery]] == Service Discovery with Zookeeper @@ -33,6 +81,9 @@ autoconfiguration that sets up Spring Cloud Zookeeper Discovery. NOTE: For web functionality, you still need to include `org.springframework.boot:spring-boot-starter-web`. +CAUTION: When working with version 3.4 of Zookeeper you need to change +the way you include the dependency as described <>. + === Registering with Zookeeper When a client registers with Zookeeper, it provides metadata (such as host and port, ID, @@ -471,6 +522,9 @@ Including a dependency on `org.springframework.cloud:spring-cloud-starter-zookeeper-config` enables autoconfiguration that sets up Spring Cloud Zookeeper Config. +CAUTION: When working with version 3.4 of Zookeeper you need to change +the way you include the dependency as described <>. + === Customizing Zookeeper Config may be customized by setting the following properties: