Upgrading Data Grid

Read the following information to ensure a successful upgrade from previous versions of Data Grid 8 to 8.5.

Removals

Change of package for classes

The following classes have been moved to different packages:

Classes, methods, and properties removal

The following methods and properties have been removed:

Metrics

The JGroups and cross-site metrics names change when names-as-tags is set to true, where the cluster’s name and the site’s name are no longer present in the metrics name but as a tag.

As an example, when you set names-as-tags to false, metrics are named based on the channel, resulting in multiple metrics for the same purpose:

# TYPE vendor_jgroups_xsite_frag4_get_number_of_sent_fragments gauge
# HELP vendor_jgroups_xsite_frag4_get_number_of_sent_fragments Number of sent fragments
vendor_jgroups_xsite_frag4_get_number_of_sent_fragments{cluster="xsite",node="..."} 0.0
# TYPE vendor_jgroups_cluster_frag4_get_number_of_sent_fragments gauge
# HELP vendor_jgroups_cluster_frag4_get_number_of_sent_fragments Number of sent fragments
vendor_jgroups_cluster_frag4_get_number_of_sent_fragments{cluster="cluster",node="..."} 2.0

When you set names-as-tags to true, metrics are simplified, and cluster and site names appear as tags:

# TYPE vendor_jgroups_frag4_get_number_of_sent_fragments gauge
# HELP vendor_jgroups_frag4_get_number_of_sent_fragments Number of sent fragments
vendor_jgroups_frag4_get_number_of_sent_fragments{cache_manager="default",cluster="xsite",node="..."} 0.0
vendor_jgroups_frag4_get_number_of_sent_fragments{cache_manager="default",cluster="cluster",node="..."} 2.0

SecurityManager

Aligning with the deprecation for removal of the SecurityManager in Java Development Kit (JDK) 17, integration with a SecurityManager is no longer supported.

Jakarta and Java EE

Hot Rod client defaults

Data Grid introduced changes to the properties of the Hot Rod client.

Additionally, setting the sni_host_name is now required when hostname validation is enabled.

Search

Data Grid 8.5 introduces the following changes to search.

Indexing

Indexing annotations

Security

The PrincipalRoleMapper now applies only to groups instead of both groups and user principals. Use the cache-manager.security.authorization.group-only-mapping=false configuration to use the old behavior.

For more information about the PrincipalRoleMapper API, see Role and permission mappers.

Scattered cache removal

The scattered cache mode has been removed. Use distributed caches instead. For information about cache modes, see Cache modes.

Global State

By default, Data Grid will not start if a dangling lock file is found in the persistent global state indicating an unclean shutdown. You can change the default behavior by configuring the global state unclean-shutdown-action setting. For more information, see Global persistent location.

Persistence

The default value for availability-interval has been increased to 30 seconds. The previous default was 1 second.

Soft-index file stores

To calculate the number of segments, only the number of cache segments is used instead of using index segment configuration, as was done earlier.

RESP endpoint

Data Grid 8.5 introduces the following changes to the RESP endpoint:

Client listeners remove events propagation

To support the changes around the new includeOldValue method on CacheEventConverter, client listeners remove events will now be propagated even if the event does not remove a value.

NearCache SPI update

The previous NearCache SPI had an issue with concurrent updates wherein a stale entry could get stored in the near cache. NearCache SPI has been updated to address this issue.

Upgrade from 8.1 at a minimum

If you are upgrading from 8.0, you must first upgrade to 8.1. Persistent data in Data Grid 8.0 is not binary compatible with later versions. To overcome this incompatibility issue, Data Grid 8.2 and later automatically converts existing persistent cache stores from Data Grid 8.1 at cluster startup. However, Data Grid does not convert cache stores from Data Grid 8.0.

Create a cluster that uses the Data Grid version to which you plan to upgrade and then connect the source cluster to the target cluster using a remote cache store.

When you set up a target Data Grid cluster and connect it to a source cluster, the target cluster can handle client requests using a remote cache store and load data on demand. To completely migrate data to the target cluster, so you can decommission the source cluster, you can synchronize data. This operation reads data from the source cluster and writes it to the target cluster. Data migrates to all nodes in the target cluster in parallel, with each node receiving a subset of the data. You must perform the synchronization for each cache that you want to migrate to the target cluster.

Data Grid provides the CLI migrate store command that recreates data for the latest Data Grid cache store implementations.

The store migrator takes a cache store from a previous version of Data Grid as source and uses a cache store implementation as target.

When you run the store migrator, it creates the target cache with the cache store type that you define using the EmbeddedCacheManager interface. The store migrator then loads entries from the source store into memory and then puts them into the target cache.

The store migrator also lets you migrate data from one type of cache store to another. For example, you can migrate from a JDBC string-based cache store to a SIFS cache store.

Use the migrator.properties file to configure properties for source and target cache stores.

# Example configuration for migrating to a JDBC String-Based cache store
target.type=STRING
target.cache_name=myCache
target.dialect=POSTGRES
target.marshaller.class=org.infinispan.commons.marshall.JavaSerializationMarshaller
target.marshaller.allow-list.classes=org.example.Person,org.example.Animal
target.marshaller.allow-list.regexps="org.another.example.*"
target.marshaller.externalizers=25:Externalizer1,org.example.Externalizer2
target.connection_pool.connection_url=jdbc:postgresql:postgres
target.connection_pool.driver_class=org.postrgesql.Driver
target.connection_pool.username=postgres
target.connection_pool.password=redhat
target.db.disable_upsert=false
target.db.disable_indexing=false
target.table.string.table_name_prefix=tablePrefix
target.table.string.id.name=id_column
target.table.string.data.name=datum_column
target.table.string.timestamp.name=timestamp_column
target.table.string.id.type=VARCHAR
target.table.string.data.type=bytea
target.table.string.timestamp.type=BIGINT
target.key_to_string_mapper=org.infinispan.persistence.keymappers. DefaultTwoWayKey2StringMapper

# Example configuration for migrating from a RocksDB cache store.
source.type=ROCKSDB
source.cache_name=myCache
source.location=/path/to/rocksdb/database
source.compression=SNAPPY

# Example configuration for migrating to a Single File cache store.
target.type=SINGLE_FILE_STORE
target.cache_name=myCache
target.location=/path/to/sfs.dat

# Example configuration for migrating to a Soft-Index File cache store.
target.type=SOFT_INDEX_FILE_STORE
target.cache_name=myCache
target.location=path/to/sifs/database
target.location=path/to/sifs/index

Run the store migrator to migrate data from one cache store to another.