From df748c8dd488ad273e054288dc97a86abac851e4 Mon Sep 17 00:00:00 2001 From: Jack Green Date: Mon, 22 Apr 2024 14:29:39 +0100 Subject: [PATCH 1/7] Externalise OS/EE Hazelcast edition names (#1072) The names of the editions of Hazelcast should not be hardcoded, to allow adjusting the edition names to suit business requirements, localization etc. I've updated references to `Open Source` and `Enterprise` to a key to an externalised value, where sensible. The actual names remain unchanged, as updating these terms is [larger than just this repo](https://hazelcast.slack.com/archives/C035HQET5/p1712585262831789?thread_ts=1712583856.778069&cid=C035HQET5). I've **not** done this for: - Code samples - URLs - Examples of Hazelcast outputs - Hazelcast configuration properties - Migration guides from older versions (e.g. IMDG, Jet) where the names can be hardcoded as they are correct _for that version_ - The `ENTERPRISE` suffix on EE-only pages (this is coming from CSS somewhere) - ![image](https://github.com/hazelcast/hz-docs/assets/8626721/9c419761-06e8-49fe-92ac-afc750e5c881) [Slack discussion](https://hazelcast.slack.com/archives/C035HQET5/p1712583856778069). --------- Co-authored-by: serdaro --- docs/antora.yml | 3 +++ docs/modules/ROOT/nav.adoc | 4 ++-- .../modules/ROOT/pages/capacity-planning.adoc | 2 +- docs/modules/ROOT/pages/phone-homes.adoc | 4 ++-- .../ROOT/pages/production-checklist.adoc | 2 +- docs/modules/clients/pages/java.adoc | 14 +++++------ .../pages/best-practices.adoc | 12 +++++----- .../pages/performance-tuning.adoc | 4 ++-- .../clusters/pages/discovery-mechanisms.adoc | 2 +- docs/modules/clusters/pages/legacy-ucd.adoc | 6 ++--- .../clusters/pages/ucn-migrate-ucd.adoc | 2 +- .../clusters/partials/ucn-migrate-tip.adoc | 2 +- .../pages/dynamic-config-persistence.adoc | 10 ++++---- .../configuration/pages/dynamic-config.adoc | 6 ++--- .../pages/jet-configuration.adoc | 2 +- .../cp-subsystem/pages/configuration.adoc | 4 ++-- .../cp-subsystem/pages/cp-subsystem.adoc | 2 +- .../pages/data-connections-configuration.adoc | 6 ++--- .../pages/mongo-dc-configuration.adoc | 2 +- docs/modules/data-structures/pages/cpmap.adoc | 4 ++-- .../pages/managing-map-memory.adoc | 10 ++++---- .../pages/setting-data-format.adoc | 4 ++-- .../deploy/pages/deploying-with-docker.adoc | 4 ++-- .../deploy/pages/enterprise-licenses.adoc | 22 ++++++++--------- .../pages/authenticate-clients.adoc | 10 ++++---- .../getting-started/pages/blue-green.adoc | 18 +++++++------- .../getting-started/pages/editions.adoc | 24 +++++++++---------- .../pages/enterprise-overview.adoc | 8 +++---- .../pages/get-started-binary.adoc | 2 +- .../pages/install-enterprise.adoc | 22 ++++++++--------- .../pages/install-hazelcast.adoc | 8 +++---- .../getting-started/pages/persistence.adoc | 8 +++---- docs/modules/getting-started/pages/wan.adoc | 10 ++++---- .../modules/getting-started/partials/nav.adoc | 2 +- .../pages/elasticsearch-connector.adoc | 2 +- .../integrate/pages/file-connector.adoc | 2 +- .../integrate/pages/jcache-connector.adoc | 2 +- .../pages/kafka-connect-connectors.adoc | 2 +- .../integrate/pages/kafka-connector.adoc | 2 +- .../pages/legacy-file-connector.adoc | 2 +- .../integrate/pages/list-connector.adoc | 2 +- .../integrate/pages/map-connector.adoc | 2 +- .../pages/reliable-topic-connector.adoc | 2 +- docs/modules/jcache/pages/icache.adoc | 2 +- .../pages/helm-hazelcast-chart.adoc | 2 +- .../helm-hazelcast-enterprise-chart.adoc | 10 ++++---- .../pages/kubernetes-auto-discovery.adoc | 4 ++-- .../pages/kubernetes-persistence.adoc | 6 ++--- .../troubleshooting-and-limitations.adoc | 2 +- docs/modules/kubernetes/partials/nav.adoc | 2 +- .../maintain-cluster/pages/lite-members.adoc | 4 ++-- .../maintain-cluster/pages/monitoring.adoc | 4 ++-- .../maintain-cluster/pages/rest-api.adoc | 8 +++---- .../pages/rolling-upgrades.adoc | 8 +++---- .../management/pages/cluster-utilities.adoc | 4 ++-- .../migrate/pages/data-migration-tool.adoc | 12 +++++----- .../migrate/pages/migration-tool-imdg.adoc | 2 +- docs/modules/osgi/pages/osgi-support.adoc | 2 +- docs/modules/pipelines/pages/cdc.adoc | 2 +- .../modules/pipelines/pages/job-security.adoc | 8 +++---- docs/modules/pipelines/pages/python.adoc | 2 +- docs/modules/release-notes/pages/5-3-0.adoc | 2 +- .../modules/security/pages/enabling-jaas.adoc | 2 +- .../pages/logging-auditable-events.adoc | 2 +- docs/modules/security/pages/overview.adoc | 2 +- .../security/pages/security-realms.adoc | 2 +- .../security/pages/validating-secrets.adoc | 4 ++-- .../sql/pages/create-data-connection.adoc | 2 +- docs/modules/sql/pages/create-index.adoc | 2 +- docs/modules/sql/pages/create-mapping.adoc | 2 +- docs/modules/sql/pages/create-view.adoc | 2 +- docs/modules/sql/pages/drop-job.adoc | 2 +- docs/modules/sql/pages/drop-mapping.adoc | 2 +- docs/modules/sql/pages/drop-view.adoc | 2 +- .../sql/pages/mapping-to-a-file-system.adoc | 2 +- docs/modules/sql/pages/mapping-to-jdbc.adoc | 6 ++--- docs/modules/sql/pages/mapping-to-kafka.adoc | 2 +- docs/modules/sql/pages/mapping-to-maps.adoc | 2 +- docs/modules/sql/pages/mapping-to-mongo.adoc | 2 +- docs/modules/sql/pages/sql-overview.adoc | 2 +- docs/modules/sql/pages/sql-statements.adoc | 4 ++-- .../modules/sql/pages/user-defined-types.adoc | 2 +- .../pages/configuring-persistence.adoc | 2 +- .../storage/pages/high-density-memory.adoc | 2 +- docs/modules/storage/pages/persistence.adoc | 2 +- .../tiered-storage/pages/configuration.adoc | 2 +- .../tiered-storage/pages/overview.adoc | 2 +- .../troubleshoot/pages/error-handling.adoc | 2 +- docs/modules/wan/pages/failures.adoc | 2 +- 89 files changed, 207 insertions(+), 204 deletions(-) diff --git a/docs/antora.yml b/docs/antora.yml index 438597d21..8e422ce8c 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -29,5 +29,8 @@ asciidoc: page-latest-supported-python-client: '5.3.0' page-latest-supported-nodejs-client: '5.3.0' page-latest-supported-clc: '5.3.1' + open-source-product-name: 'Open Source' + enterprise-product-name: 'Enterprise' + nav: - modules/ROOT/nav.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 46f65a7b5..6ae0627f0 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -43,8 +43,8 @@ include::troubleshoot:partial$nav.adoc[] * Installation ** xref:deploy:choosing-a-deployment-option.adoc[] ** xref:getting-started:editions.adoc[Editions and Distributions] -** xref:getting-started:install-hazelcast.adoc[Open Source] -** xref:getting-started:install-enterprise.adoc[Enterprise] +** xref:getting-started:install-hazelcast.adoc[{open-source-product-name}] +** xref:getting-started:install-enterprise.adoc[{enterprise-product-name}] * Member/Client Discovery ** xref:clusters:discovery-mechanisms.adoc[] ** xref:clusters:discovering-by-tcp.adoc[] diff --git a/docs/modules/ROOT/pages/capacity-planning.adoc b/docs/modules/ROOT/pages/capacity-planning.adoc index 2ffcb484e..861149662 100644 --- a/docs/modules/ROOT/pages/capacity-planning.adoc +++ b/docs/modules/ROOT/pages/capacity-planning.adoc @@ -185,7 +185,7 @@ be sure to use a prime number of partitions. This helps minimize the collision of keys across partitions, ensuring more consistent lookup times. -NOTE: If you are an Enterprise customer using the High-Density Memory Store +NOTE: If you are an {enterprise-product-name} customer using the High-Density Memory Store with large data sizes, we recommend a large increase in partition count, starting with 5009 or higher. NOTE: The partition count cannot be easily changed after a cluster is created, so if you have a large cluster diff --git a/docs/modules/ROOT/pages/phone-homes.adoc b/docs/modules/ROOT/pages/phone-homes.adoc index e12b01515..a705cd515 100644 --- a/docs/modules/ROOT/pages/phone-homes.adoc +++ b/docs/modules/ROOT/pages/phone-homes.adoc @@ -69,8 +69,8 @@ The following information is sent in a phone home: ** FencedLocks count ** AtomicLongs count ** AtomicRefs count -* Hazelcast Enterprise specific: -** Flag for Hazelcast Enterprise +* Hazelcast {enterprise-product-name} specific: +** Flag for Hazelcast {enterprise-product-name} ** Hash value of license key ** Native memory usage ** Whether dynamic configuration persistence is enabled diff --git a/docs/modules/ROOT/pages/production-checklist.adoc b/docs/modules/ROOT/pages/production-checklist.adoc index 9212f30a5..5a21dcce1 100644 --- a/docs/modules/ROOT/pages/production-checklist.adoc +++ b/docs/modules/ROOT/pages/production-checklist.adoc @@ -92,7 +92,7 @@ be large enough for a balanced data or task distribution so that each member does not manage too few partitions. * A partition size of 50MB or less typically ensures good performance. Larger clusters may be able to use up to 100MB partition sizes, but will likely also require larger JVM heap sizes to accomodate the increase in data flow. -If you are a Hazelcast Enterprise customer using the High-Density Data Store with large data sizes, +If you are a Hazelcast {enterprise-product-name} customer using the High-Density Data Store with large data sizes, we recommend a large increase in partition count, starting with 5009 or higher. The partition count cannot be easily changed after a cluster is created, so if you have a large cluster be sure to test and set an optimum partition count prior to deployment. If you need to change the partition count after a cluster is already running, you will need to schedule a maintenance window to entirely bring the cluster down. If your cluster uses the xref:storage:persistence.adoc[Persistence] or xref:cp-subsystem:persistence.adoc[CP Persistence] features, those persistent files will need to be removed after the cluster is shut down, as they contain references to the previous partition count. Once all member configurations are updated, and any persistent data structure files are removed, the cluster can be safely restarted. diff --git a/docs/modules/clients/pages/java.adoc b/docs/modules/clients/pages/java.adoc index 9d83a9d9f..47a28d6a2 100644 --- a/docs/modules/clients/pages/java.adoc +++ b/docs/modules/clients/pages/java.adoc @@ -7,10 +7,10 @@ To get started, include the `hazelcast.jar` dependency in your classpath. Once included, you can start using this client as if you are using the Hazelcast API. The differences are discussed in the below sections. -NOTE: If you have a Hazelcast Enterprise license, you do not need to set the license key in your Hazelcast Java clients to use the xref:getting-started:editions.adoc#features-in-hazelcast-enterprise[enterprise features] - setting it on the member side is enough. In this case, you only need to include the `hazelcast-enterprise.jar` dependency in your classpath. +NOTE: If you have a Hazelcast {enterprise-product-name} license, you do not need to set the license key in your Hazelcast Java clients to use the xref:getting-started:editions.adoc#features-in-hazelcast-enterprise[{enterprise-product-name} features] - setting it on the member side is enough. In this case, you only need to include the `hazelcast-enterprise.jar` dependency in your classpath. If you prefer to use Maven, simply add the `hazelcast` dependency -to your `pom.xml` (or the `hazelcast-enterprise` dependency, if you want the client to use enterprise features provided that you have the Hazelcast Enterprise license), +to your `pom.xml` (or the `hazelcast-enterprise` dependency, if you want the client to use {enterprise-product-name} features provided that you have the Hazelcast {enterprise-product-name} license), which you may already have done to start using Hazelcast: [source,xml,subs="attributes+"] @@ -949,7 +949,7 @@ Its default value is *5000* milliseconds. ==== Setting a Socket Interceptor -[blue]*Hazelcast Enterprise* +[blue]*Hazelcast {enterprise-product-name}* Following is a client configuration to set a socket intercepter. Any class implementing `com.hazelcast.nio.SocketInterceptor` is a socket interceptor. @@ -1025,7 +1025,7 @@ socketOptions.setBufferSize(32) ==== Enabling Client TLS/SSL -[blue]*Hazelcast Enterprise* +[blue]*Hazelcast {enterprise-product-name}* You can use TLS/SSL to secure the connection between the client and the members. If you want TLS/SSL enabled for the client-cluster connection, you should set `SSLConfig`. @@ -1528,7 +1528,7 @@ and for each connection we have a connection timeout; see the === Blue-Green Deployment [[blue-green-mechanism]] -[blue]*Hazelcast Enterprise Feature* +[blue]*Hazelcast {enterprise-product-name} Feature* Blue-green deployment refers to a client connection technique that reduces system downtime by deploying two mirrored clusters: blue (active) and green (idle). One of these clusters is running in production while the other is on standby. @@ -2392,9 +2392,9 @@ If both are configured, this one is ignored. == Using High-Density Memory Store with Java Client -[navy]*Hazelcast Enterprise* +[navy]*Hazelcast {enterprise-product-name}* -If you have [navy]*Hazelcast Enterprise*, your Hazelcast Java client's Near Cache +If you have [navy]*Hazelcast {enterprise-product-name}*, your Hazelcast Java client's Near Cache can benefit from the High-Density Memory Store. Let's recall the Java client's Near Cache configuration diff --git a/docs/modules/cluster-performance/pages/best-practices.adoc b/docs/modules/cluster-performance/pages/best-practices.adoc index 336c0f95b..637dee2c8 100644 --- a/docs/modules/cluster-performance/pages/best-practices.adoc +++ b/docs/modules/cluster-performance/pages/best-practices.adoc @@ -408,7 +408,7 @@ Note that a map's in-memory format can be different from that of its Near Cache. ** `BINARY`: Data is stored in serialized binary format (default value). ** `OBJECT`: Data is stored in deserialized form. ** `NATIVE`: Data is stored in the Near Cache that uses Hazelcast's High-Density Memory Store feature. -This option is available only in Hazelcast Enterprise. Note that a map and +This option is available only in Hazelcast {enterprise-product-name}. Note that a map and its Near Cache can independently use High-Density Memory Store. For example, while your map does not use High-Density Memory Store, its Near Cache can use it. * `invalidate-on-change`: Specifies whether the cached entries are evicted when the entries are updated or removed. @@ -432,16 +432,16 @@ You still can combine it with `time-to-live-seconds` and `max-idle-seconds` to e *** `ENTRY_COUNT`: Maximum size based on the entry count in the Near Cache (default value). *** `USED_NATIVE_MEMORY_SIZE`: Maximum used native memory size of the specified Near Cache in MB to trigger the eviction. If the used native memory size exceeds this threshold, the eviction is triggered. -Available only for `NATIVE` in-memory format. This is supported only by Hazelcast Enterprise. +Available only for `NATIVE` in-memory format. This is supported only by Hazelcast {enterprise-product-name}. *** `USED_NATIVE_MEMORY_PERCENTAGE`: Maximum used native memory percentage of the specified Near Cache to trigger the eviction. If the native memory usage percentage (relative to maximum native memory size) exceeds this threshold, the eviction is triggered. -Available only for `NATIVE` in-memory format. This is supported only by Hazelcast Enterprise. +Available only for `NATIVE` in-memory format. This is supported only by Hazelcast {enterprise-product-name}. *** `FREE_NATIVE_MEMORY_SIZE`: Minimum free native memory size of the specified Near Cache in MB to trigger the eviction. If free native memory size goes below this threshold, eviction is triggered. Available only for `NATIVE` in-memory format. -This is supported only by Hazelcast Enterprise. +This is supported only by Hazelcast {enterprise-product-name}. *** `FREE_NATIVE_MEMORY_PERCENTAGE`: Minimum free native memory percentage of the specified Near Cache to trigger eviction. If free native memory percentage (relative to maximum native memory size) goes below this threshold, eviction is triggered. -Available only for `NATIVE` in-memory format. This is supported only by Hazelcast Enterprise. +Available only for `NATIVE` in-memory format. This is supported only by Hazelcast {enterprise-product-name}. ** `size`: Maximum size of the Near Cache used for `max-size-policy`. When this is reached the Near Cache is evicted based on the policy defined. Any integer between `1` and `Integer.MAX_VALUE`. This value has different defaults, depending on the data structure. *** `IMap`: Its default value is `Integer.MAX_VALUE` for on-heap maps and `10000` for the `NATIVE` in-memory format. @@ -679,7 +679,7 @@ ClientConfig clientConfig = new ClientConfig() ==== Example for Near Cache with High-Density Memory Store -[navy]*Hazelcast Enterprise Feature* +[navy]*Hazelcast {enterprise-product-name} Feature* The following is a configuration example for an IMap High-Density Near Cache for a Hazelcast member. diff --git a/docs/modules/cluster-performance/pages/performance-tuning.adoc b/docs/modules/cluster-performance/pages/performance-tuning.adoc index 5eef7a5da..628335524 100644 --- a/docs/modules/cluster-performance/pages/performance-tuning.adoc +++ b/docs/modules/cluster-performance/pages/performance-tuning.adoc @@ -162,7 +162,7 @@ latency, high transaction rates, large working memory, and/or consistent response times. Zulu and Zulu Enterprise are Azul’s certified, freely available open source builds of OpenJDK with a variety of flexible support options, available in configurations for the enterprise as well as custom and embedded systems. -Azul Zing is certified and supported in Hazelcast Enterprise. When deployed with Zing, +Azul Zing is certified and supported in Hazelcast {enterprise-product-name}. When deployed with Zing, Hazelcast gains performance, capacity, and operational efficiency within the same infrastructure. Additionally, you can directly use Hazelcast with Zulu without making any changes to your code. @@ -462,7 +462,7 @@ instead of the JVM heap. This allows you to keep data in the memory without incurring the overhead of garbage collection (GC). HDMS capabilities are supported by the map structure, JCache implementation, Near Cache, Hibernate caching, and Web Session replications. -Available to Hazelcast Enterprise customers, HDMS is an ideal solution +Available to Hazelcast {enterprise-product-name} customers, HDMS is an ideal solution for those who want the performance of in-memory data, need the predictability of well-behaved Java memory management, and don’t want to spend time and effort on meticulous and fragile GC tuning. diff --git a/docs/modules/clusters/pages/discovery-mechanisms.adoc b/docs/modules/clusters/pages/discovery-mechanisms.adoc index 7db2c741e..8d536b720 100644 --- a/docs/modules/clusters/pages/discovery-mechanisms.adoc +++ b/docs/modules/clusters/pages/discovery-mechanisms.adoc @@ -89,7 +89,7 @@ discovering with multicast does not work. == Hazelcast for Kubernetes -You can deploy a Hazelcast cluster to Kubernetes using Helm or xref:deploy:deploying-with-operator[Hazelcast Enterprise Operator]. +You can deploy a Hazelcast cluster to Kubernetes using Helm or xref:deploy:deploying-with-operator[Hazelcast {enterprise-product-name} Operator]. See the xref:kubernetes:deploying-in-kubernetes.adoc[Deploying in Kubernetes section]. diff --git a/docs/modules/clusters/pages/legacy-ucd.adoc b/docs/modules/clusters/pages/legacy-ucd.adoc index 90ba24c65..71bf4fe7f 100644 --- a/docs/modules/clusters/pages/legacy-ucd.adoc +++ b/docs/modules/clusters/pages/legacy-ucd.adoc @@ -3,11 +3,11 @@ {description} -{ucn} is only available to Enterprise Edition users. +{ucn} is only available to {enterprise-product-name} Edition users. -Hazelcast recommends that Enterprise Edition users migrate to {ucn} to benefit from the improved and extended capabilities that it offers. +Hazelcast recommends that {enterprise-product-name} Edition users migrate to {ucn} to benefit from the improved and extended capabilities that it offers. -After the next major release, Open Source users can either upgrade to Enterprise Edition, or add their resources to the Hazelcast member class paths. +After the next major release, {open-source-product-name} users can either upgrade to {enterprise-product-name} Edition, or add their resources to the Hazelcast member class paths. For further information on migrating from {ucd} to {ucn}, see the xref:clusters:ucn-migrate-ucd.adoc[] topic. diff --git a/docs/modules/clusters/pages/ucn-migrate-ucd.adoc b/docs/modules/clusters/pages/ucn-migrate-ucd.adoc index c553e24ec..6466ae70f 100644 --- a/docs/modules/clusters/pages/ucn-migrate-ucd.adoc +++ b/docs/modules/clusters/pages/ucn-migrate-ucd.adoc @@ -1,5 +1,5 @@ = Migrate from {ucd} -:description: {ucn} improves and extends the capabilities of {ucd} and is applicable to more use cases. Hazelcast recommends that Enterprise Edition users deprecate their {ucd} implementations and migrate to using {ucn}. +:description: {ucn} improves and extends the capabilities of {ucd} and is applicable to more use cases. Hazelcast recommends that {enterprise-product-name} Edition users deprecate their {ucd} implementations and migrate to using {ucn}. :page-enterprise: true :page-beta: false diff --git a/docs/modules/clusters/partials/ucn-migrate-tip.adoc b/docs/modules/clusters/partials/ucn-migrate-tip.adoc index 1d1e58c8a..be173f1bd 100644 --- a/docs/modules/clusters/partials/ucn-migrate-tip.adoc +++ b/docs/modules/clusters/partials/ucn-migrate-tip.adoc @@ -1 +1 @@ -CAUTION: {ucd} has been deprecated and will be removed in the next major version. To continue deploying your user code after this time, Open Source users can either upgrade to Enterprise Edition, or add their resources to the Hazelcast member class paths. Hazelcast recommends that Enterprise users migrate their user code to use {ucn}. For further information on migrating from {ucd} to {ucn}, see the xref:clusters:ucn-migrate-ucd.adoc[] topic. \ No newline at end of file +CAUTION: {ucd} has been deprecated and will be removed in the next major version. To continue deploying your user code after this time, {open-source-product-name} users can either upgrade to {enterprise-product-name} Edition, or add their resources to the Hazelcast member class paths. Hazelcast recommends that {enterprise-product-name} users migrate their user code to use {ucn}. For further information on migrating from {ucd} to {ucn}, see the xref:clusters:ucn-migrate-ucd.adoc[] topic. \ No newline at end of file diff --git a/docs/modules/configuration/pages/dynamic-config-persistence.adoc b/docs/modules/configuration/pages/dynamic-config-persistence.adoc index c61f9cf2f..76a4e0427 100644 --- a/docs/modules/configuration/pages/dynamic-config-persistence.adoc +++ b/docs/modules/configuration/pages/dynamic-config-persistence.adoc @@ -38,7 +38,7 @@ If you use Kubernetes, *do not configure persistence for dynamic configuration*. See xref:dynamic-config.adoc#persistence[Persisting Dynamic Configuration in Kubernetes]. == Enabling Persistence -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* By default, persistence for dynamic configuration changes is disabled on all clusters. To start persisting changes on disk, you must first enable the feature on the member. @@ -73,7 +73,7 @@ hazelcast: [[backup]] == Creating Backups of the Configuration File -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* By default, Hazelcast keeps 5 backups of the configuration file in the member's startup directory. @@ -125,13 +125,13 @@ Use the following configuration options to configure dynamic configuration for a |dynamic-configuration | Root configuration -a| `persistence-enabled` [.enterprise]*Enterprise* +a| `persistence-enabled` [.enterprise]*{enterprise-product-name}* | Whether changes made in dynamic configuration are persisted to a configuration file. Default: false. -a| `backup-dir` [.enterprise]*Enterprise* +a| `backup-dir` [.enterprise]*{enterprise-product-name}* | Relative or absolute path to a directory in which to store backups of the configuration file. Each new backup will be created inside this directory. Default: A new directory called `dynamic-configuration-backups` is created in the member's startup directory. -a| `backup-count` [.enterprise]*Enterprise* +a| `backup-count` [.enterprise]*{enterprise-product-name}* | Number of backups of the configuration file to keep. To disable backups, set this option to 0. Default: 5. |=== diff --git a/docs/modules/configuration/pages/dynamic-config.adoc b/docs/modules/configuration/pages/dynamic-config.adoc index b5e06ee8b..749efbfc0 100644 --- a/docs/modules/configuration/pages/dynamic-config.adoc +++ b/docs/modules/configuration/pages/dynamic-config.adoc @@ -1,5 +1,5 @@ = Dynamic Configuration for Members -:description: You can use dynamic configuration to add new configuration to members at runtime or update some supported configuration such as Enterprise license keys. This feature is useful if you want to configure a running cluster without having to restart the members. +:description: You can use dynamic configuration to add new configuration to members at runtime or update some supported configuration such as {enterprise-product-name} license keys. This feature is useful if you want to configure a running cluster without having to restart the members. :keywords: dynamic configuration, update configuration {description} @@ -19,7 +19,7 @@ include::clients:partial$rest-deprecation.adoc[] These options support different dynamic configuration changes, and not all changes support <>. See the following table for what's available with each option. -NOTE: To use the REST endpoints you need an Enterprise license. +NOTE: To use the REST endpoints you need an {enterprise-product-name} license. .Supported dynamic configuration options |=== @@ -41,7 +41,7 @@ NOTE: To use the REST endpoints you need an Enterprise license. | xref:{page-latest-supported-mc}@management-center:clusters:update-config.adoc[Yes] | <> -| Update a Hazelcast Enterprise license +| Update a Hazelcast {enterprise-product-name} license | No | xref:deploy:enterprise-licenses.adoc#update[Yes] | xref:dynamic-config-update-and-reload.adoc[Yes] diff --git a/docs/modules/configuration/pages/jet-configuration.adoc b/docs/modules/configuration/pages/jet-configuration.adoc index 5ee82c346..1c2a73545 100644 --- a/docs/modules/configuration/pages/jet-configuration.adoc +++ b/docs/modules/configuration/pages/jet-configuration.adoc @@ -136,7 +136,7 @@ joins the cluster. It has no effect on jobs with auto-scaling disabled. With this feature, you can restart the whole cluster without losing the jobs and their state. It is implemented on top of Hazelcast's Persistence feature, which persists the data to disk. You need to have -the Hazelcast Enterprise edition and configure Hazelcast's Persistence to +the Hazelcast {enterprise-product-name} edition and configure Hazelcast's Persistence to use this feature. The default value is `false`, i.e., disabled. |`max-processor-accumulated-records` diff --git a/docs/modules/cp-subsystem/pages/configuration.adoc b/docs/modules/cp-subsystem/pages/configuration.adoc index 198a1ea14..ac6c2fb8c 100644 --- a/docs/modules/cp-subsystem/pages/configuration.adoc +++ b/docs/modules/cp-subsystem/pages/configuration.adoc @@ -65,7 +65,7 @@ NOTE: Running clusters must be restarted before any configuration changes take e [[persistence]] == Persisting CP Data Structures -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* To enable xref:cp-subsystem:cp-subsystem.adoc#persistence[CP Subsystem Persistence], set the <> option to `true`. @@ -474,7 +474,7 @@ config.getCPSubsystemConfig() -- ==== -|[[persistence-enabled]]`persistence-enabled` [.enterprise]*Enterprise* +|[[persistence-enabled]]`persistence-enabled` [.enterprise]*{enterprise-product-name}* |Whether <> is globally enabled for CP groups created in the CP Subsystem. If enabled, CP members persist their local CP data to stable storage and can recover from crashes. diff --git a/docs/modules/cp-subsystem/pages/cp-subsystem.adoc b/docs/modules/cp-subsystem/pages/cp-subsystem.adoc index 531a958de..f0400e778 100644 --- a/docs/modules/cp-subsystem/pages/cp-subsystem.adoc +++ b/docs/modules/cp-subsystem/pages/cp-subsystem.adoc @@ -183,7 +183,7 @@ CP members. This flexibility provides a good degree of fault tolerance at runtime. === Persistence -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* By default, CP Subsystem works in memory without persisting any state to disk. As a result, a crashed CP member cannot recover by diff --git a/docs/modules/data-connections/pages/data-connections-configuration.adoc b/docs/modules/data-connections/pages/data-connections-configuration.adoc index 9d1a4136c..0caf6a1fa 100644 --- a/docs/modules/data-connections/pages/data-connections-configuration.adoc +++ b/docs/modules/data-connections/pages/data-connections-configuration.adoc @@ -86,7 +86,7 @@ SQL:: Data connections created in SQL behave differently to those defined in members' configuration files or in Java. -- To retain SQL-defined data connections after a cluster restart, you must enable xref:storage:configuring-persistence.adoc#sql[SQL metadata persistence]. This feature is available in the Enterprise Edition. +- To retain SQL-defined data connections after a cluster restart, you must enable xref:storage:configuring-persistence.adoc#sql[SQL metadata persistence]. This feature is available in the {enterprise-product-name} Edition. - You can create or drop a data connection using SQL commands. To update a data connection, you need to drop and then recreate it. [source,sql] @@ -226,7 +226,7 @@ SQL:: -- Data connections created in SQL behave differently to those defined in members' configuration files or in Java. -- To retain SQL-defined data connections after a cluster restart, you must enable xref:storage:configuring-persistence.adoc#sql[SQL metadata persistence]. This feature is available in the Enterprise Edition. +- To retain SQL-defined data connections after a cluster restart, you must enable xref:storage:configuring-persistence.adoc#sql[SQL metadata persistence]. This feature is available in the {enterprise-product-name} Edition. - You can create or drop a data connection using SQL commands. To update a data connection, you need to drop and then recreate it. [source,sql] @@ -355,7 +355,7 @@ SQL:: -- Data connections created in SQL behave differently to those defined in members' configuration files or in Java. -- To retain SQL-defined data connections after a cluster restart, you must enable xref:storage:configuring-persistence.adoc#sql[SQL metadata persistence]. This feature is available in the Enterprise Edition. +- To retain SQL-defined data connections after a cluster restart, you must enable xref:storage:configuring-persistence.adoc#sql[SQL metadata persistence]. This feature is available in the {enterprise-product-name} Edition. - You can create or drop a data connection using SQL commands. To update a data connection, you need to drop and then recreate it. [source,SQL,subs="attributes+"] diff --git a/docs/modules/data-connections/pages/mongo-dc-configuration.adoc b/docs/modules/data-connections/pages/mongo-dc-configuration.adoc index d0f8b6452..67729014b 100644 --- a/docs/modules/data-connections/pages/mongo-dc-configuration.adoc +++ b/docs/modules/data-connections/pages/mongo-dc-configuration.adoc @@ -100,7 +100,7 @@ SQL:: -- Data connections created in SQL behave differently from those defined in members' configuration files or in Java. -- To retain SQL-defined data connections after a cluster restart, you must enable xref:storage:configuring-persistence.adoc#sql[SQL metadata persistence]. This feature is available in the Enterprise Edition. +- To retain SQL-defined data connections after a cluster restart, you must enable xref:storage:configuring-persistence.adoc#sql[SQL metadata persistence]. This feature is available in the {enterprise-product-name} Edition. - You can create or drop a data connection using SQL commands. To update a data connection, you need to drop and then recreate it. [source,SQL] diff --git a/docs/modules/data-structures/pages/cpmap.adoc b/docs/modules/data-structures/pages/cpmap.adoc index 45b6f0cae..7794c82e5 100644 --- a/docs/modules/data-structures/pages/cpmap.adoc +++ b/docs/modules/data-structures/pages/cpmap.adoc @@ -19,9 +19,9 @@ This reliability makes it ideal for storing sensitive information such as user b Due to ``CPMap``s distributed nature, above operations involve remote calls. This means that the calls might take longer to complete than non-distributed counterparts, such as ``HashMap``s. -NOTE: `CPMap` is only available in the Enterprise Edition. +NOTE: `CPMap` is only available in the {enterprise-product-name} Edition. Your license must include `ADVANCED_CP` to activate this feature and you must use the -Enterprise Edition client. +{enterprise-product-name} Edition client. There is no unsafe variant of `CPMap`, unlike other CP data structures. Therefore, CP must be xref:cp-subsystem:configuration.adoc#quickstart-configuration[enabled,window=_blank] before using `CPMap`. diff --git a/docs/modules/data-structures/pages/managing-map-memory.adoc b/docs/modules/data-structures/pages/managing-map-memory.adoc index 508bceca7..37e2f3ca3 100644 --- a/docs/modules/data-structures/pages/managing-map-memory.adoc +++ b/docs/modules/data-structures/pages/managing-map-memory.adoc @@ -108,13 +108,13 @@ cannot be determined when data is put as `OBJECT`. ** `FREE_HEAP_PERCENTAGE`: Minimum free heap size percentage for each JVM. If, for example, a JVM is configured to have 1000 MB and this value is 10, then the map entries will be evicted when free heap size is below 100 MB. -** `USED_NATIVE_MEMORY_SIZE`: ([navy]*Hazelcast Enterprise*) Maximum used native memory +** `USED_NATIVE_MEMORY_SIZE`: ([navy]*Hazelcast {enterprise-product-name}*) Maximum used native memory size in megabytes per map for each Hazelcast instance. -** `USED_NATIVE_MEMORY_PERCENTAGE`: ([navy]*Hazelcast Enterprise*) Maximum used native +** `USED_NATIVE_MEMORY_PERCENTAGE`: ([navy]*Hazelcast {enterprise-product-name}*) Maximum used native memory size percentage per map for each Hazelcast instance. -** `FREE_NATIVE_MEMORY_SIZE`: ([navy]*Hazelcast Enterprise*) Minimum free native memory +** `FREE_NATIVE_MEMORY_SIZE`: ([navy]*Hazelcast {enterprise-product-name}*) Minimum free native memory size in megabytes for each Hazelcast instance. -** `FREE_NATIVE_MEMORY_PERCENTAGE`: ([navy]*Hazelcast Enterprise*) Minimum free native +** `FREE_NATIVE_MEMORY_PERCENTAGE`: ([navy]*Hazelcast {enterprise-product-name}*) Minimum free native memory size percentage for each Hazelcast instance. [[understanding-map-eviction]] @@ -259,7 +259,7 @@ As well as the method parameters, you can also use the `map.setTtl()` method to [[forced-eviction]] == Forced Eviction for the HD Memory Store -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* Forced eviction is an automatic process that Hazelcast uses to remove data from the HD Memory Store. When your eviction policy does not free enough native memory, operations that add entries to a map or cache such as `map.put()` trigger the forced eviction process. diff --git a/docs/modules/data-structures/pages/setting-data-format.adoc b/docs/modules/data-structures/pages/setting-data-format.adoc index c4bd4bcda..3ac7061ce 100644 --- a/docs/modules/data-structures/pages/setting-data-format.adoc +++ b/docs/modules/data-structures/pages/setting-data-format.adoc @@ -29,7 +29,7 @@ To configure how the cluster will store map data, set the `in-memory-format` ele binary format. * `OBJECT`: The data is stored in deserialized form. The key is still stored in binary format. -* `NATIVE`: ([navy]*Hazelcast Enterprise*) The data is stored in serialized binary format, outside the JVM heap. +* `NATIVE`: ([navy]*Hazelcast {enterprise-product-name}*) The data is stored in serialized binary format, outside the JVM heap. [tabs] ==== @@ -62,7 +62,7 @@ hazelcast: [[using-high-density-memory-store-with-map]] == Storing Map Entries Off-Heap with High-Density Memory Store (HD Memory) -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* Hazelcast instances run within Java Virtual Machines (JVMs). JVMs use a process called Garbage Collection (GC) to manage memory utilization. GC is an interrupting process, and the larger the heap, the longer GC takes to complete. This interruption could cause your application to pause for tens of seconds (even minutes for really large heaps), badly affecting your application performance and response times. To avoid the GC delay, most JVMs are implemented with a maximum size of 4 to 8 GB. diff --git a/docs/modules/deploy/pages/deploying-with-docker.adoc b/docs/modules/deploy/pages/deploying-with-docker.adoc index 485540501..3c6a15ce2 100644 --- a/docs/modules/deploy/pages/deploying-with-docker.adoc +++ b/docs/modules/deploy/pages/deploying-with-docker.adoc @@ -21,7 +21,7 @@ Members will discover and connect to each other automatically only if your local [tabs] ==== -Open Source:: +{open-source-product-name}:: + -- [source,bash,subs="attributes+"] @@ -30,7 +30,7 @@ docker run --rm --network host --name member1 hazelcast/hazelcast:{full-version} docker run --rm --network host --name member2 hazelcast/hazelcast:{full-version} ---- -- -Enterprise:: +{enterprise-product-name}:: + -- [source,bash,subs="attributes+"] diff --git a/docs/modules/deploy/pages/enterprise-licenses.adoc b/docs/modules/deploy/pages/enterprise-licenses.adoc index dfbd82db0..ff77695ce 100644 --- a/docs/modules/deploy/pages/enterprise-licenses.adoc +++ b/docs/modules/deploy/pages/enterprise-licenses.adoc @@ -1,14 +1,14 @@ -= Managing Enterprise License Keys -:description: To use Hazelcast Enterprise, you need an Enterprise license key. This topic explains how to get a license key, install it on a member, and manage it. += Managing {enterprise-product-name} License Keys +:description: To use Hazelcast {enterprise-product-name}, you need an {enterprise-product-name} license key. This topic explains how to get a license key, install it on a member, and manage it. :page-aliases: installing-license-keys.adoc, monitoring-license-keys.adoc, renewing-license-keys.adoc, deploy:updating-license-rest.adoc :page-enterprise: true {description} -== Getting an Enterprise License Key +== Getting an Enterpr{enterprise-product-name}ise License Key // tag::get-license[] -Hazelcast Enterprise requires a license key. You can get a +Hazelcast {enterprise-product-name} requires a license key. You can get a 30-day trial license from the link:https://hazelcast.com/get-started[Hazelcast website]. [[license-key-format]]License keys have the following format: @@ -40,10 +40,10 @@ NOTE: These licenses are examples and will not work if you install them on membe == Configuring a License Key on Members // tag::install-license[] -To use Hazelcast Enterprise, you need to configure a license +To use Hazelcast {enterprise-product-name}, you need to configure a license key on all members in a cluster. -NOTE: Hazelcast Enterprise license keys are required only for members. +NOTE: Hazelcast {enterprise-product-name} license keys are required only for members. You do not need to set a license key for Java clients that are connected to members. [tabs] @@ -54,7 +54,7 @@ XML:: [source,xml] ---- - Your Enterprise License Key + Your {enterprise-product-name} License Key ---- -- @@ -66,7 +66,7 @@ YAML:: [source,yaml] ---- hazelcast: - license-key: Your Enterprise License Key + license-key: Your {enterprise-product-name} License Key ---- -- Java:: @@ -77,7 +77,7 @@ Add your license to the link:https://docs.hazelcast.org/docs/{full-version}/java [source,java] ---- Config config = new Config(); -config.setLicenseKey( "Your Enterprise License Key" ); +config.setLicenseKey( "Your {enterprise-product-name} License Key" ); ---- -- @@ -86,7 +86,7 @@ Environment Variable:: -- [source,shell] ---- -HZ_LICENSEKEY= +HZ_LICENSEKEY= ---- -- @@ -95,7 +95,7 @@ System Property:: -- [source,shell] ---- --Dhazelcast.enterprise.license.key= +-Dhazelcast.enterprise.license.key= ---- -- ==== diff --git a/docs/modules/getting-started/pages/authenticate-clients.adoc b/docs/modules/getting-started/pages/authenticate-clients.adoc index db3632d97..84937308c 100644 --- a/docs/modules/getting-started/pages/authenticate-clients.adoc +++ b/docs/modules/getting-started/pages/authenticate-clients.adoc @@ -8,7 +8,7 @@ By default, members allow connections from any Hazelcast client. So, any client In this tutorial, you will complete the following steps: -. Enable and configure authentication credentials for a Hazelcast Enterprise member. +. Enable and configure authentication credentials for a Hazelcast {enterprise-product-name} member. . Configure a client with the correct credentials and connect it to the member. . Try to connect an unauthorized client to the member, and see that it is denied. @@ -20,12 +20,12 @@ To complete this tutorial, you need the following: |=== |Prerequisites|Useful resources -|Docker image for Hazelcast Enterprise and an Enterprise license +|Docker image for Hazelcast {enterprise-product-name} and an {enterprise-product-name} license |xref:getting-started:enterprise-overview.adoc[] |=== -== Step 1. Configure the Enterprise Member +== Step 1. Configure the {enterprise-product-name} Member Before a member can authenticate a client, the member must be configured with security enabled and some credentials to ask the client for. @@ -75,7 +75,7 @@ XML:: ---- ==== -<1> Replace the `` placeholder with your Hazelcast Enterprise license key. +<1> Replace the `` placeholder with your Hazelcast {enterprise-product-name} license key. <2> Set to `true` to enable security so that the clients can be authenticated by the member. <3> Name of the security realm to be passed to the authentication configuration; it is set to `passwordRealm` in this example for convenience. <4> Identity configuration element to set the credentials (username and password) to be used by the member for client authentication. @@ -302,5 +302,5 @@ move to the other tutorials. To shut down the cluster, close the terminals in wh If you're interested in learning more about the topics introduced in this tutorial, see xref:security:overview.adoc[] -To continue learning about Enterprise features, see xref:getting-started:wan.adoc[Replicate over WAN], which shows you how to replicate map entries across different clusters. +To continue learning about {enterprise-product-name} features, see xref:getting-started:wan.adoc[Replicate over WAN], which shows you how to replicate map entries across different clusters. diff --git a/docs/modules/getting-started/pages/blue-green.adoc b/docs/modules/getting-started/pages/blue-green.adoc index 3269787a7..082c31ae6 100644 --- a/docs/modules/getting-started/pages/blue-green.adoc +++ b/docs/modules/getting-started/pages/blue-green.adoc @@ -15,7 +15,7 @@ In both cases, you will need to manually deploy a xref:{page-latest-supported-mc This tutorial focuses on the disaster recovery scenario, where you will complete the following steps: -. Start two Enterprise clusters: One for the blue deployment, one for the green deployment. +. Start two {enterprise-product-name} clusters: One for the blue deployment, one for the green deployment. . Configure a client to use the blue-green deployment as a failover. . Connect the client to the blue cluster. . Shut down the blue cluster and see that the client connects to the green one. @@ -31,7 +31,7 @@ To complete this tutorial, you need the following: |=== |Prerequisites|Useful resources -|Docker image for Hazelcast Enterprise and an Enterprise license +|Docker image for Hazelcast {enterprise-product-name} and an {enterprise-product-name} license |xref:getting-started:enterprise-overview.adoc[] |Docker network with the name `hazelcast-network` @@ -39,10 +39,10 @@ To complete this tutorial, you need the following: |=== -== Step 1. Start the Blue Enterprise Cluster +== Step 1. Start the Blue Enterp{enterprise-product-name}rise Cluster -In this step, you use the Hazelcast Enterprise Docker image to start a local single-member cluster called `blue`. -This step also installs your Enterprise license key. +In this step, you use the Hazelcast {enterprise-product-name}{enterprise-product-name} Docker image to start a local single-member cluster called `blue`. +This step also installs your {enterprise-product-name} license key. Run the following command on the terminal: @@ -57,7 +57,7 @@ docker run \ -p 5701:5701 hazelcast/hazelcast-enterprise:{full-version} ---- <1> Replace the `` placeholder with the IP address of your Docker host. -<2> Replace the `` placeholder with your Hazelcast Enterprise license key. +<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. @@ -72,7 +72,7 @@ Members {size:1, ver:1} [ 2021-12-01 18:26:42,384 [ INFO] [main] [c.h.c.LifecycleService]: [172.18.0.2]:5701 [blue] [{full-version}] [172.18.0.2]:5701 is STARTED ---- -== Step 2. Start the Green Enterprise Cluster +== Step 2. Start the Green {enterprise-product-name} Cluster Start another local single-member cluster called `green`. @@ -87,7 +87,7 @@ docker run \ -p 5702:5701 hazelcast/hazelcast-enterprise:{full-version} ---- <1> Replace the `` placeholder with the IP address of your Docker host. -<2> Replace the `` placeholder with your Hazelcast Enterprise license key. +<2> Replace the `` placeholder with your Hazelcast {enterprise-product-name} license key. See the `green` cluster is formed: @@ -102,7 +102,7 @@ Members {size:1, ver:1} [ 2021-12-01 18:28:46,321 [ INFO] [main] [c.h.c.LifecycleService]: [172.18.0.3]:5701 [green] [{full-version}] [172.18.0.3]:5701 is STARTED ---- -Now, you have two separate Hazelcast Enterprise clusters running locally. +Now, you have two separate Hazelcast {enterprise-product-name} clusters running locally. [[step-3]] == Step 3. Configure the Client diff --git a/docs/modules/getting-started/pages/editions.adoc b/docs/modules/getting-started/pages/editions.adoc index 55d8d1f90..8a7aa8bfc 100644 --- a/docs/modules/getting-started/pages/editions.adoc +++ b/docs/modules/getting-started/pages/editions.adoc @@ -1,16 +1,16 @@ = Hazelcast Editions and Distributions -:description: Hazelcast offers Enterprise and Open Source editions of its member software, each available as either a full or slim distribution. +:description: Hazelcast offers {enterprise-product-name} and {open-source-product-name} editions of its member software, each available as either a full or slim distribution. :page-aliases: before-you-begin.adoc {description} -== Enterprise Edition +== {enterprise-product-name} Edition -Hazelcast Enterprise edition is a commercial product that extends the Open Source offering to provide you with many benefits, including the security suite, blue/green deployments for clients, and a xref:support#customer-support.adoc[Hazelcast Customer Support] subscription. +Hazelcast {enterprise-product-name} edition is a commercial product that extends the {open-source-product-name} offering to provide you with many benefits, including the security suite, blue/green deployments for clients, and a xref:support#customer-support.adoc[Hazelcast Customer Support] subscription. -TIP: In this documentation, topics related to an Enterprise edition feature include an [.enterprise]*Enterprise* label. +TIP: In this documentation, topics related to an {enterprise-product-name} edition feature include an [.enterprise]*{enterprise-product-name}* label. -The Enterprise edition offers the following features, which are not available in the Open Source edition: +The {enterprise-product-name} edition offers the following features, which are not available in the {open-source-product-name} edition: * xref:security:overview.adoc[Security suite] * xref:wan:wan.adoc[] @@ -27,16 +27,16 @@ The Enterprise edition offers the following features, which are not available in NOTE: All pre-existing Hazelcast licenses, such as the Pro/Enterprise/Enterprise HD licenses, are valid for Hazelcast Platform. -== Open Source Edition +== {open-source-product-name} Edition -Hazelcast Open Source edition is free and covered by an Apache License, Version 2.0 +Hazelcast {open-source-product-name} edition is free and covered by an Apache License, Version 2.0 and a https://hazelcast.com/hazelcast-community-license/[Hazelcast Community License]. The permissions granted in these licenses allow you to do the following: -* Use the Open Source edition -* Reproduce the Open Source edition -* Distribute the Open Source edition with any open and/or closed source applications +* Use the {open-source-product-name} edition +* Reproduce the {open-source-product-name} edition +* Distribute the {open-source-product-name} edition with any open and/or closed source applications == Full and Slim Distributions [[full-slim]] @@ -51,8 +51,8 @@ Other installation options offer only the full distribution. You can find more information on installing the Hazelcast editions in the following topics: -* For the Enterprise edition, see the xref:install-enterprise.adoc[] topic -* For the Open Source edition, see the xref:install-hazelcast.adoc[] topic +* For the {enterprise-product-name} edition, see the xref:install-enterprise.adoc[] topic +* For the {open-source-product-name} edition, see the xref:install-hazelcast.adoc[] topic === Full Distribution diff --git a/docs/modules/getting-started/pages/enterprise-overview.adoc b/docs/modules/getting-started/pages/enterprise-overview.adoc index b581ccee4..204f5f279 100644 --- a/docs/modules/getting-started/pages/enterprise-overview.adoc +++ b/docs/modules/getting-started/pages/enterprise-overview.adoc @@ -1,14 +1,14 @@ -= Get Started with Hazelcast Enterprise -:description: This series of tutorials showcases some of the most useful features of Hazelcast Enterprise. += Get Started with Hazelcast {enterprise-product-name} +:description: This series of tutorials showcases some of the most useful features of Hazelcast {enterprise-product-name}. :page-enterprise: true {description} -== Step 1. Pull the Hazelcast Enterprise Docker Image +== Step 1. Pull the Hazelcast {enterprise-product-name} Docker Image include::install-enterprise.adoc[tag=docker] -== Step 2. Get your Enterprise License +== Step 2. Get your {enterprise-product-name} License include::deploy:enterprise-licenses.adoc[tag=get-license] diff --git a/docs/modules/getting-started/pages/get-started-binary.adoc b/docs/modules/getting-started/pages/get-started-binary.adoc index 91066f0b1..93946034a 100644 --- a/docs/modules/getting-started/pages/get-started-binary.adoc +++ b/docs/modules/getting-started/pages/get-started-binary.adoc @@ -20,7 +20,7 @@ xref:getting-started:install-hazelcast.adoc#using-modular-java[Using Modular Jav |A full Hazelcast distribution |xref:getting-started:install-hazelcast.adoc#using-the-binary[Install Hazelcast] -xref:getting-started:install-enterprise.adoc[Install Hazelcast Enterprise] +xref:getting-started:install-enterprise.adoc[Install Hazelcast {enterprise-product-name}] |Your internal IP address |link:https://lifehacker.com/how-to-find-your-local-and-external-ip-address-5833108[How to Find Your Internal IP Address^] diff --git a/docs/modules/getting-started/pages/install-enterprise.adoc b/docs/modules/getting-started/pages/install-enterprise.adoc index dc31c65b2..6063db240 100644 --- a/docs/modules/getting-started/pages/install-enterprise.adoc +++ b/docs/modules/getting-started/pages/install-enterprise.adoc @@ -1,16 +1,16 @@ -= Installing Hazelcast Enterprise -:description: pass:q[To install Hazelcast Enterprise, you can use Docker, the binary, or Java. To unlock the Enterprise features, you must install your Enterprise license key.] += Installing Hazelcast {enterprise-product-name} +:description: pass:q[To install Hazelcast {enterprise-product-name}, you can use Docker, the binary, or Java. To unlock the {enterprise-product-name} features, you must install your {enterprise-product-name} license key.] :page-aliases: deploy:using-enterprise-edition.adoc, get-started-enterprise.adoc {description} -NOTE: These instructions apply only to the licensed Enterprise edition, which provides additional features such as the security suite and blue/green client deployment. If you have the Open Source edition, follow the instructions in the xref:install-hazelcast.adoc[] topic. +NOTE: These instructions apply only to the licensed {enterprise-product-name} edition, which provides additional features such as the security suite and blue/green client deployment. If you have the {open-source-product-name} edition, follow the instructions in the xref:install-hazelcast.adoc[] topic. Both slim and full distributions are available. For further information on the available editions and distributions, see the xref:editions.adoc[] topic. To install a slim distribution, append `-slim` to the version number in the commands shown in the following sections; for example, to install the slim distribution of {full-version}, use `{full-version}-slim`. -== Using the Enterprise Docker Image +== Using the {enterprise-product-name} Docker Image // tag::docker[] . link:https://docs.docker.com/get-docker/[Install Docker^]. @@ -26,7 +26,7 @@ docker version // end::docker[] . xref:get-started-docker.adoc[Start the cluster]. -== Using the Enterprise Binary +== Using the {enterprise-product-name} Binary Download and extract the binaries. @@ -64,7 +64,7 @@ endif::[] To start the cluster, see xref:get-started-binary.adoc[]. -== Using Enterprise Java +== Using {enterprise-product-name} Java include::install-hazelcast.adoc[tag=java] @@ -135,21 +135,21 @@ endif::[] include::install-hazelcast.adoc[tag=modular] -== Getting an Enterprise License Key +== Getting an {enterprise-product-name} License Key include::deploy:enterprise-licenses.adoc[tag=get-license] -== Installing an Enterprise License Key +== Installing an {enterprise-product-name} License Key include::deploy:enterprise-licenses.adoc[tag=install-license] == Next Steps -Learn more about xref:deploy:enterprise-licenses.adoc[Enterprise license keys]. +Learn more about xref:deploy:enterprise-licenses.adoc[{enterprise-product-name} license keys]. -Get started with the Hazelcast Enterprise features with a series of xref:enterprise-overview.adoc[tutorials]. +Get started with the Hazelcast {enterprise-product-name} features with a series of xref:enterprise-overview.adoc[tutorials]. -.Explore the Hazelcast Enterprise features in more detail +.Explore the Hazelcast {enterprise-product-name} features in more detail [%collapsible] ==== * xref:security:overview.adoc[Security suite] diff --git a/docs/modules/getting-started/pages/install-hazelcast.adoc b/docs/modules/getting-started/pages/install-hazelcast.adoc index 7b8a2d10c..267857088 100644 --- a/docs/modules/getting-started/pages/install-hazelcast.adoc +++ b/docs/modules/getting-started/pages/install-hazelcast.adoc @@ -1,10 +1,10 @@ -= Installing Hazelcast Open Source -:description: pass:q[You can install the Open Source edition of Hazelcast, using the command line interface (CLI), Docker, the binary, or Java.] += Installing Hazelcast {open-source-product-name} +:description: pass:q[You can install the {open-source-product-name} edition of Hazelcast, using the command line interface (CLI), Docker, the binary, or Java.] :page-aliases: installing-using-download-archives.adoc, deploy:running-in-modular-java.adoc {description} -NOTE: These instructions apply only to the Open Source edition. If you have a license, which allows you to take advantage of the additional features offered by Enterprise edition, follow the instructions in the xref:install-enterprise.adoc[] topic. +NOTE: These instructions apply only to the {open-source-product-name} edition. If you have a license, which allows you to take advantage of the additional features offered by {enterprise-product-name} edition, follow the instructions in the xref:install-enterprise.adoc[] topic. Both slim and full distributions are available. For further information on the available editions and distributions, see the xref:editions.adoc[] topic. @@ -20,7 +20,7 @@ To install a slim distribution, append `-slim` to the version number in the comm Hazelcast offers package managers for Linux and Mac operating systems. -Package managers are the fastest way of installing Hazelcast. This option is for development purposes and is only available for Hazelcast Open Source. For production, use the other deployment options explained on this page. +Package managers are the fastest way of installing Hazelcast. This option is for development purposes and is only available for Hazelcast {open-source-product-name}. For production, use the other deployment options explained on this page. // tag::cli[] . To install Hazelcast, use one of the following methods, depending on your operating system: diff --git a/docs/modules/getting-started/pages/persistence.adoc b/docs/modules/getting-started/pages/persistence.adoc index 29132e222..80af5bec6 100644 --- a/docs/modules/getting-started/pages/persistence.adoc +++ b/docs/modules/getting-started/pages/persistence.adoc @@ -11,7 +11,7 @@ can use Hazelcast's Persistence feature to persist data on disk. In this tutorial, you will complete the following steps: -. Start a Hazelcast Enterprise cluster with three members and Persistence enabled. +. Start a Hazelcast {enterprise-product-name} cluster with three members and Persistence enabled. . Create a map with data in it. . Shut down the whole cluster to simulate a graceful shutdown, such as for maintenance purposes. . Restart the cluster and see that the map entries are restored from disk and put back in memory. @@ -24,7 +24,7 @@ To complete this tutorial, you need the following: |=== |Prerequisites|Useful resources -|Docker image for Hazelcast Enterprise and an Enterprise license +|Docker image for Hazelcast {enterprise-product-name} and an {enterprise-product-name} license |xref:getting-started:enterprise-overview.adoc[] |Docker network with the name `hazelcast-network` @@ -50,7 +50,7 @@ docker run \ -p 5701:5701 hazelcast/hazelcast-enterprise:{full-version} ---- <1> Replace the `` placeholder with the IP address of your Docker host. -<2> Replace the `` placeholder with your Hazelcast Enterprise license key. +<2> Replace the `` placeholder with your Hazelcast {enterprise-product-name} license key. <3> The environment variable to enable the persistence feature for the member <4> The environment variable to enable the persistence feature for a map <5> By default, the persistence feature creates the `/opt/hazelcast/persistence` directory to store the persisted data. @@ -77,7 +77,7 @@ Run each of the following Docker commands in a separate terminal. Replace the `` placeholders with the IP address of your Docker host. -Replace the `` placeholders with your Hazelcast Enterprise license key. +Replace the `` placeholders with your Hazelcast {enterprise-product-name} license key. .Command to start a second member. [source,shell,subs="attributes+"] diff --git a/docs/modules/getting-started/pages/wan.adoc b/docs/modules/getting-started/pages/wan.adoc index 3d730a2d1..ebe75e5c7 100644 --- a/docs/modules/getting-started/pages/wan.adoc +++ b/docs/modules/getting-started/pages/wan.adoc @@ -13,7 +13,7 @@ for the purpose of maintaining a backup. If the active cluster becomes unavailab In this tutorial, you will complete the following steps: -. Start a passive Enterprise cluster, without WAN Replication, which will receive updates from the active cluster. +. Start a passive {enterprise-product-name} cluster, without WAN Replication, which will receive updates from the active cluster. . Start an active cluster, with WAN Replication configured, which will send updates to the passive cluster. . Create a map in the active cluster and see that the entries are replicated on the passive cluster. . Modify some map entries in the active cluster and see the modifications appear in the passive one. @@ -26,7 +26,7 @@ To complete this tutorial, you need the following: |=== |Prerequisites|Useful resources -|Docker image for Hazelcast Enterprise and an Enterprise license +|Docker image for Hazelcast {enterprise-product-name} and an {enterprise-product-name} license |xref:getting-started:enterprise-overview.adoc[] |Docker network with the name `hazelcast-network` @@ -36,7 +36,7 @@ To complete this tutorial, you need the following: == Step 1. Start the Passive Cluster -In this step you'll start an Enterprise cluster called `london` with a single member. This will be 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 does not need WAN Replication to be configured. Run the following Docker command in a terminal. [source,shell,subs="attributes+"] @@ -49,7 +49,7 @@ docker run \ hazelcast/hazelcast-enterprise:{full-version} ---- <1> Replace the `` placeholder with the IP address of your Docker host. -<2> Replace the `` placeholder with your Hazelcast Enterprise license key. +<2> Replace the `` placeholder with your Hazelcast {enterprise-product-name} license key. The member is up and running now. @@ -64,7 +64,7 @@ Members {size:1, ver:1} [ == Step 2. Start the Active Cluster -Now you'll start another Enterprise cluster called `tokyo` with a single member. This will be the **active** cluster +Now you'll start another {enterprise-product-name} cluster called `tokyo` with a single member. This will be the **active** cluster which means it needs WAN Replication to be configured. Since the configuration for WAN Replication is a bit more detailed, you are going to use a Hazelcast configuration diff --git a/docs/modules/getting-started/partials/nav.adoc b/docs/modules/getting-started/partials/nav.adoc index 1d3702b94..f21687629 100644 --- a/docs/modules/getting-started/partials/nav.adoc +++ b/docs/modules/getting-started/partials/nav.adoc @@ -3,7 +3,7 @@ ** xref:getting-started:get-started-docker.adoc[Docker] ** xref:getting-started:get-started-binary.adoc[Binary] ** xref:getting-started:get-started-java.adoc[Java Embedded] -* Explore Enterprise Features +* Explore {enterprise-product-name} Features ** xref:getting-started:enterprise-overview.adoc[] ** xref:getting-started:persistence.adoc[] ** xref:getting-started:authenticate-clients.adoc[] diff --git a/docs/modules/integrate/pages/elasticsearch-connector.adoc b/docs/modules/integrate/pages/elasticsearch-connector.adoc index 56f51f47f..291a423cf 100644 --- a/docs/modules/integrate/pages/elasticsearch-connector.adoc +++ b/docs/modules/integrate/pages/elasticsearch-connector.adoc @@ -12,7 +12,7 @@ To use this connector in the slim distribution, you must have the `hazelcast-jet Each module includes an Elasticsearch client that's compatible with the given major version of Elasticsearch. The connector API is the same between different versions, apart from a few minor differences where we surface the API of Elasticsearch client. See the link:https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/jet/elastic/ElasticSources.html[Javadoc] for any such differences. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, your clients may need permissions to use this connector. For details, see xref:pipelines:job-security.adoc[]. diff --git a/docs/modules/integrate/pages/file-connector.adoc b/docs/modules/integrate/pages/file-connector.adoc index 9e7fa25e1..65bd40810 100644 --- a/docs/modules/integrate/pages/file-connector.adoc +++ b/docs/modules/integrate/pages/file-connector.adoc @@ -16,7 +16,7 @@ To access Hadoop or any of the cloud-based file systems, you may need to add one Depending on the <>, you may also need to add other modules to the classpath. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set up permissions to restrict clients' access to your files. For details, see xref:pipelines:job-security.adoc[]. diff --git a/docs/modules/integrate/pages/jcache-connector.adoc b/docs/modules/integrate/pages/jcache-connector.adoc index 807d6f43b..03862bfb9 100644 --- a/docs/modules/integrate/pages/jcache-connector.adoc +++ b/docs/modules/integrate/pages/jcache-connector.adoc @@ -9,6 +9,6 @@ This connector is included in the full and slim distributions of Hazelcast. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set up permissions to restrict clients' access to these data structures. For details, see xref:security:native-client-security.adoc[]. \ No newline at end of file diff --git a/docs/modules/integrate/pages/kafka-connect-connectors.adoc b/docs/modules/integrate/pages/kafka-connect-connectors.adoc index bdfb8705f..89f260230 100644 --- a/docs/modules/integrate/pages/kafka-connect-connectors.adoc +++ b/docs/modules/integrate/pages/kafka-connect-connectors.adoc @@ -47,7 +47,7 @@ Every Kafka Connect Source connector comes with documentation that includes the - Configuration details == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, your clients may need updated permissions to upload the ZIP or JAR file used by the Kafka Connect Source Connector. For details, see xref:pipelines:job-security.adoc[]. diff --git a/docs/modules/integrate/pages/kafka-connector.adoc b/docs/modules/integrate/pages/kafka-connector.adoc index 570a54c93..2ea9553d5 100644 --- a/docs/modules/integrate/pages/kafka-connector.adoc +++ b/docs/modules/integrate/pages/kafka-connector.adoc @@ -15,7 +15,7 @@ This connector is included in the full distribution of Hazelcast. If you're using the slim distribution, you must add the link:https://mvnrepository.com/artifact/com.hazelcast.jet/hazelcast-jet-kafka/{full-version}[`hazelcast-jet-kafka` module] to your member's classpath. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, your clients may need permissions to use this connector. For details, see xref:pipelines:job-security.adoc[]. diff --git a/docs/modules/integrate/pages/legacy-file-connector.adoc b/docs/modules/integrate/pages/legacy-file-connector.adoc index 05aa38870..3d945d19c 100644 --- a/docs/modules/integrate/pages/legacy-file-connector.adoc +++ b/docs/modules/integrate/pages/legacy-file-connector.adoc @@ -20,7 +20,7 @@ To access Hadoop or any of the cloud-based file systems, add one of the download <> to your members' classpaths. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set up permissions to restrict clients' access to your files. For details, see xref:pipelines:job-security.adoc[]. diff --git a/docs/modules/integrate/pages/list-connector.adoc b/docs/modules/integrate/pages/list-connector.adoc index 8bff720ea..ae797c976 100644 --- a/docs/modules/integrate/pages/list-connector.adoc +++ b/docs/modules/integrate/pages/list-connector.adoc @@ -9,7 +9,7 @@ member. This connector is included in the full and slim distributions of Hazelcast. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set up permissions to restrict clients' access to these data structures. For details, see xref:security:native-client-security.adoc[]. diff --git a/docs/modules/integrate/pages/map-connector.adoc b/docs/modules/integrate/pages/map-connector.adoc index 4a66c4d63..fcb21722e 100644 --- a/docs/modules/integrate/pages/map-connector.adoc +++ b/docs/modules/integrate/pages/map-connector.adoc @@ -9,7 +9,7 @@ This connector is included in the full and slim distributions of Hazelcast. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set up permissions to restrict clients' access to these data structures. diff --git a/docs/modules/integrate/pages/reliable-topic-connector.adoc b/docs/modules/integrate/pages/reliable-topic-connector.adoc index 637b95b21..b0a898813 100644 --- a/docs/modules/integrate/pages/reliable-topic-connector.adoc +++ b/docs/modules/integrate/pages/reliable-topic-connector.adoc @@ -9,7 +9,7 @@ The map connector is included in the full and slim distributions of Hazelcast. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set up permissions to restrict clients' access to these data structures. For details, see xref:security:native-client-security.adoc[]. diff --git a/docs/modules/jcache/pages/icache.adoc b/docs/modules/jcache/pages/icache.adoc index 0f1976d41..edd64ab7f 100644 --- a/docs/modules/jcache/pages/icache.adoc +++ b/docs/modules/jcache/pages/icache.adoc @@ -664,7 +664,7 @@ Caches are generally not expected to grow to an infinite size. Implementing an prevent infinite growth, but sometimes it is hard to define a meaningful expiration timeout. Therefore, Hazelcast JCache provides the eviction feature. Eviction offers the possibility of removing entries based on the cache size or amount of used memory -(Hazelcast Enterprise Only) and not based on timeouts. +(Hazelcast {enterprise-product-name} Only) and not based on timeouts. IMPORTANT: By default, eviction for Hazelcast JCache is enabled (it cannot be disabled), and its default value is <>. Hence, it is not possible to <> Hazelcast JCache without eviction. diff --git a/docs/modules/kubernetes/pages/helm-hazelcast-chart.adoc b/docs/modules/kubernetes/pages/helm-hazelcast-chart.adoc index 94abba40b..2a9a9ff9a 100644 --- a/docs/modules/kubernetes/pages/helm-hazelcast-chart.adoc +++ b/docs/modules/kubernetes/pages/helm-hazelcast-chart.adoc @@ -1,4 +1,4 @@ -= Deploying Hazelcast Open Source on Kubernetes with Helm += Deploying Hazelcast {open-source-product-name} on Kubernetes with Helm :description: This chart bootstraps a link:https://github.com/hazelcast/hazelcast-docker/tree/master/hazelcast-oss[Hazelcast] and link:https://github.com/hazelcast/management-center-docker[Management Center] deployments on a link:http://kubernetes.io[Kubernetes] cluster using the link:https://helm.sh[Helm] package manager. {description} diff --git a/docs/modules/kubernetes/pages/helm-hazelcast-enterprise-chart.adoc b/docs/modules/kubernetes/pages/helm-hazelcast-enterprise-chart.adoc index 55c03ecf6..2a9f174c2 100644 --- a/docs/modules/kubernetes/pages/helm-hazelcast-enterprise-chart.adoc +++ b/docs/modules/kubernetes/pages/helm-hazelcast-enterprise-chart.adoc @@ -1,5 +1,5 @@ -= Deploying Hazelcast Enterprise on Kubernetes with Helm -:description: This chart bootstraps a link:https://github.com/hazelcast/hazelcast-docker/tree/master/hazelcast-enterprise[Hazelcast Enterprise] and link:https://github.com/hazelcast/management-center-docker[Management Center] deployments on a link:http://kubernetes.io[Kubernetes] cluster using the link:https://helm.sh[Helm] package manager. += Deploying Hazelcast {enterprise-product-name} on Kubernetes with Helm +:description: This chart bootstraps a link:https://github.com/hazelcast/hazelcast-docker/tree/master/hazelcast-enterprise[Hazelcast {enterprise-product-name}] and link:https://github.com/hazelcast/management-center-docker[Management Center] deployments on a link:http://kubernetes.io[Kubernetes] cluster using the link:https://helm.sh[Helm] package manager. :page-enterprise: true {description} @@ -15,7 +15,7 @@ == Quickstart -Hazelcast Platform Enterprise requires a license key. If you don't have a license key, you can request one at the link:http://trialrequest.hazelcast.com/[Hazelcast website]. +Hazelcast Platform {enterprise-product-name} requires a license key. If you don't have a license key, you can request one at the link:http://trialrequest.hazelcast.com/[Hazelcast website]. [source,shell] ---- @@ -98,7 +98,7 @@ helm install my-release hazelcast/hazelcast -f values.yaml TIP: You can use the default `values.yaml` with the `hazelcast.license` filled in. -NOTE: Some of the Hazelcast Enterprise features requires setting `securityContext.readOnlyRootFilesystem` parameter to `false`. This is the case for the Hot Restart feature or enabling security with OpenSSL. In such cases where `readOnlyRootFilesystem` needs to be set to `true` (i.e. a Pod Security Policy requirement), for Hot Restart to work the JVM parameter `-Djava.io.tmpdir` should be set to a writable location (for example a xref:kubernetes:helm-adding-custom-jar.adoc[custom volume]). +NOTE: Some of the Hazelcast {enterprise-product-name} features requires setting `securityContext.readOnlyRootFilesystem` parameter to `false`. This is the case for the Hot Restart feature or enabling security with OpenSSL. In such cases where `readOnlyRootFilesystem` needs to be set to `true` (i.e. a Pod Security Policy requirement), for Hot Restart to work the JVM parameter `-Djava.io.tmpdir` should be set to a writable location (for example a xref:kubernetes:helm-adding-custom-jar.adoc[custom volume]). == Notable changes @@ -136,4 +136,4 @@ persistence: === 5.9.0 -The section `mcm` are no longer available so the chart will not create required resources to list Hazelcast Platform Enterprise at IBM CP4MCM(Cloud Pak for Multicloud Management). +The section `mcm` are no longer available so the chart will not create required resources to list Hazelcast Platform {enterprise-product-name} at IBM CP4MCM(Cloud Pak for Multicloud Management). diff --git a/docs/modules/kubernetes/pages/kubernetes-auto-discovery.adoc b/docs/modules/kubernetes/pages/kubernetes-auto-discovery.adoc index 485bf1240..170bb1693 100644 --- a/docs/modules/kubernetes/pages/kubernetes-auto-discovery.adoc +++ b/docs/modules/kubernetes/pages/kubernetes-auto-discovery.adoc @@ -274,7 +274,7 @@ NOTE: All these properties are already set in link:https://docs.hazelcast.com/op - `-Dhazelcast.shutdownhook.policy=GRACEFUL`: in the JVM parameters - `-Dhazelcast.graceful.shutdown.max.wait`: in the JVM parameters; the value should be high enough to cover the data migration process - If you use Deployment (not StatefulSet), you need to set your strategy to link:https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#updating-a-deployment[RollingUpdate] and ensure Pods are updated one by one. -- If you upgrade by the minor version, e.g., `3.11.4 => 3.12` (Enterprise feature), you need to set the `-Dhazelcast.cluster.version.auto.upgrade.enabled=true` JVM property to make sure the cluster version updates automatically. +- If you upgrade by the minor version, e.g., `3.11.4 => 3.12` ({enterprise-product-name} feature), you need to set the `-Dhazelcast.cluster.version.auto.upgrade.enabled=true` JVM property to make sure the cluster version updates automatically. == Discovering Members from Hazelcast Clients @@ -347,4 +347,4 @@ For the complete example, please check link:https://guides.hazelcast.org/kuberne If your Hazelcast cluster is deployed on Kubernetes, but your Hazelcast client is in a completely different network, then it can connect only through the public Internet. This requires exposing each Hazelcast member pod with a dedicated NodePort or LoadBalancer Kubernetes service. For details and a complete example, please check link:https://guides.hazelcast.org/kubernetes-external-client/[Hazelcast Guides: Connect External Hazelcast Client to Kubernetes]. -NOTE: For information on configuring persistence in Kubernetes environments, see xref:kubernetes:kubernetes-persistence.adoc[Running Hazelcast Enterprise with Persistence under Kubernetes]. \ No newline at end of file +NOTE: For information on configuring persistence in Kubernetes environments, see xref:kubernetes:kubernetes-persistence.adoc[Running Hazelcast {enterprise-product-name} with Persistence under Kubernetes]. \ No newline at end of file diff --git a/docs/modules/kubernetes/pages/kubernetes-persistence.adoc b/docs/modules/kubernetes/pages/kubernetes-persistence.adoc index c51b96a81..de4632fb0 100644 --- a/docs/modules/kubernetes/pages/kubernetes-persistence.adoc +++ b/docs/modules/kubernetes/pages/kubernetes-persistence.adoc @@ -1,8 +1,8 @@ -= Running Hazelcast Enterprise with Persistence under Kubernetes -:description: Hazelcast Enterprise members configured with persistence enabled can monitor the Kubernetes (K8s) context and automate Hazelcast cluster state management to ensure the optimal cluster behavior during shutdown and restart. += Running Hazelcast {enterprise-product-name} with Persistence under Kubernetes +:description: Hazelcast {enterprise-product-name} members configured with persistence enabled can monitor the Kubernetes (K8s) context and automate Hazelcast cluster state management to ensure the optimal cluster behavior during shutdown and restart. :page-enterprise: true -Hazelcast Enterprise members configured with xref:storage:configuring-persistence.adoc[persistence] enabled can monitor the Kubernetes (K8s) context and automate Hazelcast cluster state management to ensure optimal cluster behavior during shutdown and restart. +Hazelcast {enterprise-product-name} members configured with xref:storage:configuring-persistence.adoc[persistence] enabled can monitor the Kubernetes (K8s) context and automate Hazelcast cluster state management to ensure optimal cluster behavior during shutdown and restart. TIP: We recommend you use Hazelcast Platform Operator - see the https://docs.hazelcast.com/operator/latest/[Hazelcast Platform Operator Documentation] for more information and find details about deploying a Hazelcast cluster in Kubernetes and also connecting clients outside Kubernetes. diff --git a/docs/modules/kubernetes/pages/troubleshooting-and-limitations.adoc b/docs/modules/kubernetes/pages/troubleshooting-and-limitations.adoc index be0277048..b57e54c17 100644 --- a/docs/modules/kubernetes/pages/troubleshooting-and-limitations.adoc +++ b/docs/modules/kubernetes/pages/troubleshooting-and-limitations.adoc @@ -5,7 +5,7 @@ == Limitations -Hazelcast CP Subsystem can be used safely in Kubernetes only if xref:cp-subsystem:configuration.adoc#cp-subsystem-configuration[CP Subsystem Persistence] is enabled (Enterprise Feature). Otherwise, a CP Subsystem Group may not recover after scaling the cluster or a rolling upgrade. +Hazelcast CP Subsystem can be used safely in Kubernetes only if xref:cp-subsystem:configuration.adoc#cp-subsystem-configuration[CP Subsystem Persistence] is enabled ({enterprise-product-name} Feature). Otherwise, a CP Subsystem Group may not recover after scaling the cluster or a rolling upgrade. == Troubleshooting with Helm Installation diff --git a/docs/modules/kubernetes/partials/nav.adoc b/docs/modules/kubernetes/partials/nav.adoc index 145210e73..cfbb24bd0 100644 --- a/docs/modules/kubernetes/partials/nav.adoc +++ b/docs/modules/kubernetes/partials/nav.adoc @@ -6,7 +6,7 @@ ** xref:kubernetes:troubleshooting-and-limitations.adoc[Troubleshooting and Limitations] ** Helm Charts *** xref:kubernetes:helm-hazelcast-chart.adoc[Hazelcast Chart] -*** xref:kubernetes:helm-hazelcast-enterprise-chart.adoc[Hazelcast Enterprise Chart] +*** xref:kubernetes:helm-hazelcast-enterprise-chart.adoc[Hazelcast {enterprise-product-name} Chart] *** xref:kubernetes:helm-adding-custom-jar.adoc[Adding Custom Jar] *** xref:kubernetes:helm-enabling-external-access.adoc[Enabling External Access] *** xref:kubernetes:helm-configuring-ssl.adoc[Configuring SSL] diff --git a/docs/modules/maintain-cluster/pages/lite-members.adoc b/docs/modules/maintain-cluster/pages/lite-members.adoc index 4b8921dfa..be890442a 100644 --- a/docs/modules/maintain-cluster/pages/lite-members.adoc +++ b/docs/modules/maintain-cluster/pages/lite-members.adoc @@ -9,8 +9,8 @@ The presence of lite members does not affect the operations performed on the oth You can directly submit your tasks to the lite members, register listeners on them, and invoke operations for the Hazelcast data structures on them such as `map.put()` and `map.get()`. -IMPORTANT: If you want to use lite members in a Hazelcast Enterprise -cluster, they are also subjected to the Enterprise license. +IMPORTANT: If you want to use lite members in a Hazelcast {enterprise-product-name} +cluster, they are also subjected to the {enterprise-product-name} license. == Configuring Lite Members diff --git a/docs/modules/maintain-cluster/pages/monitoring.adoc b/docs/modules/maintain-cluster/pages/monitoring.adoc index 42873d562..917e24d02 100644 --- a/docs/modules/maintain-cluster/pages/monitoring.adoc +++ b/docs/modules/maintain-cluster/pages/monitoring.adoc @@ -224,7 +224,7 @@ the instance startup at the configured location. The file contains metadata about the instance, such as version, product name and process ID. This file can then later be used by other programs to detect the kinds of Hazelcast instances that have been running on a particular machine by inspecting the file contents. -This feature supports both Open Source and Enterprise members and clients, +This feature supports both {open-source-product-name} and {enterprise-product-name} members and clients, and is disabled by default. Failing to write the file only generates a warning, and the instance is allowed to start. The name and content of the file are configurable and may contain placeholders. @@ -1694,7 +1694,7 @@ diagnostics utility consists of plugins such as BuildInfo, SystemProperties and ==== BuildInfo It shows the detailed Hazelcast build information including the Hazelcast release number, -`Git` revision number and whether you have Hazelcast Enterprise or not. +`Git` revision number and whether you have Hazelcast {enterprise-product-name} or not. ==== SystemProperties diff --git a/docs/modules/maintain-cluster/pages/rest-api.adoc b/docs/modules/maintain-cluster/pages/rest-api.adoc index ffcb71e87..9b9a89cc1 100644 --- a/docs/modules/maintain-cluster/pages/rest-api.adoc +++ b/docs/modules/maintain-cluster/pages/rest-api.adoc @@ -430,13 +430,13 @@ NOTE: Some of the REST calls listed below need their REST endpoint groups to be See the <> on how to enable them. Also note that the value of `$\{PASSWORD}` in the following calls is checked only if -the security is xref:security:enabling-jaas.adoc[enabled] in Hazelcast, i.e., if you have Hazelcast Enterprise Edition. +the security is xref:security:enabling-jaas.adoc[enabled] in Hazelcast, i.e., if you have Hazelcast {enterprise-product-name} Edition. If the security is disabled, the `$\{PASSWORD}` can be left empty. [cols="5a"] .REST API calls |=== -|**Open Source commands** +|**{open-source-product-name} commands** * _Checking if a member is ready to be used:_ + @@ -486,7 +486,7 @@ curl http://127.0.0.1:${PORT}/hazelcast/rest/management/cluster/version {"status":"success","version":"3.9"} ---- -|[[partial-start-force-start]]**Enterprise commands** +|[[partial-start-force-start]]**{enterprise-product-name} commands** * _Triggering a partial-start on the cluster:_ + @@ -884,7 +884,7 @@ security: ---- ==== -Note that you should enable security in the configuration, i.e., you should have the Hazelcast Enterprise edition. +Note that you should enable security in the configuration, i.e., you should have the Hazelcast {enterprise-product-name} edition. Assuming we have the above authentication configuration, the following is a REST call for the `/hazelcast/rest/management/cluster/state` endpoint, which includes the username and password as call parameters: ``` diff --git a/docs/modules/maintain-cluster/pages/rolling-upgrades.adoc b/docs/modules/maintain-cluster/pages/rolling-upgrades.adoc index f7b35dc65..db4f5e0a4 100644 --- a/docs/modules/maintain-cluster/pages/rolling-upgrades.adoc +++ b/docs/modules/maintain-cluster/pages/rolling-upgrades.adoc @@ -43,8 +43,8 @@ cluster version are always compatible, regardless of patch version. As a result, you can use rolling upgrades to upgrade clusters to the following member codebase versions: -- A new patch version of the same major and minor version (Open Source and Enterprise) -- The next minor version of the same major version (Enterprise only) +- A new patch version of the same major and minor version ({open-source-product-name} and {enterprise-product-name}) +- The next minor version of the same major version ({enterprise-product-name} only) + This also includes the ability of rolling upgrade from Hazelcast IMDG 4.2 to Platform 5.0, since IMDG is part of the Platform and 5.0 is considered to be the next minor version after IMDG 4.2. @@ -61,7 +61,7 @@ During migrations, members cannot join or leave the cluster. . Upgrade the member's codebase to a new patch version or the next minor version. + -NOTE: To upgrade the codebase to the next minor version, you need an Enterprise license. +NOTE: To upgrade the codebase to the next minor version, you need an {enterprise-product-name} license. . Start the member and wait until it joins the cluster. + @@ -142,7 +142,7 @@ to merge as soon as the network partition is fixed. == Using Rolling Restarts to Switch to High-Density Memory Store -As a Hazelcast Platform Enterprise user, you can perform a rolling restart on your cluster to start using xref:storage:high-density-memory.adoc[High-Density Memory Store] in your maps. +As a Hazelcast Platform {enterprise-product-name} user, you can perform a rolling restart on your cluster to start using xref:storage:high-density-memory.adoc[High-Density Memory Store] in your maps. For this you need to: diff --git a/docs/modules/management/pages/cluster-utilities.adoc b/docs/modules/management/pages/cluster-utilities.adoc index 359ea7225..2bfda928d 100644 --- a/docs/modules/management/pages/cluster-utilities.adoc +++ b/docs/modules/management/pages/cluster-utilities.adoc @@ -123,8 +123,8 @@ If these parameters are not provided, the default values are used. |`get-state` |Executes a cluster-wide operation. Operations can be the following: -* Open Source operations: `get-state`, `change-state`, `shutdown` and `get-cluster-version`. -* Enterprise operations: `force-start`, `partial-start` and `change-cluster-version`. +* {open-source-product-name} operations: `get-state`, `change-state`, `shutdown` and `get-cluster-version`. +* {enterprise-product-name} operations: `force-start`, `partial-start` and `change-cluster-version`. |`-s` or `--state` |None diff --git a/docs/modules/migrate/pages/data-migration-tool.adoc b/docs/modules/migrate/pages/data-migration-tool.adoc index ab1ff9c28..d17f4ad6a 100644 --- a/docs/modules/migrate/pages/data-migration-tool.adoc +++ b/docs/modules/migrate/pages/data-migration-tool.adoc @@ -1,5 +1,5 @@ = Using the Data Migration Tool -:description: You can use the Data Migration Tool (DMT) to migrate your data from version 4.x or 5.x Open Source and Enterprise Edition Hazelcast clusters when upgrading to 5.3.x or later versions of Enterprise Edition, or moving to the latest {hazelcast-cloud} release. The DMT can also be used for infrastructure consolidation or separation with selective migration of application data between clusters. +:description: You can use the Data Migration Tool (DMT) to migrate your data from version 4.x or 5.x {open-source-product-name} and {enterprise-product-name} Edition Hazelcast clusters when upgrading to 5.3.x or later versions of {enterprise-product-name} Edition, or moving to the latest {hazelcast-cloud} release. The DMT can also be used for infrastructure consolidation or separation with selective migration of application data between clusters. {description} @@ -7,9 +7,9 @@ NOTE: The DMT migrates your data for maps and replicated maps only. Replicated m The DMT is typically used in the following situations: -* When migrating from an Open Source cluster to an Enterprise Edition cluster -* When migrating from an earlier version of Enterprise Edition to a newer version. Such a migration can move directly between specified versions, even if several minor versions exist between them -* When migrating from an on-premise cluster to a self-managed Enterprise Edition cluster in the cloud +* When migrating from an {open-source-product-name} cluster to an {enterprise-product-name} Edition cluster +* When migrating from an earlier version of {enterprise-product-name} Edition to a newer version. Such a migration can move directly between specified versions, even if several minor versions exist between them +* When migrating from an on-premise cluster to a self-managed {enterprise-product-name} Edition cluster in the cloud * When migrating from an on-premise cluster to a {hazelcast-cloud} cluster * When you want to migrate specific application data from one cluster to another due to infrastructure changes @@ -59,7 +59,7 @@ Ensure that you have installed the following: When using the DMT, bear the following in mind: * You can run only one migration at a time -* The target cluster must be on 5.3.x Enterprise Edition or the latest {hazelcast-cloud} release +* The target cluster must be on 5.3.x {enterprise-product-name} Edition or the latest {hazelcast-cloud} release NOTE: {hazelcast-cloud} Trial and {hazelcast-cloud} Standard have a limit of 14GB of primary data. If you require more, you must use {hazelcast-cloud} Dedicated. For further information on the available {hazelcast-cloud} editions, refer to the https://docs.hazelcast.com/cloud/overview[Hazelcast {hazelcast-cloud}^] documentation. @@ -231,7 +231,7 @@ NOTE: If you have multiple data structures, use a new line for each map name. Ensure that the target cluster is running on one of the following: -* Enterprise Edition version 5.3.2 or later +* {enterprise-product-name} Edition version 5.3.2 or later * {hazelcast-cloud} ==== Update the Target Configuration diff --git a/docs/modules/migrate/pages/migration-tool-imdg.adoc b/docs/modules/migrate/pages/migration-tool-imdg.adoc index 561f88c0e..48bb58d6f 100644 --- a/docs/modules/migrate/pages/migration-tool-imdg.adoc +++ b/docs/modules/migrate/pages/migration-tool-imdg.adoc @@ -1,7 +1,7 @@ = Migrating Data from IMDG 3.12.x :description: This guide explains how to migrate data in maps or JCache data structures from a running IMDG 3.12.x cluster to a Hazelcast 5.x cluster. -[blue]*Hazelcast Enterprise Feature* +[blue]*Hazelcast {enterprise-product-name} Feature* {description} diff --git a/docs/modules/osgi/pages/osgi-support.adoc b/docs/modules/osgi/pages/osgi-support.adoc index e202f75a8..b7bb5b87c 100644 --- a/docs/modules/osgi/pages/osgi-support.adoc +++ b/docs/modules/osgi/pages/osgi-support.adoc @@ -19,4 +19,4 @@ the owner Hazelcast bundles. When the bundle is stopped (deactivated), the owned Hazelcast instances are also deactivated/shutdown and deregistered automatically. When the bundle is re-activated, its service is registered again. -The Hazelcast Enterprise JAR package is also an OSGI bundle like the Hazelcast Open Source JAR package. \ No newline at end of file +The Hazelcast {enterprise-product-name} JAR package is also an OSGI bundle like the Hazelcast {open-source-product-name} JAR package. \ No newline at end of file diff --git a/docs/modules/pipelines/pages/cdc.adoc b/docs/modules/pipelines/pages/cdc.adoc index e55f3da96..375e22486 100644 --- a/docs/modules/pipelines/pages/cdc.adoc +++ b/docs/modules/pipelines/pages/cdc.adoc @@ -157,7 +157,7 @@ You should see the following jars: * hazelcast-jet-cdc-mysql-{full-version}.jar * hazelcast-jet-cdc-postgres-{full-version}.jar + -WARNING: If you have Hazelcast Enterprise Edition, you need to manually download the MySQL CDC plugin from Hazelcast's Maven https://repo1.maven.org/maven2/com/hazelcast/jet/hazelcast-jet-cdc-mysql/{full-version}/hazelcast-jet-cdc-mysql-{full-version}-jar-with-dependencies.jar[repository] and then copy it to the `lib/` directory. +WARNING: If you have Hazelcast {enterprise-product-name} Edition, you need to manually download the MySQL CDC plugin from Hazelcast's Maven https://repo1.maven.org/maven2/com/hazelcast/jet/hazelcast-jet-cdc-mysql/{full-version}/hazelcast-jet-cdc-mysql-{full-version}-jar-with-dependencies.jar[repository] and then copy it to the `lib/` directory. . Start Hazelcast. + diff --git a/docs/modules/pipelines/pages/job-security.adoc b/docs/modules/pipelines/pages/job-security.adoc index c6b75f6e8..169fd35c3 100644 --- a/docs/modules/pipelines/pages/job-security.adoc +++ b/docs/modules/pipelines/pages/job-security.adoc @@ -9,13 +9,13 @@ To secure your cluster against malicious jobs, you have the following options: - <>: Do not allow any jobs or SQL queries to run on the cluster. + NOTE: You cannot run SQL queries when the Jet engine is disabled. -- <> [.enterprise]*Enterprise*. +- <> [.enterprise]*{enterprise-product-name}*. + -WARNING: The Open Source edition of Hazelcast does not include security settings. To secure your Hazelcast members against clients misusing jobs, you can only <> or <>. +WARNING: The {open-source-product-name} edition of Hazelcast does not include security settings. To secure your Hazelcast members against clients misusing jobs, you can only <> or <>. == Disabling Code Uploads -When submitting a job to a member, you have the option of uploading some of your own classes for the cluster to run with the job. This code is not subject to any Enterprise client permissions that you may have set up. For example, if you restrict clients' write access to a map, the uploaded code bypasses those restrictions and can write to the map. +When submitting a job to a member, you have the option of uploading some of your own classes for the cluster to run with the job. This code is not subject to any {enterprise-product-name} client permissions that you may have set up. For example, if you restrict clients' write access to a map, the uploaded code bypasses those restrictions and can write to the map. NOTE: If you're using Hazelcast in embedded mode, this feature is disabled by default. @@ -134,7 +134,7 @@ HazelcastInstance instance = Hazelcast.newHazelcastInstance(config); == Controlling Access to Jobs -In Hazelcast Enterprise, you can restrict access to jobs, using the following xref:security:native-client-security.adoc[client permissions]: +In Hazelcast {enterprise-product-name}, you can restrict access to jobs, using the following xref:security:native-client-security.adoc[client permissions]: - Job permissions: Restrict what clients can do with jobs and SQL queries. - Connector permissions: Restrict read and write access for each connector. diff --git a/docs/modules/pipelines/pages/python.adoc b/docs/modules/pipelines/pages/python.adoc index 259a30cca..2b04a54b3 100644 --- a/docs/modules/pipelines/pages/python.adoc +++ b/docs/modules/pipelines/pages/python.adoc @@ -18,7 +18,7 @@ To complete this tutorial, you need the following: |A Hazelcast cluster running in client/server mode |xref:getting-started:install-hazelcast.adoc#use-the-binary[Install Hazelcast] -|A Hazelcast Full Distribution |https://hazelcast.com/open-source-projects/downloads/[Hazelcast Open Source Downloads] +|A Hazelcast Full Distribution |https://hazelcast.com/open-source-projects/downloads/[Hazelcast {open-source-product-name} Downloads] |=== == Step 1. Write a Python Function diff --git a/docs/modules/release-notes/pages/5-3-0.adoc b/docs/modules/release-notes/pages/5-3-0.adoc index e08d06dc5..a7e37e15c 100644 --- a/docs/modules/release-notes/pages/5-3-0.adoc +++ b/docs/modules/release-notes/pages/5-3-0.adoc @@ -32,7 +32,7 @@ https://github.com/hazelcast/hazelcast/pull/23766[#23766] https://github.com/hazelcast/hazelcast/pull/23545[#23545] * Added the support of discovering ECS and EC2 members on AWS. See xref:deploy:deploying-on-aws.adoc[Deploying a Cluster on Amazon AWS]. https://github.com/hazelcast/hazelcast/pull/22411[#22411] -* [.enterprise]*Enterprise* Enhanced the experience of using Hazelcast with persistence under Kubernetes by removing requirements for manual interventions. Previously, when there was a restart on such a cluster, the cluster states were needed to be changed manually. For some cases, this might have led to data loss. Now, the shutdown process is automated. See xref:kubernetes:kubernetes-persistence.adoc[Configuring Kubernetes] for details. +* [.enterprise]*{enterprise-product-name}* Enhanced the experience of using Hazelcast with persistence under Kubernetes by removing requirements for manual interventions. Previously, when there was a restart on such a cluster, the cluster states were needed to be changed manually. For some cases, this might have led to data loss. Now, the shutdown process is automated. See xref:kubernetes:kubernetes-persistence.adoc[Configuring Kubernetes] for details. https://github.com/hazelcast/hazelcast/pull/21844[#21844] === Storage diff --git a/docs/modules/security/pages/enabling-jaas.adoc b/docs/modules/security/pages/enabling-jaas.adoc index 379117147..f6adf2362 100644 --- a/docs/modules/security/pages/enabling-jaas.adoc +++ b/docs/modules/security/pages/enabling-jaas.adoc @@ -49,5 +49,5 @@ include::ROOT:example$/security/EnablingSecurity.java[tag=es] ==== Also, see the xref:deploy:using-enterprise-edition.adoc#setting-the-license-key[Setting License Key section] -for information about how to set your [blue]#Hazelcast Enterprise# +for information about how to set your [blue]#Hazelcast {enterprise-product-name}# license. \ No newline at end of file diff --git a/docs/modules/security/pages/logging-auditable-events.adoc b/docs/modules/security/pages/logging-auditable-events.adoc index 6da141800..7ec19b9ca 100644 --- a/docs/modules/security/pages/logging-auditable-events.adoc +++ b/docs/modules/security/pages/logging-auditable-events.adoc @@ -2,7 +2,7 @@ [[auditlog]] :page-enterprise: true -Hazelcast Enterprise allows observing some important cluster events +Hazelcast {enterprise-product-name} allows observing some important cluster events using the Auditlog feature. Auditable events have a unique type ID; they contain a timestamp and importance level. The events may also contain a message and parameters. diff --git a/docs/modules/security/pages/overview.adoc b/docs/modules/security/pages/overview.adoc index 584ff2b35..ec6ddd7db 100644 --- a/docs/modules/security/pages/overview.adoc +++ b/docs/modules/security/pages/overview.adoc @@ -6,7 +6,7 @@ These features allow you to perform security activities, such as intercepting so connections and remote operations executed by the clients, encrypting the communications between the members at socket level and using SSL socket communication. All the security features explained in this chapter are the features of -[blue]#Hazelcast Enterprise# edition. +[blue]#Hazelcast {enterprise-product-name}# edition. While Hazelcast supports non-secured cluster members and clients, it is recommended to secure your deployments. A cluster without security may face with: diff --git a/docs/modules/security/pages/security-realms.adoc b/docs/modules/security/pages/security-realms.adoc index 9c2129c62..65d67fd86 100644 --- a/docs/modules/security/pages/security-realms.adoc +++ b/docs/modules/security/pages/security-realms.adoc @@ -399,7 +399,7 @@ YAML:: The Kerberos authentication protocol is one of the standard solutions for single sign-on (SSO). It's well established in many companies. Hazelcast -supports Kerberos authentication as an Enterprise feature and it also +supports Kerberos authentication as an {enterprise-product-name} feature and it also provides Kerberos integration to LDAP-based authorization. The Kerberos support in Hazelcast has 2 configuration parts: identity diff --git a/docs/modules/security/pages/validating-secrets.adoc b/docs/modules/security/pages/validating-secrets.adoc index 13befdbdb..e7ebc22f8 100644 --- a/docs/modules/security/pages/validating-secrets.adoc +++ b/docs/modules/security/pages/validating-secrets.adoc @@ -1,11 +1,11 @@ = Validating Secrets Using Strength Policy :page-enterprise: true -Hazelcast Enterprise offers a secret validation mechanism including a strength +Hazelcast {enterprise-product-name} offers a secret validation mechanism including a strength policy. The term "secret" here refers to the symmetric encryption password, salt and other passwords and keys. -For this validation, Hazelcast Enterprise comes with the `DefaultSecretStrengthPolicy` +For this validation, Hazelcast {enterprise-product-name} comes with the `DefaultSecretStrengthPolicy` class to identify all possible weaknesses of secrets and to display a warning in the system logger. Note that, by default, no matter how weak the secrets are, the cluster members still start after logging this warning; however, this is diff --git a/docs/modules/sql/pages/create-data-connection.adoc b/docs/modules/sql/pages/create-data-connection.adoc index bcfab01bc..94685e07a 100644 --- a/docs/modules/sql/pages/create-data-connection.adoc +++ b/docs/modules/sql/pages/create-data-connection.adoc @@ -66,7 +66,7 @@ Replacing a data connection will not affect any queries that are already running - Queries or jobs that are restarted after a data connection is updated == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can grant or deny permission for certain clients to use this statement. See xref:security:native-client-security.adoc#sql-permission[SQL Permissions]. diff --git a/docs/modules/sql/pages/create-index.adoc b/docs/modules/sql/pages/create-index.adoc index 465c06c51..4e79c8f1b 100644 --- a/docs/modules/sql/pages/create-index.adoc +++ b/docs/modules/sql/pages/create-index.adoc @@ -77,7 +77,7 @@ For details, see xref:query:indexing-maps.adoc#bitmap-indexes[Bitmap Indexes]. |=== == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can grant or deny permission for certain clients to use this statement. See xref:security:native-client-security.adoc#sql-permission[SQL Permissions]. diff --git a/docs/modules/sql/pages/create-mapping.adoc b/docs/modules/sql/pages/create-mapping.adoc index 01d36550f..09912fab2 100644 --- a/docs/modules/sql/pages/create-mapping.adoc +++ b/docs/modules/sql/pages/create-mapping.adoc @@ -148,7 +148,7 @@ OPTIONS ( |=== == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can grant or deny permission for certain clients to use this statement. See xref:security:native-client-security.adoc#sql-permission[SQL Permissions]. diff --git a/docs/modules/sql/pages/create-view.adoc b/docs/modules/sql/pages/create-view.adoc index e5f23521b..f9fe45a0c 100644 --- a/docs/modules/sql/pages/create-view.adoc +++ b/docs/modules/sql/pages/create-view.adoc @@ -57,7 +57,7 @@ The `information_schema.views` view provides a view into the engine metadata for columns are in `information_schema.columns` table. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can grant or deny permission for certain clients to use this statement. See xref:security:native-client-security.adoc#sql-permission[SQL Permissions]. diff --git a/docs/modules/sql/pages/drop-job.adoc b/docs/modules/sql/pages/drop-job.adoc index 51d1ca3e6..377e081be 100644 --- a/docs/modules/sql/pages/drop-job.adoc +++ b/docs/modules/sql/pages/drop-job.adoc @@ -33,7 +33,7 @@ The `job_name` parameter is required. |<> |WITH SNAPSHOT -|Create a named snapshot of the job before canceling it. [.enterprise]*Enterprise* +|Create a named snapshot of the job before canceling it. [.enterprise]*{enterprise-product-name}* |<> |=== diff --git a/docs/modules/sql/pages/drop-mapping.adoc b/docs/modules/sql/pages/drop-mapping.adoc index 45a3ce438..ec1e54e1a 100644 --- a/docs/modules/sql/pages/drop-mapping.adoc +++ b/docs/modules/sql/pages/drop-mapping.adoc @@ -33,7 +33,7 @@ The `DROP MAPPING` statement accepts the following parameters. |=== == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can grant or deny permission for certain clients to use this statement. See xref:security:native-client-security.adoc#sql-permission[SQL Permissions]. diff --git a/docs/modules/sql/pages/drop-view.adoc b/docs/modules/sql/pages/drop-view.adoc index 0e792068f..67d26e87b 100644 --- a/docs/modules/sql/pages/drop-view.adoc +++ b/docs/modules/sql/pages/drop-view.adoc @@ -33,7 +33,7 @@ The `view_name` parameter is required. |=== == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can grant or deny permission for certain clients to use this statement. See xref:security:native-client-security.adoc#sql-permission[SQL Permissions]. diff --git a/docs/modules/sql/pages/mapping-to-a-file-system.adoc b/docs/modules/sql/pages/mapping-to-a-file-system.adoc index 93b193c10..890ba9270 100644 --- a/docs/modules/sql/pages/mapping-to-a-file-system.adoc +++ b/docs/modules/sql/pages/mapping-to-a-file-system.adoc @@ -20,7 +20,7 @@ To access Hadoop or any of the cloud-based file systems, you may need to add one Depending on the <>, you may also need to add other modules to the classpath. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set up permissions to restrict clients' access to your files. For details, see xref:pipelines:job-security.adoc[]. diff --git a/docs/modules/sql/pages/mapping-to-jdbc.adoc b/docs/modules/sql/pages/mapping-to-jdbc.adoc index 4fc5074a4..db5b88f3a 100644 --- a/docs/modules/sql/pages/mapping-to-jdbc.adoc +++ b/docs/modules/sql/pages/mapping-to-jdbc.adoc @@ -39,7 +39,7 @@ The JDBC connector supports only the following statements: The JDBC connector is included in the full and slim distributions of Hazelcast. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* The JDBC connector does not yet support permissions. @@ -48,9 +48,9 @@ The JDBC connector does not yet support permissions. Before you can create a mapping to an external data store, you must have the following: - A JDBC driver that's compatible with your data store. This driver must be on the classpath of your cluster members: -** The full distribution of Hazelcast Enterprise comes with a JDBC driver for PostgreSQL data stores only. +** The full distribution of Hazelcast {enterprise-product-name} comes with a JDBC driver for PostgreSQL data stores only. ** The slim distribution of Hazelcast does not come with a JDBC driver. -** The full distribution of Hazelcast Open Source comes with a JDBC driver for MySQL and PostgreSQL data stores. +** The full distribution of Hazelcast {open-source-product-name} comes with a JDBC driver for MySQL and PostgreSQL data stores. - A xref:external-data-stores:external-data-stores.adoc[data store connection] that's configured on all cluster members. - Create the database that you'll use as your external data store. diff --git a/docs/modules/sql/pages/mapping-to-kafka.adoc b/docs/modules/sql/pages/mapping-to-kafka.adoc index 3d2ed78e6..c490b0383 100644 --- a/docs/modules/sql/pages/mapping-to-kafka.adoc +++ b/docs/modules/sql/pages/mapping-to-kafka.adoc @@ -18,7 +18,7 @@ The Kafka connector is compatible with Kafka version equal to or greater than 1.0.0. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, your clients may need permissions to use this connector. For details, see xref:pipelines:job-security.adoc[]. diff --git a/docs/modules/sql/pages/mapping-to-maps.adoc b/docs/modules/sql/pages/mapping-to-maps.adoc index 7a78bf100..2afd0766c 100644 --- a/docs/modules/sql/pages/mapping-to-maps.adoc +++ b/docs/modules/sql/pages/mapping-to-maps.adoc @@ -13,7 +13,7 @@ The map connector allows you to create mappings to a distributed map in a local This connector is included in Hazelcast. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set up permissions to restrict clients' access to maps. diff --git a/docs/modules/sql/pages/mapping-to-mongo.adoc b/docs/modules/sql/pages/mapping-to-mongo.adoc index 7bc77e666..e1e2645e3 100644 --- a/docs/modules/sql/pages/mapping-to-mongo.adoc +++ b/docs/modules/sql/pages/mapping-to-mongo.adoc @@ -44,7 +44,7 @@ compile group: 'com.hazelcast.jet', name: 'hazelcast-jet-mongodb', version: ${fu NOTE: To be able to use SQL over MongoDB, you have to include `hazelcast-sql` as well as a dependency. == Permissions -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, your clients may need permissions to use this connector. For details, see xref:pipelines:job-security.adoc[]. diff --git a/docs/modules/sql/pages/sql-overview.adoc b/docs/modules/sql/pages/sql-overview.adoc index 524f8c44d..b6550d939 100644 --- a/docs/modules/sql/pages/sql-overview.adoc +++ b/docs/modules/sql/pages/sql-overview.adoc @@ -87,7 +87,7 @@ as `employee` but not as `Employee`. Keywords or built-in function names are case-insensitive. == Permissions and Security -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* If xref:security:enabling-jaas.adoc[security] is enabled, you can set xref:security:native-client-security.adoc[permissions] for the following: diff --git a/docs/modules/sql/pages/sql-statements.adoc b/docs/modules/sql/pages/sql-statements.adoc index d9bac550e..8ee041fd9 100644 --- a/docs/modules/sql/pages/sql-statements.adoc +++ b/docs/modules/sql/pages/sql-statements.adoc @@ -75,10 +75,10 @@ |xref:drop-job.adoc[DROP JOB] |Cancel a job. -a|xref:create-snapshot.adoc[`CREATE OR REPLACE SNAPSHOT`] [.enterprise]*Enterprise* +a|xref:create-snapshot.adoc[`CREATE OR REPLACE SNAPSHOT`] [.enterprise]*{enterprise-product-name}* |Create a snapshot of a running job so you can stop and restart it at a later date. -a|xref:drop-snapshot.adoc[`DROP SNAPSHOT`] [.enterprise]*Enterprise* +a|xref:drop-snapshot.adoc[`DROP SNAPSHOT`] [.enterprise]*{enterprise-product-name}* |Drop an existing snapshot. |=== \ No newline at end of file diff --git a/docs/modules/sql/pages/user-defined-types.adoc b/docs/modules/sql/pages/user-defined-types.adoc index 48c097fde..cf36024c8 100644 --- a/docs/modules/sql/pages/user-defined-types.adoc +++ b/docs/modules/sql/pages/user-defined-types.adoc @@ -522,6 +522,6 @@ hz.getSql().execute("UPDATE users SET organization = ((organization).id, (organi ---- == Upgrade Notes -[.enterprise]*Enterprise* +[.enterprise]*{enterprise-product-name}* When performing a normal or rolling upgrade from version 5.3 to 5.4, you must drop all user-defined types and mappings with UDTs before the upgrade, and recreate them with the new semantics after upgrading. diff --git a/docs/modules/storage/pages/configuring-persistence.adoc b/docs/modules/storage/pages/configuring-persistence.adoc index 2418c2953..12a35166c 100644 --- a/docs/modules/storage/pages/configuring-persistence.adoc +++ b/docs/modules/storage/pages/configuring-persistence.adoc @@ -5,7 +5,7 @@ {description} -NOTE: For information on configuring persistence in Kubernetes environments, see xref:kubernetes:kubernetes-persistence.adoc[Running Hazelcast Enterprise with Persistence under Kubernetes]. +NOTE: For information on configuring persistence in Kubernetes environments, see xref:kubernetes:kubernetes-persistence.adoc[Running Hazelcast {enterprise-product-name} with Persistence under Kubernetes]. == Glossary diff --git a/docs/modules/storage/pages/high-density-memory.adoc b/docs/modules/storage/pages/high-density-memory.adoc index 0a8866012..98692a86c 100644 --- a/docs/modules/storage/pages/high-density-memory.adoc +++ b/docs/modules/storage/pages/high-density-memory.adoc @@ -15,7 +15,7 @@ with small heaps (sizes of 2-4GB per member) run on a single physical hardware device to avoid garbage collection pauses. This results in oversized clusters to hold the data and leads to performance issues. -In [navy]*Hazelcast Enterprise*, the High-Density Memory Store is +In [navy]*Hazelcast {enterprise-product-name}*, the High-Density Memory Store is Hazelcast's enterprise in-memory storage solution. It solves garbage collection limitations so that applications can exploit hardware memory more efficiently without the need of oversized clusters. High-Density diff --git a/docs/modules/storage/pages/persistence.adoc b/docs/modules/storage/pages/persistence.adoc index 070721cd9..b0100cf49 100644 --- a/docs/modules/storage/pages/persistence.adoc +++ b/docs/modules/storage/pages/persistence.adoc @@ -51,6 +51,6 @@ not possible to restore persisted data. xref:configuring-persistence.adoc[] -xref:kubernetes:kubernetes-persistence.adoc[Running Hazelcast Enterprise with Persistence under Kubernetes] +xref:kubernetes:kubernetes-persistence.adoc[Running Hazelcast {enterprise-product-name} with Persistence under Kubernetes] xref:backing-up-persistence.adoc[] \ No newline at end of file diff --git a/docs/modules/tiered-storage/pages/configuration.adoc b/docs/modules/tiered-storage/pages/configuration.adoc index 73d72bf8a..05a3eb849 100644 --- a/docs/modules/tiered-storage/pages/configuration.adoc +++ b/docs/modules/tiered-storage/pages/configuration.adoc @@ -166,7 +166,7 @@ You also have the following system properties to further fine-tune the Tiered St == Dynamic License Key Update -To support extending the Tiered Storage capacity property of the Enterprise License Key without restarting the members, Tiered Storage detects and adapts its limits to the new Tiered Storage capacity defined in the new License Key. +To support extending the Tiered Storage capacity property of the {enterprise-product-name} License Key without restarting the members, Tiered Storage detects and adapts its limits to the new Tiered Storage capacity defined in the new License Key. For further information on updating license keys, see xref:deploy:enterprise-licenses.adoc#update[Updating a License Key at Runtime]. By increasing the Tiered Storage capacity with a new License Key, the capacity of the configured devices might be too low to benefit from the new License Key permissions. diff --git a/docs/modules/tiered-storage/pages/overview.adoc b/docs/modules/tiered-storage/pages/overview.adoc index f99896052..f25b998ae 100644 --- a/docs/modules/tiered-storage/pages/overview.adoc +++ b/docs/modules/tiered-storage/pages/overview.adoc @@ -18,7 +18,7 @@ Consider using Tiered Storage if any of the following applies to your use-case: - You have significant temporal access patterns inside a very large dataset. - Your project uses MapStore and you intend to use local disk to improve the access latency of entries that do not fit in the memory of your machine. -NOTE: If your Enterprise license was generated before Hazelcast Platform version 5.2, you'll need a new Enterprise license that enables Tiered Storage. +NOTE: If your {enterprise-product-name} license was generated before Hazelcast Platform version 5.2, you'll need a new {enterprise-product-name} license that enables Tiered Storage. See xref:deploy:enterprise-licenses.adoc[]. == Design Overview diff --git a/docs/modules/troubleshoot/pages/error-handling.adoc b/docs/modules/troubleshoot/pages/error-handling.adoc index 50996cd66..97361d940 100644 --- a/docs/modules/troubleshoot/pages/error-handling.adoc +++ b/docs/modules/troubleshoot/pages/error-handling.adoc @@ -67,7 +67,7 @@ failure. In the open-source version of Hazelcast, this scenario is limited to fixing the input data by some external means and then simply xref:pipelines:job-management.adoc#restarting[resuming the job]. -The Enterprise version of Hazelcast has the added option of xref:pipelines:job-update.adoc[job upgrades]. In that case you can: +The {enterprise-product-name} version of Hazelcast has the added option of xref:pipelines:job-update.adoc[job upgrades]. In that case you can: * export the latest snapshot * update the pipeline, if needed, for example, to cope with unexpected diff --git a/docs/modules/wan/pages/failures.adoc b/docs/modules/wan/pages/failures.adoc index b98007ee6..6a498ced9 100644 --- a/docs/modules/wan/pages/failures.adoc +++ b/docs/modules/wan/pages/failures.adoc @@ -22,7 +22,7 @@ the partition, so that the same partitions are always sent to the same target me == WAN Failure Detection -If using the Hazelcast Enterprise edition class `WanBatchReplication` +If using the Hazelcast {enterprise-product-name} edition class `WanBatchReplication` (see the xref:defining-wan-replication.adoc[Defining WAN replication section]), the WAN replication catches any exceptions when sending the WAN events to the endpoint. In the case of an exception, the endpoint is removed from the endpoint list to which WAN replicates and the WAN events are resent to From 6aace3412a22cf9b6f71048f49347c751d04d976 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Mon, 22 Apr 2024 14:15:38 +0000 Subject: [PATCH 2/7] Update latest supported MC to 5.5-snapshot --- docs/antora.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/antora.yml b/docs/antora.yml index 8e422ce8c..2fa4859b6 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -31,6 +31,5 @@ asciidoc: page-latest-supported-clc: '5.3.1' open-source-product-name: 'Open Source' enterprise-product-name: 'Enterprise' - nav: - modules/ROOT/nav.adoc From 29f4477c3b0b97efa2ff03a6b94108b4dc5a5814 Mon Sep 17 00:00:00 2001 From: Jack Green Date: Tue, 23 Apr 2024 11:01:33 +0100 Subject: [PATCH 3/7] Update outdated `minor-version` property (#1092) Manually synchronizing versions Partially addresses https://github.com/hazelcast/hz-docs/issues/1091 --- docs/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/antora.yml b/docs/antora.yml index 2fa4859b6..0eed56763 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -11,7 +11,7 @@ asciidoc: # The full major.minor.patch version, which is used as a variable in the docs for things like download links full-version: '5.5.0-SNAPSHOT' # The minor.patch version, which is used as a variable in the docs for things like file versions - minor-version: '5.3' + minor-version: '5.5' # The snapshot version for installing with brew version-brew: '5.5.0-SNAPSHOT' # Allows us to use UI macros. See https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/ From b4de698ed9c08c72d4fe0726ed3abadaca86f5da Mon Sep 17 00:00:00 2001 From: Serdar Ozmen Date: Mon, 29 Apr 2024 11:59:33 +0300 Subject: [PATCH 4/7] Review updated action versions (#1095) Co-authored-by: serdaro --- .github/workflows/action-updater.yml | 2 +- .github/workflows/adoc-html.yml | 2 +- .github/workflows/backport-5-0.yml | 2 +- .github/workflows/backport-5-1.yml | 2 +- .github/workflows/backport-5-2.yml | 2 +- .github/workflows/backport-5-3.yml | 2 +- .github/workflows/backport-5-4-beta-2.yml | 2 +- .github/workflows/backport-5-4.yml | 2 +- .github/workflows/backport.yml | 2 +- .github/workflows/forwardport.yml | 2 +- .github/workflows/to-plain-html.yml | 2 +- .github/workflows/validate.yml | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/action-updater.yml b/.github/workflows/action-updater.yml index 4226db06c..ca2c6ba9d 100644 --- a/.github/workflows/action-updater.yml +++ b/.github/workflows/action-updater.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.1.1 + - uses: actions/checkout@v4.1.4 with: # [Required] Access token with `workflow` scope. token: ${{ secrets.ACTION_UPDATER }} diff --git a/.github/workflows/adoc-html.yml b/.github/workflows/adoc-html.yml index 2024ac1f7..72c4c80ec 100644 --- a/.github/workflows/adoc-html.yml +++ b/.github/workflows/adoc-html.yml @@ -9,7 +9,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.1.1 + - uses: actions/checkout@v4.1.4 - uses: actions/setup-node@v4.0.2 with: node-version: 20 diff --git a/.github/workflows/backport-5-0.yml b/.github/workflows/backport-5-0.yml index 4155c2453..a895ad53e 100644 --- a/.github/workflows/backport-5-0.yml +++ b/.github/workflows/backport-5-0.yml @@ -12,7 +12,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.1.4 with: fetch-depth: 0 diff --git a/.github/workflows/backport-5-1.yml b/.github/workflows/backport-5-1.yml index f0b9a6620..42515b977 100644 --- a/.github/workflows/backport-5-1.yml +++ b/.github/workflows/backport-5-1.yml @@ -12,7 +12,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.1.4 with: fetch-depth: 0 diff --git a/.github/workflows/backport-5-2.yml b/.github/workflows/backport-5-2.yml index 97a3ae58a..cb57cada4 100644 --- a/.github/workflows/backport-5-2.yml +++ b/.github/workflows/backport-5-2.yml @@ -12,7 +12,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.1.4 with: fetch-depth: 0 diff --git a/.github/workflows/backport-5-3.yml b/.github/workflows/backport-5-3.yml index 2b5ba85a9..3a2db103e 100644 --- a/.github/workflows/backport-5-3.yml +++ b/.github/workflows/backport-5-3.yml @@ -12,7 +12,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.1.4 with: fetch-depth: 0 diff --git a/.github/workflows/backport-5-4-beta-2.yml b/.github/workflows/backport-5-4-beta-2.yml index 0c5e9d067..f9c5c7cb6 100644 --- a/.github/workflows/backport-5-4-beta-2.yml +++ b/.github/workflows/backport-5-4-beta-2.yml @@ -12,7 +12,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.1.4 with: fetch-depth: 0 diff --git a/.github/workflows/backport-5-4.yml b/.github/workflows/backport-5-4.yml index 437cc37db..a038081e3 100644 --- a/.github/workflows/backport-5-4.yml +++ b/.github/workflows/backport-5-4.yml @@ -12,7 +12,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.1.4 with: fetch-depth: 0 diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml index 159eac01d..5d20824a3 100644 --- a/.github/workflows/backport.yml +++ b/.github/workflows/backport.yml @@ -12,7 +12,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.1.4 with: fetch-depth: 0 diff --git a/.github/workflows/forwardport.yml b/.github/workflows/forwardport.yml index daa051bee..d1e591d00 100644 --- a/.github/workflows/forwardport.yml +++ b/.github/workflows/forwardport.yml @@ -12,7 +12,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.1.4 with: fetch-depth: 0 diff --git a/.github/workflows/to-plain-html.yml b/.github/workflows/to-plain-html.yml index 315a8703a..b5ba50676 100644 --- a/.github/workflows/to-plain-html.yml +++ b/.github/workflows/to-plain-html.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.1.1 + - uses: actions/checkout@v4.1.4 with: token: ${{ secrets.TO_HTML }} - name: Asciidoc to html diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index a254791f5..5c1f2a4c5 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.1.1 + - uses: actions/checkout@v4.1.4 - uses: actions/setup-node@v4.0.2 with: node-version: 20 From a8bb2028c36ae6c1f3d06d989cffae11acbf4991 Mon Sep 17 00:00:00 2001 From: Serdar Ozmen Date: Mon, 29 Apr 2024 13:43:08 +0300 Subject: [PATCH 5/7] Fix external links. (#1096) --- .../modules/data-structures/pages/map-config.adoc | 4 ++-- docs/modules/integrate/pages/cdc-connectors.adoc | 2 +- .../maintain-cluster/pages/monitoring.adoc | 4 ++-- .../pipelines/pages/cdc-database-setup.adoc | 15 +++++++-------- 4 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/modules/data-structures/pages/map-config.adoc b/docs/modules/data-structures/pages/map-config.adoc index 43b928562..bee7e009c 100644 --- a/docs/modules/data-structures/pages/map-config.adoc +++ b/docs/modules/data-structures/pages/map-config.adoc @@ -22,8 +22,8 @@ ifdef::snapshot[] endif::[] ifndef::snapshot[] -* link:https://github.com/hazelcast/hazelcast/blob/{full-version}/hazelcast/src/main/resources/hazelcast-full-example.xml[hazelcast-full-example.xml] -* link:https://github.com/hazelcast/hazelcast/blob/{full-version}/hazelcast/src/main/resources/hazelcast-full-example.yaml[hazelcast-full-example.yaml] +* link:https://github.com/hazelcast/hazelcast/blob/v{full-version}/hazelcast/src/main/resources/hazelcast-full-example.xml[hazelcast-full-example.xml] +* link:https://github.com/hazelcast/hazelcast/blob/v{full-version}/hazelcast/src/main/resources/hazelcast-full-example.yaml[hazelcast-full-example.yaml] endif::[] ==== diff --git a/docs/modules/integrate/pages/cdc-connectors.adoc b/docs/modules/integrate/pages/cdc-connectors.adoc index 05a6061df..dce0f675b 100644 --- a/docs/modules/integrate/pages/cdc-connectors.adoc +++ b/docs/modules/integrate/pages/cdc-connectors.adoc @@ -10,7 +10,7 @@ processed by the Jet engine. Implementation of CDC in Hazelcast is based on link:https://debezium.io/[Debezium]. Hazelcast offers a generic Debezium source -which can handle CDC events from link:https://debezium.io/documentation/reference/1.1/connectors/index.html[any database supported by Debezium], +which can handle CDC events from link:https://debezium.io/documentation/reference/stable/connectors/index.html[any database supported by Debezium], but we're also striving to make CDC sources first class citizens in Hazelcast. The ones for MySQL and PostgreSQL already are. diff --git a/docs/modules/maintain-cluster/pages/monitoring.adoc b/docs/modules/maintain-cluster/pages/monitoring.adoc index 917e24d02..e733b06b2 100644 --- a/docs/modules/maintain-cluster/pages/monitoring.adoc +++ b/docs/modules/maintain-cluster/pages/monitoring.adoc @@ -2663,8 +2663,8 @@ Jun 5, 2014 14:18:43 +0300 [72696 62] com.newrelic.agent.jmx.JmxService FINER: Recording JMX metric LastAccessTime : 1,401,962,426,811 ``` -Then you can navigate to your New Relic account and create Custom Dashboards. -See http://docs.newrelic.com/docs/dashboards-menu/creating-custom-dashboards[Creating custom dashboards]. +Then you can navigate to your New Relic account and create custom dashboards. +See link:https://docs.newrelic.com/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards/[Get Started with Dashboards]. While you are creating the dashboard, you should see the metrics that you are sending to New Relic from the Management Center in the **Metrics** diff --git a/docs/modules/pipelines/pages/cdc-database-setup.adoc b/docs/modules/pipelines/pages/cdc-database-setup.adoc index e667e495f..22877d4c8 100644 --- a/docs/modules/pipelines/pages/cdc-database-setup.adoc +++ b/docs/modules/pipelines/pages/cdc-database-setup.adoc @@ -180,14 +180,13 @@ user locally or on `localhost`, using IPv4 or IPv6. Streaming CDC data from other databases supported by Debezium is possible in Hazelcast by using the link:https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/jet/cdc/DebeziumCdcSources.html[generic Debezium source]. This deployment guide however only covers the databases we have first -class support for. For the other ones pls. refer to the Debezium -documentation: - -* link:https://debezium.io/documentation/reference/1.1/connectors/sqlserver.html#setting-up-sqlserver[SQL Server] -* link:https://debezium.io/documentation/reference/1.1/connectors/mongodb.html#setting-up-mongodb[MongoDB] -* link:https://debezium.io/documentation/reference/1.1/connectors/oracle.html#setting-up-oracle[Oracle] -* link:https://debezium.io/documentation/reference/1.1/connectors/db2.html#setting-up-Db2[Db2] -* link:https://debezium.io/documentation/reference/1.1/connectors/cassandra.html#setting-up-cassandra[Cassandra] +class support for. See the following documentation for the other databases: + +* link:https://debezium.io/documentation/reference/stable/connectors/sqlserver.html[SQL Server] +* link:https://debezium.io/documentation/reference/stable/connectors/mongodb.html[MongoDB] +* link:https://debezium.io/documentation/reference/stable/connectors/oracle.html[Oracle] +* link:https://debezium.io/documentation/reference/stable/connectors/db2.html[Db2] +* link:https://debezium.io/documentation/reference/stable/connectors/cassandra.html[Cassandra] == Connector Deployment From efa2d72149204be5ce745d00247375435513f278 Mon Sep 17 00:00:00 2001 From: rebekah-lawrence <142301480+rebekah-lawrence@users.noreply.github.com> Date: Mon, 29 Apr 2024 11:44:23 +0100 Subject: [PATCH 6/7] Putting file back in side nav after 2 years MIA (#1093) This seemed the logical place to me. It was originally under Architecture in the Reference section; then the other three files were moved here (the ones under Partition Groups and Networking), but this file was lost. --- docs/modules/ROOT/nav.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 6ae0627f0..05bcb1678 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -62,6 +62,7 @@ include::maintain-cluster:partial$nav.adoc[] ** xref:clusters:creating-clusters.adoc[Grouping Clusters] ** xref:clusters:partition-group-configuration.adoc[Grouping Partitions] ** xref:clusters:network-configuration.adoc[Networking] +* xref:configuration:jet-configuration.adoc[] include::cluster-performance:partial$nav.adoc[] include::secure-cluster:partial$nav.adoc[] include::fault-tolerance:partial$nav.adoc[] From d2a397361f926ad9cb09b99dc0558bb717b4a615 Mon Sep 17 00:00:00 2001 From: rebekah-lawrence <142301480+rebekah-lawrence@users.noreply.github.com> Date: Mon, 29 Apr 2024 11:46:03 +0100 Subject: [PATCH 7/7] Docs 548 rolling upgrades jet job (#1094) * Noting that Jet doesn't support RU Originally raised from this Slack thread: https://hazelcast.slack.com/archives/CJZ745RRT/p1685950448256829 Addressing before starting the LTS Upgradeability drafting for a clean slate. * Making sure I don't undo Jack's EE/OS variable work --- docs/modules/maintain-cluster/pages/rolling-upgrades.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/modules/maintain-cluster/pages/rolling-upgrades.adoc b/docs/modules/maintain-cluster/pages/rolling-upgrades.adoc index db4f5e0a4..8c13ffc9b 100644 --- a/docs/modules/maintain-cluster/pages/rolling-upgrades.adoc +++ b/docs/modules/maintain-cluster/pages/rolling-upgrades.adoc @@ -48,6 +48,8 @@ As a result, you can use rolling upgrades to upgrade clusters to the following m + This also includes the ability of rolling upgrade from Hazelcast IMDG 4.2 to Platform 5.0, since IMDG is part of the Platform and 5.0 is considered to be the next minor version after IMDG 4.2. +NOTE: Following the rolling upgrade, you must resubmit jobs as they don't run during the upgrade. For further information on the compatibility of job states in upgrades, see xref:deploy:versioning-compatibility.adoc#job-states[Versioning and Compatibility]. + [[rolling-upgrade-procedure]] == Performing a Rolling Upgrade @@ -61,7 +63,7 @@ During migrations, members cannot join or leave the cluster. . Upgrade the member's codebase to a new patch version or the next minor version. + -NOTE: To upgrade the codebase to the next minor version, you need an {enterprise-product-name} license. +NOTE: To upgrade the codebase to the next minor version, you need an Enterprise license. . Start the member and wait until it joins the cluster. + @@ -142,7 +144,7 @@ to merge as soon as the network partition is fixed. == Using Rolling Restarts to Switch to High-Density Memory Store -As a Hazelcast Platform {enterprise-product-name} user, you can perform a rolling restart on your cluster to start using xref:storage:high-density-memory.adoc[High-Density Memory Store] in your maps. +As a Hazelcast Platform Enterprise user, you can perform a rolling restart on your cluster to start using xref:storage:high-density-memory.adoc[High-Density Memory Store] in your maps. For this you need to: