diff --git a/docs/modules/cp-subsystem/pages/raft-log-file-exporter.adoc b/docs/modules/cp-subsystem/pages/raft-log-file-exporter.adoc index 56a24b6c5..7ac4c5148 100644 --- a/docs/modules/cp-subsystem/pages/raft-log-file-exporter.adoc +++ b/docs/modules/cp-subsystem/pages/raft-log-file-exporter.adoc @@ -28,9 +28,9 @@ Run the RaftLogFileExporter tool, specifying the following parameters: [source,bash,subs="attributes+"] ---- -java -Xms2g -Xmx4g -cp hazelcast-enterprise-{full-version}.jar com.hazelcast.cp.RaftLogFileExporter \ <1> - --source=/path/to/raft/logs \ <2> - --output=migrated_output \ <3> +java -Xms2g -Xmx4g -cp hazelcast-enterprise-{full-version}.jar com.hazelcast.cp.RaftLogFileExporter \# <1> + --source=/path/to/raft/logs \# <2> + --output=migrated_output \# <3> --max-uncommitted-entries=10000 <4> ---- <1> Minimum and maximum heap size and the JAR file to use. diff --git a/docs/modules/getting-started/pages/deploy-blue-green-tutorial.adoc b/docs/modules/getting-started/pages/deploy-blue-green-tutorial.adoc index 8949ceb80..57241ceea 100644 --- a/docs/modules/getting-started/pages/deploy-blue-green-tutorial.adoc +++ b/docs/modules/getting-started/pages/deploy-blue-green-tutorial.adoc @@ -41,19 +41,19 @@ This step also installs your {enterprise-product-name} license key. ---- docker run \ --rm \ - -e HZ_NETWORK_PUBLICADDRESS=localhost:5701 \ <1> + -e HZ_NETWORK_PUBLICADDRESS=localhost:5701 \# <1> -e HZ_CLUSTERNAME=blue \ - -e HZ_LICENSEKEY= \ <2> + -e HZ_LICENSEKEY= \# <2> -p 5701:5701 hazelcast/hazelcast-enterprise:{ee-version} ---- -<1> You can replace `host.docker.internal` with a specific IP address if you prefer but make sure you adjust the following code examples accordingly. +<1> You can replace `host.docker.internal` with a specific IP address if you prefer but make sure you adjust the following code examples accordingly. <2> Replace the `` placeholder with your Hazelcast {enterprise-product-name} license key. You should see your cluster name in the console along with the IP address of the Docker host that's running the Hazelcast member. [source,shell,subs="attributes+"] ---- -2024-12-01 18:26:42,369 [ INFO] [main] [c.h.i.c.ClusterService]: [localhost]:5701 [blue] [{ee-version}] +2024-12-01 18:26:42,369 [ INFO] [main] [c.h.i.c.ClusterService]: [localhost]:5701 [blue] [{ee-version}] Members {size:1, ver:1} [ Member [localhost]:5701 - c00213e1-da50-4b5f-a53b-ccfe4a1ebeea this @@ -72,7 +72,7 @@ docker run \ --rm \ -e HZ_NETWORK_PUBLICADDRESS=localhost:5702 \ -e HZ_CLUSTERNAME=green \ - -e HZ_LICENSEKEY= \ <1> + -e HZ_LICENSEKEY= \# <1> -p 5702:5701 hazelcast/hazelcast-enterprise:{ee-version} ---- <1> Replace the `` placeholder with your Hazelcast {enterprise-product-name} license key. @@ -81,7 +81,7 @@ You should see the `green` cluster is formed, with confirmation that looks like: [source,shell,subs="attributes+"] ---- -2021-12-01 18:28:46,299 [ INFO] [main] [c.h.i.c.ClusterService]: [localhost]:5701 [green] [{ee-version}] +2021-12-01 18:28:46,299 [ INFO] [main] [c.h.i.c.ClusterService]: [localhost]:5701 [green] [{ee-version}] Members {size:1, ver:1} [ Member [localhost]:5701 - 72f5520c-8c27-4501-9199-a8da6b58c0b4 this @@ -113,11 +113,11 @@ To do this, you need to create two client configurations for the same client, an ---- . Create the client configuration file for the `blue` cluster, called `client-blue.yaml` (or `client-blue.xml`) and save it in the `resources` directory: + -[tabs] -==== -YAML:: -+ --- +[tabs] +==== +YAML:: ++ +-- .client-blue.yaml [source,yaml] ---- @@ -156,11 +156,11 @@ XML:: . Create the client configuration for the `green` cluster, called `client-green.yaml` (or `client-green.xml`) and save it in the `resources` directory: + -[tabs] -==== -YAML:: -+ --- +[tabs] +==== +YAML:: ++ +-- .client-green.yaml [source,yaml] ---- @@ -197,11 +197,11 @@ XML:: ==== + -[tabs] -==== -YAML:: -+ --- +[tabs] +==== +YAML:: ++ +-- .hazelcast-client-failover.yaml [source,yaml] ---- @@ -241,15 +241,15 @@ In this step, you'll start the client. NOTE: This step provides the code for the next step for Java client and the full code example for Node.js; for other clients, you can adapt the code accordingly. -[tabs] -==== -Java:: +[tabs] +==== +Java:: + . Install the xref:getting-started:install-hazelcast.adoc#use-java[Java client library]. . Add the following to the `MyClient.java` file: + --- +-- [source,java,subs="attributes+"] ---- import com.hazelcast.client.HazelcastClient; @@ -300,7 +300,7 @@ const { Client } = require('hazelcast-client'); clusterConnectTimeoutMillis: 1000 } } - }, + }, { clusterName: 'green', network: { @@ -314,7 +314,7 @@ const { Client } = require('hazelcast-client'); } ] }); - + } catch (err) { console.error('Error occurred:', err); } @@ -357,7 +357,7 @@ Dec 01, 2024 8:16:45 PM com.hazelcast.core.LifecycleService INFO: hz.client_1 [green] [{ee-version}] HazelcastClient {ee-version} (20210922 - dbaeffe) is CLIENT_CONNECTED ---- -NOTE: In this type of failover scenario, the client does not automatically reconnect to the `blue` cluster when it is back online. Instead, you need to deploy a deny list using xref:{page-latest-supported-mc}@management-center:clusters:client-filtering.adoc[client filtering] to block client connections to the `green` cluster. The client will then use the failover configuration (in <>) to reconnect to the original cluster. When the client is reconnected, you can remove the client filter. +NOTE: In this type of failover scenario, the client does not automatically reconnect to the `blue` cluster when it is back online. Instead, you need to deploy a deny list using xref:{page-latest-supported-mc}@management-center:clusters:client-filtering.adoc[client filtering] to block client connections to the `green` cluster. The client will then use the failover configuration (in <>) to reconnect to the original cluster. When the client is reconnected, you can remove the client filter. == Step 6: Clean up @@ -373,7 +373,7 @@ In this tutorial, you learned how to: == Next steps -If you're interested in learning more about the topics introduced in this tutorial, see: +If you're interested in learning more about the topics introduced in this tutorial, see: * xref:clients:java.adoc#blue-green-deployment-and-disaster-recovery[] * xref:{page-latest-supported-mc}@management-center:clusters:client-filtering.adoc[] diff --git a/docs/modules/getting-started/pages/get-started-enterprise.adoc b/docs/modules/getting-started/pages/get-started-enterprise.adoc index ec9765ed9..6191578ba 100644 --- a/docs/modules/getting-started/pages/get-started-enterprise.adoc +++ b/docs/modules/getting-started/pages/get-started-enterprise.adoc @@ -52,15 +52,15 @@ If you have run this command previously (and not deleted the network), you will docker run \ --name first-member --network hazelcast-network \ --rm \ - -e HZ_NETWORK_PUBLICADDRESS=host.docker.internal:5701 \ <1> + -e HZ_NETWORK_PUBLICADDRESS=host.docker.internal:5701 \# <1> -e HZ_CLUSTERNAME=hello-world \ - -e HZ_LICENSEKEY= \ <2> + -e HZ_LICENSEKEY= \# <2> -e HZ_PERSISTENCE_ENABLED=true \ -e HZ_MAP_MYDISTRIBUTEDMAP_DATAPERSISTENCE_ENABLED=true \ - -v ~/persist:/opt/hazelcast/persistence \ <3> + -v ~/persist:/opt/hazelcast/persistence \# <3> -p 5701:5701 hazelcast/hazelcast-enterprise:{ee-version} <4> ---- -<1> You can replace `host.docker.internal` with a specific IP address if you prefer but make sure you adjust the following code examples accordingly. +<1> You can replace `host.docker.internal` with a specific IP address if you prefer but make sure you adjust the following code examples accordingly. // Keeping simple docker host for this tutorial vs. individual IP addresses <2> Replace the `` placeholder with the Hazelcast {enterprise-product-name} license key from step 2. <3> By default, Hazelcast creates the `/opt/hazelcast/persistence` directory to store the persisted data. @@ -165,7 +165,7 @@ docker run \ . In a web browser, go to `localhost:8080` and enable Dev Mode. // + // remove as unnecessary image:mc-dev-mode.png[Enabling Dev mode in Management Center] -. You should now see a *Cluster Connections* screen. +. You should now see a *Cluster Connections* screen. .. Click *Connect Cluster*. .. Enter a *Cluster Name* of `hello-world`. .. Enter a *Member Address* of `host.docker.internal:5701`. @@ -195,11 +195,11 @@ Management Center should now show it is disconnected from the cluster, which you ---- + . Restart the cluster by starting the members up again, by rerunning the commands in steps 4 and 5 above. -. When the members have restarted, you can view your map data in Management Center and confirm the entries still exist. If persistence was not enabled, the data would be lost after cluster shutdown. +. When the members have restarted, you can view your map data in Management Center and confirm the entries still exist. If persistence was not enabled, the data would be lost after cluster shutdown. == Step 9: Clean up -. Repeat the steps above to shut down the cluster +. Repeat the steps above to shut down the cluster . To delete the persist directories created above, use the following command: + [source,shell,subs="attributes+"] diff --git a/docs/modules/getting-started/pages/install-enterprise.adoc b/docs/modules/getting-started/pages/install-enterprise.adoc index 953a6ee59..299a36946 100644 --- a/docs/modules/getting-started/pages/install-enterprise.adoc +++ b/docs/modules/getting-started/pages/install-enterprise.adoc @@ -9,7 +9,7 @@ ==== These instructions apply only to the licensed {enterprise-product-name}. If you have the {open-source-product-name} edition, follow the instructions in the xref:install-hazelcast.adoc[] topic. -If you are moving members from an {open-source-product-name} cluster to an {enterprise-product-name} cluster of the same version, you can use rolling restarts to +If you are moving members from an {open-source-product-name} cluster to an {enterprise-product-name} cluster of the same version, you can use rolling restarts to move each member without downtime. See xref:migrate:rolling-restart.adoc[]. ==== // add see more info link @@ -62,25 +62,25 @@ ifndef::snapshot[] Download and extract the binaries. //do we need the snapshot option? -[tabs] -==== -Mac:: -+ +[tabs] +==== +Mac:: ++ -- [source,bash,subs="attributes+"] ---- curl -L 'https://repository.hazelcast.com/download/hazelcast-enterprise/hazelcast-enterprise-{ee-version}.tar.gz' | tar xvzf - ---- -- -Linux:: -+ +Linux:: ++ -- [source,bash,subs="attributes+"] ---- wget -O - 'https://repository.hazelcast.com/download/hazelcast-enterprise/hazelcast-enterprise-{ee-version}.tar.gz' | tar xvzf - ---- -- -Windows:: +Windows:: + -- Download and extract the link:https://repository.hazelcast.com/download/hazelcast-enterprise/hazelcast-enterprise-{ee-version}.zip[{ee-version} zip file]. @@ -206,7 +206,7 @@ java --add-modules java.se \ --add-opens java.management/sun.management=com.hazelcast.core \ --add-opens jdk.management/com.ibm.lang.management.internal=com.hazelcast.core \ --add-opens jdk.management/com.sun.management.internal=com.hazelcast.core \ - --module-path lib \ <1> + --module-path lib \# <1> --module com.hazelcast.core/com.hazelcast.core.server.HazelcastMemberStarter ---- <1> This example expects the `hazelcast-{ee-version}.jar` file in the `lib` directory. diff --git a/docs/modules/getting-started/pages/install-hazelcast.adoc b/docs/modules/getting-started/pages/install-hazelcast.adoc index 285ebb724..f2a8f2b56 100644 --- a/docs/modules/getting-started/pages/install-hazelcast.adoc +++ b/docs/modules/getting-started/pages/install-hazelcast.adoc @@ -6,7 +6,7 @@ NOTE: These instructions apply only to the {open-source-product-name}. If you have an {enterprise-product-name} license, follow the instructions in xref:install-enterprise.adoc[]. -We recommend that you learn more about the benefits of an {enterprise-product-name} license to ensure that you do not require any of the additional functionality or support before you install {open-source-product-name}. If you continue with the {open-source-product-name} installation, you can move your {open-source-product-name} members to {enterprise-product-name} at any time if you subsequently want to benefit from the {enterprise-product-name} functionality without downtime. +We recommend that you learn more about the benefits of an {enterprise-product-name} license to ensure that you do not require any of the additional functionality or support before you install {open-source-product-name}. If you continue with the {open-source-product-name} installation, you can move your {open-source-product-name} members to {enterprise-product-name} at any time if you subsequently want to benefit from the {enterprise-product-name} functionality without downtime. For further information on {enterprise-product-name} features, see xref:editions.adoc[]. To migrate from {open-source-product-name} to {enterprise-product-name}, see xref:migrate:rolling-restart.adoc[]. @@ -28,10 +28,10 @@ Package managers are the fastest way to install Hazelcast. This option is for de // tag::cli[] . To install Hazelcast, use the appropriate command for your operating system: + -[tabs] -==== -Mac:: -+ +[tabs] +==== +Mac:: ++ -- To install on macOS, use the Homebrew package manager. @@ -117,21 +117,21 @@ docker pull hazelcast/hazelcast:{os-version} Download the latest snapshot archive and extract the binaries. // tag::binary[] -[tabs] -==== -Mac:: -+ +[tabs] +==== +Mac:: ++ -- . Download a package from https://hazelcast.com/community-edition-projects/downloads/?utm_source=docs-website[hazelcast.com^]. . Extract the downloaded package. -- -Linux:: -+ +Linux:: ++ -- . Download a package from https://hazelcast.com/community-edition-projects/downloads/?utm_source=docs-website[hazelcast.com^]. . Extract the downloaded package. -- -Windows:: +Windows:: + -- . Download a package from https://hazelcast.com/community-edition-projects/downloads/?utm_source=docs-website[hazelcast.com^]. @@ -241,7 +241,7 @@ java --add-modules java.se \ --add-opens java.management/sun.management=com.hazelcast.core \ --add-opens jdk.management/com.ibm.lang.management.internal=com.hazelcast.core \ --add-opens jdk.management/com.sun.management.internal=com.hazelcast.core \ - --module-path lib \ <1> + --module-path lib \# <1> --module com.hazelcast.core/com.hazelcast.core.server.HazelcastMemberStarter ---- <1> This example requires the `hazelcast-{os-version}.jar` file in the `lib` directory. diff --git a/docs/modules/getting-started/pages/wan-replication-tutorial.adoc b/docs/modules/getting-started/pages/wan-replication-tutorial.adoc index 038c805d2..96f90c164 100644 --- a/docs/modules/getting-started/pages/wan-replication-tutorial.adoc +++ b/docs/modules/getting-started/pages/wan-replication-tutorial.adoc @@ -30,18 +30,18 @@ Before you start this tutorial, ensure you have completed the following: == Step 1: Start the passive cluster In this step, you'll start an {enterprise-product-name} cluster called `London` with a single member. This will be the **passive** cluster, -which means it doesn't need WAN Replication to be enabled. +which means it doesn't need WAN Replication to be enabled. -. Run the following Docker command in a terminal, replacing the placeholder with your Hazelcast Enterprise Edition license key: +. Run the following Docker command in a terminal, replacing the placeholder with your Hazelcast Enterprise Edition license key: + [source,shell,subs="attributes+"] ---- docker run \ -p 5701:5701 \ --network hazelcast-network \ - -e HZ_NETWORK_PUBLICADDRESS=host.docker.internal:5701 \ <1> - -e HZ_LICENSEKEY= \ <2> - -e HZ_MANAGEMENTCENTER_CONSOLEENABLED=true \ + -e HZ_NETWORK_PUBLICADDRESS=host.docker.internal:5701 \# <1> + -e HZ_LICENSEKEY= \# <2> + -e HZ_MANAGEMENTCENTER_CONSOLEENABLED=true \ -e HZ_CLUSTERNAME=London \ hazelcast/hazelcast-enterprise:{ee-version} ---- @@ -52,7 +52,7 @@ You should see confirmation that looks like: [source,shell,subs="attributes+"] ---- -2024-11-23 11:08:15,055 [ INFO] [main] [c.h.i.c.ClusterService]: [host.docker.internal]:5701 [London] [{ee-version}] +2024-11-23 11:08:15,055 [ INFO] [main] [c.h.i.c.ClusterService]: [host.docker.internal]:5701 [London] [{ee-version}] Members {size:1, ver:1} [ Member [host.docker.internal]:5701 - bed20746-1505-449b-9f4a-548bcdbe12b8 this @@ -80,7 +80,7 @@ hazelcast: cluster-name: Tokyo license-key: jet: - enabled: true + enabled: true wan-replication: <1> london-wan-rep: batch-publisher: @@ -105,7 +105,7 @@ XML:: Tokyo - + <1> London @@ -136,7 +136,7 @@ You should see confirmation like: + [source,shell,subs="attributes+"] ---- -2024-11-23 11:39:14,198 [ INFO] [main] [c.h.i.c.ClusterService]: [172.18.0.3]:5701 [Tokyo] [{ee-version}] +2024-11-23 11:39:14,198 [ INFO] [main] [c.h.i.c.ClusterService]: [172.18.0.3]:5701 [Tokyo] [{ee-version}] Members {size:1, ver:1} [ Member [172.18.0.3]:5701 - 98d9a815-5eb3-4341-bec1-e9816cee44b5 this @@ -193,7 +193,7 @@ docker run --network hazelcast-network -it --rm hazelcast/hazelcast-enterprise:{ [source,sql] ---- CREATE MAPPING cities (__key INT, country VARCHAR, city VARCHAR) -TYPE IMap +TYPE IMap OPTIONS ('keyFormat'='int', 'valueFormat' = 'json-flat'); ---- @@ -222,7 +222,7 @@ SELECT * FROM cities; + image:wan/map-tokyo.png[Cities map in Tokyo cluster] . Click **SQL Browser** from the left-hand *Tools* menu and enter `SELECT * FROM cities;` as your query. -. Click **Execute Query** and you should see your newly created map containing the city data. +. Click **Execute Query** and you should see your newly created map containing the city data. + image:wan/map-entries.png[Management Center SQL Browser showing the map data] . Close the SQL browser. @@ -239,7 +239,7 @@ With WAN Replication enabled, your `cities` map and its data should be replicate [source,sql] ---- CREATE MAPPING cities (__key INT, country VARCHAR, city VARCHAR) -TYPE IMap +TYPE IMap OPTIONS ('keyFormat'='int', 'valueFormat' = 'json-flat'); ---- + diff --git a/docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc b/docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc index 9e29ee985..28e724125 100644 --- a/docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc +++ b/docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc @@ -34,7 +34,7 @@ cURL with XML:: curl -X POST \ 'http://localhost:8443/hazelcast/rest/api/v1/cluster/config/update' \ -H 'Content-Type: application/json' \ --H 'Authorization: Bearer '"$JWT_TOKEN"'' \ <1> +-H 'Authorization: Bearer '"$JWT_TOKEN"'' \# <1> -d ' BINARY @@ -55,7 +55,7 @@ cURL with YAML:: ---- curl -X POST \ 'http://localhost:8443/hazelcast/rest/api/v1/cluster/config/update' \ - -H 'Authorization: Bearer '"$JWT_TOKEN"'' \ <1> + -H 'Authorization: Bearer '"$JWT_TOKEN"'' \# <1> -H 'Content-Type: application/json' \ -d 'hazelcast: map: diff --git a/package-lock.json b/package-lock.json index 0a84f1f0a..6dfd66951 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,7 +16,7 @@ "@antora/site-generator": "^3.1.1", "@asciidoctor/core": "^2.0.0", "asciidoctor-kroki": "^0.10.0", - "hazelcast-docs-tools": "github:hazelcast/hazelcast-docs-tools#v2.1.0", + "hazelcast-docs-tools": "github:hazelcast/hazelcast-docs-tools#semver:2.1.0", "ngrok": "^5.0.0-beta.2", "serve": "^14.2.4" }