Quick deploy

To deploy the distributed deployment example, scripts are provided that copy any prerequisites and build the docker images, then run the docker containers automatically.

Important: The distributed example uses a Docker environment to demonstrate a distributed deployment of i2 Analyze. The Docker environment is not designed to be used on customer sites for test or production systems. After you understand how the distributed deployment is deployed, replicate the deployment on physical servers.

Note: To deploy the distributed deployment example manually with detailed explanation about all of the steps, see Deploying the example manually on SQL Server, Deploying the example manually on Db2 and Deploying the example manually on Postgres.

Note: If you deployed the distributed deployment example previously, ensure that you clean your environment before you start the manual deployment. For more information about how to clean your system, see Cleaning your environment.

Prerequisites for the distributed deployment example

Download, install, and configure the prerequisites for the distributed deployment example.

Bash shell

The scripts that are used in the distributed deployment example are Shell scripts. If you are on Windows, you can use WSL 2 as the backend for Docker and to run the shell scripts in this repository.

To install WSL, in an administrator Command Prompt, run:
```
wsl --install
```
Then, restart your machine.
For information about installing WSL, see Install Linux on Windows with WSL.
Configure your WSL user. For more information, see Set up your Linux username and password.

Npm

The scripts that are used in the distributed deployment example requires npm to be installed in the bash shell. For more information, see Downloading and installing Node.js and npm.

Docker

You must install Docker CE for your operating system. For more information about installing Docker CE, see https://docs.docker.com/engine/install/.

Install Docker CE for your operating system. For more information about installing Docker CE, see https://docs.docker.com/engine/installation/.
- Mac OS : Install Docker CE
- Windows :
  1. Install Docker CE
  2. Set up Docker on WSL 2
After you install Docker, allocate at least 5GB of memory to Docker to run the containers in the example deployment.

On Windows, Docker is automatically allocated 8GB or 50% of available memory whichever is less.

For more information about modifying the resources allocated to Docker, see:
- Docker Desktop for Windows
- Docker Desktop for Mac

To test that your Docker command line environment is initialized correctly, run the following command:

docker run hello-world

Example code

Clone or download the distributed deployment example from https://github.com/i2group/analyze-deployment/releases.

Analyst's Notebook

Download i2 Analyst's Notebook version 10 by using the usual mechanism.

Install Analyst's Notebook with the Opal connector on a Windows machine that can access the machine where Docker is running.

Note: If you are running Docker on Mac OS, you can install Analyst's Notebook Premium on a Windows virtual machine.

For more information, see Installing i2 Analyst's Notebook.

i2 Analyze

Download i2 Analyze for Linux. You download the I2A_V4.4.3_LINUX.tar.gz version 4.4.3 by using the usual mechanism.

Rename the .tar.gz file to i2analyze.tar.gz, then copy it to the src/images/common/ubuntu_toolkit/i2analyze directory.
Accept the i2 Analyze license by opening license_acknowledgment.txt in the src/images/common/ubuntu_toolkit/i2analyze directory and changing the value of LIC_AGREEMENT to ACCEPT.
Add the mssql-jdbc-7.4.1.jre11.jar file to the src/configuration/environment/common/jdbc-drivers directory.

Note: Download the Microsoft JDBC Driver 7.4 for SQL Server from Microsoft JDBC Driver 7.4 for SQL Server. Extract the contents of the tar.gz, and locate the sqljdbc_7.4\enu\mssql-jdbc-7.4.1.jre11.jar file.
Add the postgresql-xx.x.x.jar file to the src/configuration/environment/common/jdbc-drivers directory.

Note: Download the latest (Java 8) PostgreSQL JDBC Driver for PostgreSQL from https://jdbc.postgresql.org/download/

Specifying the credentials

You must specify the credentials for a deployment in the src/configuration/environment/credentials.properties. Set the passwords to be used for the Information Store, Solr, and the LTPA keys.

The password that you specify for the Information Store must be at least 8 characters long and contain characters from three of the following four sets: Uppercase letters, Lowercase letters, Base 10 digits, and Symbols.

For more information about the credentials file, see Modifying the credentials. To complete the quick deployment, enter passwords for the db.infostore.password, solr.password, and ltpakeys.password credentials.

Build the Docker images

In the src/scripts directory, run the buildImages file:

./buildImages

The first time that you run this script, it might take about 15 minutes to complete. After, a cache is used and this process is quicker.

Check that the images built correctly by using the Docker images command:

docker images

The following images must be listed: sqlserver_image, zookeeper_image, zookeeper2_image, zookeeper3_image, solr_image, solr2_image, admin_client_sqlserver_image, liberty_sqlserver_image, and ubuntu_toolkit_image.

Run the Docker containers

In the src/scripts directory, run the runContainers file:

./runContainers

You are prompted to enter a password for the SA user, this is the system administrator user for the SQL Server container. The password that you specify must be at least 8 characters long and contain characters from three of the following four sets: Uppercase letters, Lowercase letters, Base 10 digits, and Symbols.

You are prompted to enter a password for the i2analyze user. Enter the password that you specified in the credentials.properties file for the db.infostore.password credential.

After the script in the runContainers file completes, all the containers are run and i2 Analyze is deployed.

Test the deployment

To configure Windows to connect to the Docker container by using the specified URL, you must change the hosts file.
Open a command prompt as ADMINISTRATOR, and navigate to the following location: C:\Windows\System32\drivers\etc.

Open the hosts file in a text editor. At the end of the file, add your IP Address followed by i2demo. For example:

127.0.0.1 i2demo

NOTE: You must run Analyst's Notebook Premium on Windows. If you deploy the distributed deployment example on MAC, you can use a Windows virtual machine to host Analyst's Notebook Premium. For your virtual machine to connect to i2 Analyze, complete the following:

On your MAC terminal, run ifconfig and identify the IP address for your virtual machine in a section such as vmnet1. For example, 172.16.100.1.

Then, on your Windows virtual machine add the following line to the C:\Windows\System32\drivers\etc\hosts file:
172.16.100.1 i2demo

To test the deployment, connect to i2 Analyze from Analyst's Notebook Premium. The URL that you use to connect is: http://i2demo:9082/opal.

Use the Upload records functionality to add data to the Information Store, and then search for that data.

What to do next

To understand the distributed deployment example, what is deployed, and how it is deployed, complete the detailed instructions in deploying the example manually.