Deploying i2 Analyze with i2 Connect

i2 Connect enables analysts to search for and retrieve data from external data sources by using the Opal quick search functionality, and then analyze the results on a chart in Analyst's Notebook Premium.

You can deploy i2 Analyze with support for i2 Connect only, or with the Information Store and i2 Connect.

For more information about deploying i2 Analyze with i2 Connect, see i2 Analyze and i2 Connect.

Before you begin

  • You must complete the Quick deploy or deploy the example manually, and your deployment must be running.

  • If you deployed the example with one of the configurations in the configuration_mods directory or changed the topology.xml file. Reset your example deployment to the base configuration before you deploy i2 Analyze with i2 Connect. To reset your environment, run the following command from the src/scripts directory:

    ./resetEnvironment

Creating the keystores and certificates

Run the createKeysAndStores script to create the stores, certificates, and certificate authority. For example, run the following command from the src/scripts directory:

./createKeysAndStores

You are prompted to enter a password that is used for each of the keystores and truststores that are created. The password that you specify here is used later.

For more information about the stores and certificates that are created, see Keystores and certificates for components of i2 Analyze.

Deploying the example connector

In the distributed deployment example, the example connector is deployed in its own server.

In the Docker environment, the connector_image is created when you run the buildImages script. If you ran the clean script, rebuild and rerun the container. Otherwise, skip to the next step to run the connector container. To build the connector image, run the following command from the src/images folder:

docker build -t connector_image common/connector

The connector image is created with the name connector_image.

To run the connector container, run the following command:

docker run -d --name connector --net eianet --memory=512m \
  --net-alias "connector.eianet" \
  -e "CONNECTOR_ID=example-connector" \
  -e "SSL_ENABLED=true" \
  -e "SSL_PRIVATE_KEY=<ssl_private_key>" \
  -e "SSL_CERTIFICATE=<ssl_certificate>" \
  -e "SSL_CA_CERTIFICATE=<ssl_ca_certificate>" \
  -e "SSL_PASSPHRASE=<ssl_passphrase>" \
  -e "SSL_GATEWAY_CN=liberty.eianet" \
  -e "SSL_SERVER_PORT=3443" \
  "connector_image"

Where the values are:

  • ssl_passphrase should match the value that you entered for i2 Connect connector key store and certificate signing request when you ran the createKeysAndStores script.
  • ssl_private_key is the content of the ./keys/stores/i2-connector-key.key file.
  • ssl_certificate is the content of the ./keys/responses/connector-key.cer file.
  • ssl_ca_certificate is the content of the ./images/common/ca/ca/CA.cer file.

Specifying the credentials

You must specify the credentials for your deployment in the src/configuration/environment/credentials.properties. Set the passwords to use for each of the keystore and truststore credentials. The passwords must match the values that you entered for the corresponding keystores and truststores when you ran the createKeysAndStores script.

For more information about the credentials file, see Modifying the credentials.

You can complete a quick i2 Connect deployment or you can complete the i2 Connect setup manually. Completing the i2 Connect deployment manually requires you to run each of the steps that were completed automatically in the quick i2 Connect deployment so that you can replicate the steps in a non-Docker environment.

Quick deploy

To set up the example connector in the distributed deployment example, a script is provided that deploys i2 Analyze with i2 Connect and the example connector. You can decide whether to deploy i2 Analyze with i2 Connect only, or with the Information Store and i2 Connect.
To deploy with i2 Connect only, you must specify the i2connect configuration modification when you run the deployDaod script.
To deploy with the Information Store and i2 Connect, you must specify the i2connect_istore configuration modification when you run the deployDaod script.

Run the deployDaod script from the src/scripts directory to set up the i2 Analyze deployment with i2 Connect only and start the connector with the correct configuration.

./deployDaod i2connect

For more information about deploying a connector for i2 Connect in a non-Docker environment, see Creating a connector for i2 Connect.

Deploy example connector manually

Stopping Liberty

Run the stopLiberty task on the liberty container:

docker exec -u i2analyze liberty /opt/i2/i2analyze/toolkit/scripts/setup -t stopLiberty

Configuring i2 Analyze

Configure i2 Analyze to use i2 Connect. In the distributed deployment example, you can see the configuration modifications in the src/configuration_mods/<database management system>/i2connect directory.

The updateServerConfigurations script copies a configuration to each of the example containers. To copy the i2 Connect only configuration, run the following command:

./updateServerConfigurations i2connect

If you want to deploy i2 Analyze with the Information Store and i2 Connect, run updateServerConfigurations i2connect_istore.

Deploying i2 Analyze

Run the deployLiberty task on the liberty container:

docker exec -u i2analyze liberty /opt/i2/i2analyze/toolkit/scripts/setup -t deployLiberty

Creating the Solr configuration on ZooKeeper

You can create and upload the Solr configuration from the Admin client, or you can run the command from one of the ZooKeeper servers.

To create the Solr configuration by using the Admin client, run the following command:

docker exec -u i2analyze -t admin_client /opt/i2/i2analyze/toolkit/scripts/setup -t createAndUploadSolrConfig --hostname admin_client.eianet

The Solr configuration is created and uploaded.

Creating the Solr Collection

Create the Solr Collection that is used by a deployment with i2 Connect, run the createSolrCollections task on the admin_client container.

docker exec -t -u i2analyze admin_client /opt/i2/i2analyze/toolkit/scripts/setup -t createSolrCollections --hostname admin_client.eianet

Starting Liberty

To start Liberty, run the following command on the liberty container:

docker exec -u i2analyze liberty /opt/i2/i2analyze/toolkit/scripts/setup -t startLiberty

The console output from the startLiberty task is output directly to the console.

Results

All the setup is completed and the application is started.

Testing the deployment

To test the deployment was configured successfully, connect to i2 Analyze from Analyst's Notebook Premium.

If you deployed i2 Analyze with i2 Connect only, the URL that you use to connect is: http://i2demo:9082/opaldaod.

If you deployed i2 Analyze with the Information Store and i2 Connect, the URL that you use to connect is: http://i2demo:9082/opal.

Log in using the user name Jenny with the password Jenny.

You can use the Search Stores functionality to search for data and query the external source.