Starting the application

This section describes the actions you need to take to successfully deploy the i2 Explore for iBase application.

NOTE: If you have elected to create the ISTORE database manually, this must be done before running the deploy script. Follow the instructions in Manually creating the ISTORE database below.

The application is deployed using the setup script in the analyze-deployment-tooling directory. You can double-click the setup.exe file directly. If you have a more complex deployment, you can run the script from the command line. Navigate to the analyze-deployment-tooling directory in a terminal and run the following command:

  • setup -t deploy

The deploy script will perform the following tasks:

  • Download the required prerequisites if they are not already present in the pre-reqs directory.

  • Generate i2 Explore configuration from your iBase database.

  • Create the ISTORE database in the iBase SQL Server instance.

  • Deploy configuration files to the Liberty application server, Solr and Zookeeper.

  • Start the Liberty application server, Solr and Zookeeper services.

Manually creating the ISTORE database

If you did not supply a user name and password during the installation process, you need to manually create the ISTORE database in the iBase SQL Server instance before you can run the deploy process. To generate the database scripts required to create the ISTORE database, logins and users:

  • Navigate to the analyze-deployment-tooling directory in a terminal.

  • Run the following command:

    • setup -t generateDatabaseScripts

You need to run these scripts on your SQL Server instance to create the ISTORE database and users. Note that generateDatabaseScripts also generates scripts to remove the ISTORE database, logins and users; these can be used later if you want to remove the ISTORE database and users.

When manually creating the ISTORE database, it is also necessary to lookup the collation of the iBase database and use the same collation for the ISTORE database.

To do this:

  1. Run the following query on the iBase database:

    SELECT collation_name
    FROM sys.databases
    WHERE name = ?
  2. Set the Collation property in the following file to the value returned from the query above:

    • <installation_location>/explore-for-ibase/analyze-deployment-tooling/configs/explore-for-ibase/configuration/InfoStoreNamesSQLServer.properties

Deployment Tasks

The following toolkit options and tasks are available to use with the setup script in the deployment tooling.

usage: setup [-t TASK] [-v | --verbose] [-h | --help]

Argument name

Argument description

-t, --task TASK

Specifies the task to perform

-v, --verbose

Enable verbose logging.

-h, --help

Shows this help message, and exits

The default task is deploy, which will run if no task is specified.

The following deployment and setup tasks are available

Name

Description

deploy

Deploy the Explore for iBase environment (default).

generateDatabaseScripts

Generates the database scripts required for manual creation of the ISTORE database.

clean

Stops all services, removes installed binaries, Solr & Zookeeper data, and removes the ISTORE database.

start

Starts all i2 Explore services.

stop

Stops all i2 Explore services.

startLiberty

Starts Liberty.

stopLiberty

Stops Liberty.

startZkHosts

Starts ZooKeeper hosts.

stopZkHosts

Stops ZooKeeper hosts.

startSolrNodes

Starts the Solr nodes.

stopSolrNodes

Stops the Solr nodes.

startSolrAndZk

Starts the Solr nodes and ZooKeeper hosts.

stopSolrAndZk

Stops the Solr nodes and ZooKeeper hosts.

Exploring the deployment

When the installer has completed, the following directory structure will be created in the <installation_location>/explore-for-ibase directory:

explore-for-ibase
├── analyze-deployment-tooling
│   ├── configs
│   │   ├── explore-for-ibase
│   │   │   ├── configuration
│   │   │   │   └── secrets
│   │   │   │       ├── sqlserver
│   │   │   │       │   ├── dba_istore_PASSWORD
│   │   │   │       │   ├── sa_PASSWORD
│   │   │   ├── utils
│   │   │   │   └── variables.conf
|   |── environment-secrets
│   │   │   ├── provided-secrets
│   │   │   │   ├── certificates
│   │   │   │   |   |── externalCA
│   │   │   │   |   |   |── CA.cer
│   │   │   │   |   |── <HOST_FQDN_I2ANALYZE_SERVICE>
│   │   │   │   |   |   ├── server.cer
│   │   │   │   |   |   └── server.key
│   ├── pre-reqs
│   │   ├── jdbc-drivers
│   │   ├── jdk.zip
│   │   ├── solr.tgz
│   │   ├── wlp.zip
│   │   └── zookeeper.tar.gz
│   ├── Setup.exe
├── deploy
│   ├── jdk
│   ├── solr
│   ├── wlp
│   └── zookeeper
├── data
└── logs

Deploy directory

The deploy directory contains the deployed binaries for the i2 Explore for iBase application.

Data directory

The data directory contains temporary data files for the i2 Explore for iBase application.

Logs directory

The logs directory contains the logs for the i2 Explore for iBase application. The logs are generated by the Liberty application server, Solr and Zookeeper services and also the deployment tooling. These can be used by the i2 support team to diagnose issues with the i2 Explore for iBase application.

Making changes to the deployment

You can make changes to the iBase database or ports, after deployment.

iBase database changes

iBase Designer requires exclusive access to the iBase database. Because of this, it might be necessary to stop the i2 Explore services before launching iBase designer. You can do this by running the following command:

  • setup -t stop

When changes are made to the schema of the iBase database, these need to be reflected in the i2 Explore application. Certain changes, like removing item types from the iBase database, can cause errors for users of i2 Explore, but will be rectified once the i2 Explore application has been updated.

The update to i2 Explore is done by running the deploy task of the setup script:

  • setup -t deploy

Changing ports on an existing deployment

If you need to change any of the Liberty, Solr or Zookeeper ports on an existing deployment, you will need to follow these steps:

  1. Run the clean task

    • setup -t clean

  2. Update the variables.conf file with the new port values

    • <installation_location>/explore-for-ibase/analyze-deployment-tooling/configs/explore-for-ibase/utils/variables.conf

  3. Run the deploy task

    • setup -t deploy