Specifying the Java distribution

i2 Analyze comes pre-packaged with the Adoptium Eclipse Temurin JDK 17 distribution of Java. You can change the distribution of Java that is used, and also you can specify different distributions for different components of i2 Analyze.

Before you begin

Any Java distribution that you specify for use with i2 Analyze and its components must be Java version 17.

Note: If you decide to use a different distribution, you assume responsibility for updating that distribution for security patches or if the version that i2 Analyze requires changes.

About this task

To change the Java distribution to use, you modify the setup.in script in the configuration\environment directory to contain the path where it is installed. If you are using the Linux distribution of the i2 Analyze toolkit, this is the setup.in file. On Windows it is setup.in.bat.

The setup.in file contains the following variables:

  • I2A_TOOLKIT_SCRIPTS_JAVA_HOME

    The path to a Java installation that is used to run the toolkit tasks.

    The path can be absolute or a relative path from the root of the toolkit.

    By default, it is \tools\java on Windows and tools/java on Linux.

    Note: When you deploy i2 Analyze, Eclipse Temurin JDK 17 is installed in the default location. If you change the path, you must ensure that an installation of Java 17 exists in the specified location.

  • I2A_COMPONENTS_JAVA_HOME

    An absolute path to a Java installation that is used by the Solr, ZooKeeper, and Liberty components of i2 Analyze. By default, it is C:\i2\i2analyze\deploy\java on Windows and /opt/i2/i2analyze/deploy/java on Linux.

    Note: When you deploy i2 Analyze, Eclipse Temurin JDK 17 is installed in the specified location if it does not contain an installation of Java.

The following variables are commented out in the file, but can be used to specify different Java installations for the components of i2 Analyze. If the file contains these variables, their values override the value of I2A_COMPONENTS_JAVA_HOME for each component.

  • SOLR_JAVA_HOME

    An absolute path to a Java installation that is used by Solr.

  • ZK_JAVA_HOME

    An absolute path to a Java installation that is used by ZooKeeper.

  • LIBERTY_JAVA_HOME

    An absolute path to a Java installation that is used by Liberty.

  • ETL_TOOLKIT_JAVA_HOME

    The path to a Java installation that is used by the ingestion commands in the ETL toolkit. The path can be absolute or a relative path from the root of the ETL toolkit.

    Note: When you create the ETL toolkit, Eclipse Temurin JDK 17 is included as part of the ETL toolkit. If you change the path, you must ensure that an installation of Java 17 exists in the specified location.

The setup.in is part of the configuration, and is copied to each deployment toolkit in your environment. It is recommended that you install Java in the same location on each server where a particular component is located. This means that this file remains the same on each copy of the configuration.

Procedure

  1. In a text editor, open the setup.in script file for your operating system.

  2. Uncomment and update the paths to specify the Java 17 installations that you want to use.

  3. Save and close the file.

What to do next

After you update the file, continue with the rest of the deployment process.