You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by na...@apache.org on 2022/05/05 16:11:40 UTC

[ignite] branch ignite-2.13 updated: IGNITE-16239 Document ZooKeeper IP finder extension (#10013)

This is an automated email from the ASF dual-hosted git repository.

namelchev pushed a commit to branch ignite-2.13
in repository https://gitbox.apache.org/repos/asf/ignite.git


The following commit(s) were added to refs/heads/ignite-2.13 by this push:
     new 44c51b15c41 IGNITE-16239 Document ZooKeeper IP finder extension (#10013)
44c51b15c41 is described below

commit 44c51b15c417c0d81209644b79c095f7528052d6
Author: Nikita Amelchev <ns...@gmail.com>
AuthorDate: Thu May 5 19:09:35 2022 +0300

    IGNITE-16239 Document ZooKeeper IP finder extension (#10013)
---
 docs/_data/toc.yaml                                |  2 +
 docs/_docs/clustering/tcp-ip-discovery.adoc        | 37 +------------
 .../zookeeper-ip-finder-ext.adoc                   | 63 ++++++++++++++++++++++
 3 files changed, 67 insertions(+), 35 deletions(-)

diff --git a/docs/_data/toc.yaml b/docs/_data/toc.yaml
index 1b8b2f08d3d..b3baa914270 100644
--- a/docs/_data/toc.yaml
+++ b/docs/_data/toc.yaml
@@ -557,6 +557,8 @@
       url: extensions-and-integrations/performance-statistics
     - title: Change Data Capture
       url: extensions-and-integrations/change-data-capture-extensions
+    - title: ZooKeeper IP Finder
+      url: extensions-and-integrations/zookeeper-ip-finder-ext
 - title: Plugins
   url: plugins
 - title: Performance and Troubleshooting
diff --git a/docs/_docs/clustering/tcp-ip-discovery.adoc b/docs/_docs/clustering/tcp-ip-discovery.adoc
index 44fdd5319a2..51a4e5600c7 100644
--- a/docs/_docs/clustering/tcp-ip-discovery.adoc
+++ b/docs/_docs/clustering/tcp-ip-discovery.adoc
@@ -389,38 +389,5 @@ tab:C++[unsupported]
 
 NOTE: Not supported in .NET/C#.
 
-To set up ZooKeeper IP finder use `TcpDiscoveryZookeeperIpFinder` (note that `ignite-zookeeper` module has to be enabled).
-
-[tabs]
---
-tab:XML[]
-[source,xml]
-----
-<bean class="org.apache.ignite.configuration.IgniteConfiguration">
-
-    <property name="discoverySpi">
-        <bean class="org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi">
-            <property name="ipFinder">
-                <bean class="org.apache.ignite.spi.discovery.tcp.ipfinder.zk.TcpDiscoveryZookeeperIpFinder">
-                    <property name="zkConnectionString" value="127.0.0.1:2181"/>
-                </bean>
-            </property>
-        </bean>
-    </property>
-</bean>
-----
-
-tab:Java[]
-[source,java]
-----
-include::{javaFile}[tag=zk,indent=0]
-----
-
-tab:C#/.NET[unsupported]
-tab:C++[unsupported]
-
---
-
-
-
-
+The link:extensions-and-integrations/zookeeper-ip-finder-ext[Apache Ignite ZooKeeper Ip Finder] extension provides
+a TCP Discovery IP Finder that uses a ZooKeeper directory to locate other Ignite nodes to connect to.
diff --git a/docs/_docs/extensions-and-integrations/zookeeper-ip-finder-ext.adoc b/docs/_docs/extensions-and-integrations/zookeeper-ip-finder-ext.adoc
new file mode 100644
index 00000000000..96544902447
--- /dev/null
+++ b/docs/_docs/extensions-and-integrations/zookeeper-ip-finder-ext.adoc
@@ -0,0 +1,63 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+= ZooKeeper IP Finder Extension
+
+:javaFile: {javaCodeDir}/TcpIpDiscovery.java
+
+NOTE: Not supported in .NET/C#.
+
+Apache Ignite ZooKeeper Ip Finder module provides a TCP Discovery IP Finder that uses a ZooKeeper
+directory to locate other Ignite nodes to connect to.
+
+== Install
+
+Depending on how you use Ignite, you can an extension using one of the following methods:
+
+- If you use the binary distribution, move the `ignite-zookeeper-ip-finder-ext` to the `lib` directory before starting the node.
+- Add libraries from `ignite-zookeeper-ip-finder-ext` to the classpath of your application.
+- Add a module as a Maven dependency to your project.
+
+== Configuration
+
+To set up ZooKeeper IP finder use `TcpDiscoveryZookeeperIpFinder`:
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
+----
+<bean class="org.apache.ignite.configuration.IgniteConfiguration">
+    <property name="discoverySpi">
+        <bean class="org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi">
+            <property name="ipFinder">
+                <bean class="org.apache.ignite.spi.discovery.tcp.ipfinder.zk.TcpDiscoveryZookeeperIpFinder">
+                    <property name="zkConnectionString" value="127.0.0.1:2181"/>
+                </bean>
+            </property>
+        </bean>
+    </property>
+</bean>
+----
+tab:Java[]
+[source,java]
+----
+include::{javaFile}[tag=zk,indent=0]
+----
+tab:C#/.NET[unsupported]
+tab:C++[unsupported]
+--
+
+The module depends on third-party libraries that use the slf4j facade for logging.
+You can set up an underlying logging framework yourself.
\ No newline at end of file