Skip to content

Commit 70b3a06

Browse files
authored
DOC-532: update Enterprise overview, editions and quickstarts (#1784)
Following Enterprise Content plan to clarify and improve Enterprise positioning, benefits and onboarding: ### WIP list - [x] Add Features & Benefits table to Enterprise Overview AKA Editions - [x] Merge Get Started with Enterprise with Persist Map Entries tutorial - [ ] Refine and save tutorial template (separate PR) - [x] Correct and improve other EE GS tutorials - [x] Review and correct licensing / install info - [x] Check and correct terminology - [x] Apply Google Style Guide - [x] Update screenshots - [x] _Change license key to secret?_ Add tip and link to PO tutorial ### Docs Feedback Closes [1833](#1833), [1836](#1836)
1 parent de8979f commit 70b3a06

34 files changed

+1574
-1038
lines changed

docs/modules/ROOT/nav.adoc

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,33 @@
22
// About
33
* xref:whats-new.adoc[What's new]
44
* xref:what-is-hazelcast.adoc[What is Hazelcast Platform]
5-
* xref:getting-started:editions.adoc[Available versions]
5+
* xref:getting-started:editions.adoc[Hazelcast editions]
66
// Getting started
77
* Start a local cluster
88
** xref:getting-started:get-started-docker.adoc[Docker]
99
** xref:getting-started:get-started-cli.adoc[CLI]
1010
** xref:getting-started:get-started-binary.adoc[Binary]
1111
** xref:getting-started:get-started-java.adoc[Java embedded]
1212
// Enterprise
13-
* xref:getting-started:enterprise-overview.adoc[Get started with Enterprise Edition]
14-
** xref:getting-started:persistence.adoc[]
15-
** xref:getting-started:authenticate-clients.adoc[]
16-
** xref:getting-started:wan.adoc[]
17-
** xref:getting-started:blue-green.adoc[]
18-
// SQL
19-
* Get started with SQL
20-
** xref:sql:get-started-sql.adoc[]
21-
** xref:sql:learn-sql.adoc[]
22-
** xref:sql:get-started-sql-files.adoc[]
13+
* xref:getting-started:get-started-enterprise.adoc[Get started with Enterprise]
14+
** xref:getting-started:authenticate-client-tutorial.adoc[]
15+
** xref:getting-started:wan-replication-tutorial.adoc[Replicate map across WAN clusters]
16+
** xref:getting-started:deploy-blue-green-tutorial.adoc[]
2317
// Clients
24-
* xref:clients:hazelcast-clients.adoc[Get started with a Hazelcast Client]
18+
* xref:clients:hazelcast-clients.adoc[Get started with clients]
2519
** xref:clients:java-client-getting-started.adoc[Get started with Java]
2620
** xref:clients:csharp-client-getting-started.adoc[Get started with .NET]
2721
** xref:clients:python-client-getting-started.adoc[Get started with Python]
2822
** xref:clients:cpp-client-getting-started.adoc[Get started with {cpp}]
2923
** xref:clients:go-client-getting-started.adoc[Get started with Go]
3024
** xref:clients:nodejs-client-getting-started.adoc[Get started with Node.js]
25+
// SQL
26+
* Get started with SQL
27+
** xref:sql:get-started-sql.adoc[]
28+
** xref:sql:learn-sql.adoc[]
29+
** xref:sql:get-started-sql-files.adoc[]
3130
// Support
32-
* xref:getting-started:support.adoc[]
31+
* xref:getting-started:support.adoc[Get support]
3332
* xref:ask-ai.adoc[]
3433
3534
.Install and upgrade
@@ -450,7 +449,7 @@
450449
* xref:cluster-performance:thread-per-core-tpc.adoc[]
451450
// Synchronizing data across clusters
452451
* Synchronizing data across clusters
453-
** xref:wan:wan.adoc[WAN Replication Overview]
452+
** xref:getting-started:wan-replication-tutorial.adoc[WAN Replication Overview]
454453
** xref:wan:modes.adoc[]
455454
** xref:wan:quick-start.adoc[]
456455
** xref:wan:defining-wan-replication.adoc[]

docs/modules/ROOT/pages/ask-ai.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= Ask AI
2-
:description: Use our Ask AI feature to get instant answers to technical questions.
2+
:description: Use our Ask AI feature to get instant answers to technical questions and help troubleshoot problems.
33

44
{description}
55

docs/modules/ROOT/pages/capacity-planning.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ or asynchronous xref:data-structures:backing-up-maps.adoc[backups]?
3737
required to accommodate the data, both existing and new. Usually an eviction mechanism keeps
3838
the map/cache size in check, but the eviction itself does not always clear the memory almost
3939
immediately. Therefore, the answers to this question gives a good insight.
40-
* Are you using multiple clusters (which may involve xref:wan:wan.adoc[WAN Replication])?
40+
* Are you using multiple clusters (which may involve xref:getting-started:wan-replication-tutorial.adoc[WAN Replication])?
4141
* What are the throughput and latency requirements?
4242
** The answer should be about Hazelcast access, not the application throughput.
4343
For example, an application may plan for 10,000 user TPS but each user

docs/modules/ROOT/pages/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Also, Hazelcast can be used as a cache for applications based on the Spring Fram
7575
shared data in real time.
7676

7777
You can have multiple Hazelcast clusters at different locations in sync
78-
by replicating their state over WAN environments. See the xref:wan:wan.adoc[Synchronizing Data Across a WAN section].
78+
by replicating their state over WAN environments. See the xref:getting-started:wan-replication-tutorial.adoc[Synchronizing Data Across a WAN section].
7979

8080
You can listen to the events happening in the cluster, on the data structures and clients so that
8181
you are notified when those events happen. See the xref:events:distributed-events.adoc[Distributed Events section].

docs/modules/ROOT/pages/what-is-hazelcast.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Also, Hazelcast can be used as a cache for applications based on the Spring Fram
7575
shared data in real time.
7676

7777
You can have multiple Hazelcast clusters at different locations in sync
78-
by replicating their state over WAN environments. See the xref:wan:wan.adoc[Synchronizing Data Across a WAN section].
78+
by replicating their state over WAN environments. See the xref:getting-started:wan-replication-tutorial.adoc[Synchronizing Data Across a WAN section].
7979

8080
You can listen to the events happening in the cluster, on the data structures and clients so that
8181
you are notified when those events happen. See the xref:events:distributed-events.adoc[Distributed Events section].

docs/modules/architecture/pages/architecture.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ cooperatively diagnose the state and immediately take over the responsibility
3939
of the failed member. To determine if a member is unreachable or crashed, Hazelcast
4040
provides built-in xref:clusters:failure-detector-configuration.adoc[failure detectors].
4141

42-
Hazelcast also provides replication over WAN for high availability. You can have deployments across multiple data centers using the xref:wan:wan.adoc[WAN replication] mechanism which offers protection against a data center or wider network failures.
42+
Hazelcast also provides replication over WAN for high availability. You can have deployments across multiple data centers using the xref:getting-started:wan-replication-tutorial.adoc[WAN replication] mechanism which offers protection against a data center or wider network failures.
4343

4444
== AP/CP
4545

docs/modules/clients/pages/cplusplus.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ TIP: To learn how to get started quickly with the Hazelcast {cpp} client, follow
1111
The Hazelcast native {cpp} client is an official library that allows {cpp} applications to connect to and interact with Hazelcast clusters. With the Hazelcast {cpp} client, developers can build high-performance, distributed applications in {cpp} that leverage Hazelcast's powerful in-memory computing platform.
1212
The key features and benefits include:
1313

14-
* Distributed Data Structures: the client offers access to various distributed data structures such as Map, Queue, Reliable Topic, Set, List, MultiMap, RingBuffer, etc.
14+
* Distributed Data Structures: the client offers access to various distributed data structures such as Map, Queue, Reliable Topic, Set, List, MultiMap, Ringbuffer, etc.
1515
* Near Cache Support: the Near Cache feature allows frequently read data to be stored for faster read speeds compared to traditional caches.
1616
* Enterprise-Level security: the client provides SSL support for enhanced security requirements.
1717
* Distributed synchronization: the client offers distributed synchronization mechanisms through the CP Subsystem, including fenced_lock, counting_semaphore and latch.
@@ -55,7 +55,7 @@ git clone https://github.com/microsoft/vcpkg --branch 2025.02.14
5555
```
5656
The above code snippet installs `hazelcast-cpp-client` with its `boost` and `openssl` dependencies.
5757

58-
After installation, the library is available to use. For example, if you are using CMake for your builds, you can use the following cmake build command with the `CMAKE_TOOLCHAIN_FILE` cmake option to be the `vcpkg.cmake`.
58+
After installation, the library is available to use. For example, if you are using CMake for your builds, you can use the following CMake build command with the `CMAKE_TOOLCHAIN_FILE` CMake option to be the `vcpkg.cmake`.
5959
```bat
6060
cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
6161
cmake --build [build directory]
@@ -129,7 +129,7 @@ cmake --build .
129129
sudo cmake --build . --target install
130130
```
131131

132-
You can speed up the build process with parallel threads like 'cmake --build . -j 4'
132+
You can speed up the build process with parallel threads like `cmake --build . -j 4`
133133

134134
For information on how to use a different installation location, see xref:clients:cplusplus.adoc#custom-install-location[Custom install location].
135135

@@ -181,7 +181,7 @@ For example, if you want to build the static library with SSL support, use the f
181181
cmake .. -DWITH_OPENSSL=ON -DBUILD_SHARED_LIBS=OFF
182182
```
183183

184-
NOTE: If you want to use the `hazelcast-cpp-client` library with the `-DWITH_OPENSSL=ON` option without `find_package()` you must define the `HZ_BUILD_WITH_SSL` symbolic constant before including any `hazelcast-cpp-client` header. This symbolic constant can be defined via compiler options or can be passed directly through the cmake command as `-DVARIABLE=VALUE` pairs.
184+
NOTE: If you want to use the `hazelcast-cpp-client` library with the `-DWITH_OPENSSL=ON` option without `find_package()` you must define the `HZ_BUILD_WITH_SSL` symbolic constant before including any `hazelcast-cpp-client` header. This symbolic constant can be defined via compiler options or can be passed directly through the `cmake` command as `-DVARIABLE=VALUE` pairs.
185185

186186
For example:
187187
```sh

docs/modules/data-structures/pages/vector-collections.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,11 @@ If you use Docker, you can use the following example command:
2323

2424
[source,bash,subs="attributes+"]
2525
----
26-
docker run -p 5701:5701 -e HZ_LICENSEKEY=<your license key> \
26+
docker run -p 5701:5701 -e HZ_LICENSEKEY=<YOUR_LICENSE_KEY> \
2727
-e "JAVA_OPTS=--add-modules jdk.incubator.vector" \
2828
hazelcast/hazelcast-enterprise:{ee-version}-slim
29-
----
3029
31-
Replace the `<your license key>` placeholder with your Hazelcast {enterprise-product-name} license key.
30+
Replace the `<YOUR_LICENSE_KEY>` placeholder with your Hazelcast {enterprise-product-name} license key.
3231
3332
== Configuration
3433
Collection configuration can be set dynamically during vector collection creation or statically during cluster configuration. Unlike other data structures, the configuration must be set up before the collection can be used.

docs/modules/deploy/pages/deploying-on-azure.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ clientConfig.getNetworkConfig().getAzureConfig()
172172

173173
== Configuration for WAN Replication Target Cluster Discovery
174174

175-
Hazelcast allows you to configure xref:wan:wan.adoc[WAN replication] to work with the clusters in Azure and determine the endpoint IP addresses at runtime. If one Hazelcast cluster is running outside Azure and another is running inside Azure, then you should configure your WAN batch publisher as below:
175+
Hazelcast allows you to configure xref:getting-started:wan-replication-tutorial.adoc[WAN replication] to work with the clusters in Azure and determine the endpoint IP addresses at runtime. If one Hazelcast cluster is running outside Azure and another is running inside Azure, then you should configure your WAN batch publisher as below:
176176

177177
NOTE: You will need to setup link:https://learn.microsoft.com/entra/identity-platform/howto-create-service-principal-portal/[Microsoft Entra Service Principal credentials] for your Azure Subscription to be able to use these properties.
178178

docs/modules/deploy/pages/deploying-with-docker.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
= Deploying on Docker
1+
= Deploy on Docker
22
:description: In this deployment guide, you will learn how to form a cluster from Hazelcast member containers running on more than one Docker host in the same local area network (LAN).
33
:page-aliases: installing-using-docker.adoc
44

55
{description}
66

7-
== Starting a Cluster
7+
== Start a cluster
88

9-
The default network mode in Docker is bridge. In this mode, all containers run in a single network that is not accessible outside of the Docker host. If you run member Docker containers on different hosts, you must allow them to discover and connect to each other using one of the following methods:
9+
The default network mode in Docker is bridge. In this mode, all containers run in a single network that's not accessible outside of the Docker host. If you run member Docker containers on different hosts, you must allow them to discover and connect to each other using one of the following methods:
1010

1111
- Host network mode (Linux only)
1212
- Port mapping
1313

1414
include::deploy:partial$docker-ip-warning.adoc[]
1515

16-
=== Host Network Mode
16+
=== Use host network mode
1717

18-
To allow members and clients on different hosts to discover each other with multicast, you can use the `host` network mode. This mode allows members to share the hosts network stack from their Docker containers.
18+
To allow members and clients on different hosts to discover each other with multicast, you can use the `host` network mode. This mode allows members to share the host's network stack from their Docker containers.
1919

2020
Members will discover and connect to each other automatically only if your local network supports multicast. If your network does not support multicast, members will not form a cluster. In this case, you can try <<port-mapping, port mapping>>.
2121

@@ -44,7 +44,7 @@ docker run --rm --network host --name member2 hazelcast/hazelcast-enterprise:{ee
4444

4545
In this mode, each member is available on the internal (private) IP address of the Docker host.
4646

47-
=== Port Mapping
47+
=== Port mapping
4848

4949
To allow members and clients on different hosts to discover each other over TCP/IP, you can map ports from the Docker host (the device that's running Docker) and tell Hazelcast to listen to your internal IP address.
5050

@@ -134,8 +134,7 @@ for more information.
134134

135135
You can configure various aspects of your cluster and environment with Docker.
136136

137-
We recommend that you use the default
138-
configuration file as a starting point.
137+
We recommend that you use the default configuration file as a starting point.
139138

140139
=== Memory
141140

@@ -162,7 +161,7 @@ docker run --memory 2g -e JAVA_OPTS="-XX:MaxRAMPercentage=85.0" --rm hazelcast/h
162161

163162
Make sure to leave enough free RAM for metaspace and other overheads.
164163

165-
=== Custom Hazelcast Configuration File
164+
=== Custom Hazelcast configuration file
166165

167166
You can configure Hazelcast with your own YAML or XML file
168167
by replacing the default ones in the container at
@@ -185,7 +184,7 @@ docker run \
185184
-p:5701:5701 hazelcast/hazelcast:{os-version}
186185
----
187186

188-
=== Extend Hazelcast's CLASSPATH with Custom JARS and Files
187+
=== Extend Hazelcast's classpath with Custom JARS and Files
189188

190189
If you have to add more classes or files to Hazelcast's classpath, one way to
191190
do it is to put them in a directory such as `ext`, mount it to the
@@ -210,7 +209,7 @@ docker run \
210209
211210
----
212211

213-
=== Changing Logging Level
212+
=== Change logging level
214213

215214
You can set the logging level using the `LOGGING_LEVEL` environment
216215
variable:
@@ -238,7 +237,7 @@ Edit the file and mount it when starting Hazelcast:
238237
docker run -v /path/to/log4j2.properties:/opt/hazelcast/log4j2.properties hazelcast/hazelcast:{os-version}
239238
----
240239

241-
== Building a Custom Image from the Slim Image
240+
== Build a custom image from the slim Docker image
242241

243242
Hazelcast offers a xref:getting-started:editions.adoc#full-slim[slim] Docker image that
244243
contains only the core Hazelcast engine. When image size is a concern, you can use it

0 commit comments

Comments
 (0)