Skip to content

Commit c142edf

Browse files
Rob-HazelcastRob-Hazelcast
authored
[EMGR-481] Remove vert.x Hazelcast Enterprise Module Reference (5.5) (#1724)
Backport #1721
1 parent a986aee commit c142edf

File tree

2 files changed

+7
-145
lines changed

2 files changed

+7
-145
lines changed

‎docs/modules/integrate/pages/get-started-with-vertx.adoc

Lines changed: 2 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -227,25 +227,7 @@ set-cookie: vertx-web.session=a1486c5ed6416972fdc356e4d91d2397; Path=/
227227
}
228228
----
229229

230-
We will fix that by using a Hazelcast Cluster Manager. There are two modules that provide Hazelcast Cluster Manager:
231-
232-
- `io.vertx:vertx-hazelcast` - this module is maintained by the Vert.x team, with contributions from Hazelcast, and is built on top of open-source Hazelcast
233-
- `com.hazelcast:vertx-hazelcast-enterprise` - this module is maintained by the Hazelcast team and is built on top of the `vertx-hazelcast` but uses Hazelcast Enterprise instead. You need an enterprise license to use Hazelcast Enterprise.
234-
235-
You can use either module for most of this tutorial. At the end of this tutorial you will need the `vertx-hazelcast-enterprise` module.
236-
237-
NOTE: You can get your trial key at https://hazelcast.com/get-started/?utm_source=docs-website[hazelcast.com] or you can use `vertx-hazelcast` and a community edition of Hazelcast.
238-
239-
Add the following dependency to the `pom.xml`:
240-
241-
[source,xml]
242-
----
243-
<dependency>
244-
<groupId>com.hazelcast</groupId>
245-
<artifactId>vertx-hazelcast-enterprise</artifactId>
246-
<version>{vertx.version}</version>
247-
</dependency>
248-
----
230+
We will fix that by using a Hazelcast Cluster Manager. This resides in the `io.vertx:vertx-hazelcast` module, which is maintained by the Vert.x team with contributions from Hazelcast and is based on Hazelcast {open-source-product-name}.
249231

250232
Change the following part of the `start` method:
251233

@@ -276,8 +258,6 @@ We also need to provide a Hazelcast configuration file, and create a file cluste
276258
xsi:schemaLocation="http://www.hazelcast.com/schema/config
277259
https://www.hazelcast.com/schema/config/hazelcast-config-5.5.xsd">
278260
279-
<license-key>replace/with/your/key</license-key> <!-- Only if using vertx-hazelcast-enterprise -->
280-
281261
<network>
282262
<join>
283263
<multicast enabled="true"/>
@@ -296,18 +276,6 @@ We also need to provide a Hazelcast configuration file, and create a file cluste
296276
<map name="__vertx.nodeInfo">
297277
<backup-count>1</backup-count>
298278
</map>
299-
300-
<cp-subsystem>
301-
<cp-member-count>0</cp-member-count>
302-
<semaphores>
303-
<semaphore>
304-
<name>__vertx.*</name>
305-
<jdk-compatible>false</jdk-compatible>
306-
<initial-permits>1</initial-permits>
307-
</semaphore>
308-
</semaphores>
309-
</cp-subsystem>
310-
</hazelcast>
311279
----
312280

313281
Now rebuild the project and start the application. You will see more verbose output as Hazelcast prints its own startup logs:
@@ -420,42 +388,4 @@ set-cookie: vertx-web.session=d9fb4cada5c0fc625089a38f3de13e3c; Path=/
420388
],
421389
"requestId": 1
422390
}
423-
----
424-
425-
== CP Subsystem backed Lock and Counter
426-
427-
The module `vertx-hazelcast-enterprise` provides a different implementation of the `io.vertx.core.shareddata.Counter` and `io.vertx.core.shareddata.Lock` data structures. The implementation in `vertx-hazelcast` is based on the IMap data structure and provides guarantees defined in the xref:architecture:data-partitioning.adoc#best-effort-consistency[Best-effort consistency] section. This means that under certain network partition conditions the counter doesn't provide strong consistency guarantees and can generate duplicate values.
428-
429-
The module `vertx-hazelcast-enterprise` uses the CP Subsystem from {enterprise-product-name} to implement the Lock and Counter.
430-
431-
NOTE: For the rest of this tutorial you need to have an {enterprise-product-name} license.
432-
433-
Make sure you have the following dependency:
434-
435-
[source,xml]
436-
----
437-
<dependency>
438-
<groupId>com.hazelcast</groupId>
439-
<artifactId>vertx-hazelcast-enterprise</artifactId>
440-
<version>{vertx.version}</version>
441-
</dependency>
442-
----
443-
444-
and your XML config contains a valid license key:
445-
446-
[source,xml]
447-
----
448-
...
449-
<license-key>replace/with/your/key</license-key>
450-
...
451-
----
452-
453-
Enable the CP subsystem, and in cluster.xml change the value of the `` property to `3`:
454-
455-
[source,xml]
456-
----
457-
<cp-member-count>3</cp-member-count>
458-
----
459-
460-
You need to start at least 3 instances for the cluster to form successfully. For complete documentation, see the xref:cp-subsystem:cp-subsystem.adoc[CP Subsystem] section.
461-
391+
----

‎docs/modules/integrate/pages/integrate-with-vertx.adoc

Lines changed: 5 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -13,66 +13,19 @@ In Vert.x a cluster manager is used for various functions including:
1313
- Distributed Locks
1414
- Distributed Counters
1515
16-
There are 2 modules to choose from:
17-
- `io.vertx:vertx-hazelcast` - this module is part of Vert.x and is maintained by the Vert.x team with contributions from Hazelcast developers. This module is licensed under the Apache 2 license.
18-
19-
- `com.hazelcast:vertx-hazelcast-enterprise` - this module is built on top of `vertx-hazelcast` and leverages functionality of {enterprise-product-name} to implement some of the cluster manager functionality (e.g. it uses the CP Subsystem to implement strongly consistent `io.vertx.core.shareddata.Lock` and `io.vertx.core.shareddata.Counter`).
20-
21-
== Using Vert.x Hazelcast Enterprise Cluster Manager
22-
[.enterprise]*Enterprise*
23-
24-
To use the Vert.x Hazelcast Enterprise Cluster Manager, add the following dependency to your Vert.x application:
25-
26-
[source,xml]
27-
----
28-
<dependency>
29-
<groupId>com.hazelcast</groupId>
30-
<artifactId>vertx-hazelcast-enterprise</artifactId>
31-
<version>5.0.0-SNAPSHOT</version>
32-
</dependency>
33-
----
34-
35-
The dependency is located in the Hazelcast private repository, and you need to add that as well:
36-
37-
[source,xml]
38-
----
39-
<repositories>
40-
<repository>
41-
<id>hazelcast-private-repository</id>
42-
<name>Hazelcast Private Repository</name>
43-
<url>https://repository.hazelcast.com/release/</url>
44-
</repository>
45-
</repositories>
46-
----
47-
48-
Alternatively, if you need to use a snapshot version:
49-
50-
[source,xml]
51-
----
52-
<repositories>
53-
<repository>
54-
<id>hazelcast-private-snapshot-repository</id>
55-
<name>Hazelcast Private Snapshot Repository</name>
56-
<url>https://repository.hazelcast.com/snapshot/</url>
57-
</repository>
58-
</repositories>
59-
----
16+
The `io.vertx:vertx-hazelcast` module is part of Vert.x and is maintained by the Vert.x team with contributions from Hazelcast. This module is licensed under the Apache 2 license.
6017

6118
To enable clustering, start your Vert.x application with the `-cluster` parameter.
6219

63-
=== Configuration
20+
== Configuration
6421

6522
Provide a file named `cluster.xml` on your classpath to configure a Hazelcast instance used by Vert.x.
6623

67-
To take advantage of the Lock and Counter data structures backed by the CP subsystem, you need to enable the xref:cp-subsystem:cp-subsystem.adoc[CP Subsytem].
68-
6924
For other configuration methods see the link:https://vertx.io/docs/vertx-hazelcast/java/#configcluster[Vert.x documentation].
7025

7126
=== Versioning and Hazelcast compatibility
7227

73-
The Vert.x Hazelcast Enterprise module follows the versioning of Vertx. If you use an `x.y.z` version of Vert.x, you should use an `x.y.z` version of `vertx-hazelcast-enteprise`.
74-
75-
The `vertx-hazelcast-enteprise` module is compatible with all Hazelcast versions supported at the time of the release of the `vertx-hazelcast-enteprise` module unless stated otherwise.
28+
The Vert.x Hazelcast module follows the versioning of Vertx. If you use an `x.y.z` version of Vert.x, you should use an `x.y.z` version of `vertx-hazelcast`.
7629

7730
While older versions may work, such configurations are not supported.
7831

@@ -89,7 +42,7 @@ You can change the Hazelcast dependency to any version of Hazelcast you need, e.
8942

9043
NOTE: The old versions may not be supported by Hazelcast anymore and don't receive any patches.
9144

92-
There are multiple ways to replace the transitive dependency. The most reliable way is to exclude the `com.hazelcast:hazelcast` transitive dependency of the `vert-hazelcast` module and add a direct dependency on `com.hazelcast:hazelcast` to the pom.xml of your project.
45+
There are multiple ways to replace the transitive dependency. The most reliable way is to exclude the `com.hazelcast:hazelcast` transitive dependency of the `vertx-hazelcast` module and add a direct dependency on `com.hazelcast:hazelcast` to the pom.xml of your project.
9346

9447
[source,xml]
9548
----
@@ -108,25 +61,4 @@ There are multiple ways to replace the transitive dependency. The most reliable
10861
<artifactId>hazelcast</artifactId>
10962
<version>5.5.0</version>
11063
</dependency>
111-
----
112-
113-
Similarly, for `vertx-hazelcast-enterprise`:
114-
115-
[source,xml]
116-
----
117-
<dependency>
118-
<groupId>com.hazelcast</groupId>
119-
<artifactId>vertx-hazelcast-enterprise</artifactId>
120-
<exclusions>
121-
<exclusion>
122-
<groupId>com.hazelcast</groupId>
123-
<artifactId>hazelcast</artifactId>
124-
</exclusion>
125-
</exclusions>
126-
</dependency>
127-
<dependency>
128-
<groupId>com.hazelcast</groupId>
129-
<artifactId>hazelcast</artifactId>
130-
<version>5.5.0</version>
131-
</dependency>
132-
----
64+
----

0 commit comments

Comments
 (0)