SpringCloud/spring-cloud-zookeeper
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation: note in case you're working with Zookeeper 3.4.x (#171)

Browse Source 
* Added a warning to the documentation to point out that you need to change the way you include `spring-cloud-zookeeper` in case you're working with Zookeeper version 3.4.x

* Added an explanation why you should change the ZooKeeper dependency
This commit is contained in:
Tim Ysewyn
2018-06-11 20:56:12 +02:00
committed by Spencer Gibb
parent dda9d07209
commit a97356c429
1 changed files with 54 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/src/main/asciidoc/spring-cloud-zookeeper.adoc
View File

@@ -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]
----
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zookeeper-all</artifactId>
<exclusions>
<exclusion>
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper</artifactId>
<version>3.4.12</version>
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</exclusion>
</exclusions>
</dependency>
----
.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 <<spring-cloud-zookeeper-install,here>>.
=== 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 <<spring-cloud-zookeeper-install,here>>.
=== Customizing
Zookeeper Config may be customized by setting the following properties: