Installing, configuring, and starting SQL DI

The installation and configuration of SQL Data Insights (SQL DI) involves a sequence of guided tasks. First, you use the SMP/E program to install the SQL DI base product and apply the latest maintenance (APARs/PTFs). Then, you run a shell script to configure the SQL DI application interactively or silently. After starting the application, you can perform a simple task to verify the installation and configuration by using the SQL DI web user interface (UI), the REST API, or the shell command-line interface (CLI).

Before you begin

Meet all system requirements, including the application of Db2 and z/OS® APARs that provide SQL DI support, as described in Preparing for SQL DI installation.
Obtain the following SQL DI program directory and function code packages:
- Db2 13 for z/OS SQL Data Insights Program Directory
- SQL DI base product installation package (HDBDD18).
- SQL DI APARs PH66445 and PH66446 that contain the function code of the latest updates.

Procedure

Transfer the SQL DI program directory and function code packages onto your Z system.
Follow the instructions in the program directory to install SQL DI and apply fixes.

The SMP/E program installs SQL DI in the $SQLDI_INSTALL_DIR directory. The default $SQLDI_INSTALL_DIR directory is /usr/lpp/IBM/db2sqldi/.
Verify that SMP/E was executed successfully for all function code packages.
Create a separate SQLDI_HOME directory, with a minimum of 100 GB free disk space, to store the SQL DI configuration and log files.
Configure the SQL DI application interactively or silently.
In interactive mode, you invoke a shell script for configuring SQL DI, follow onscreen prompts, and enter requested input one by one until the guided configuration completes. In silent mode, on the other hand, you take a configuration template file, populate it with information for all predefined parameters, run a supplied shell script, and specify the customized configuration file as input.
To configure SQL DI in interactive mode:
1. In a bash session, change to the $SQLDI_INSTALL_DIR/sql-data-insights/bin directory.
2. Execute the SQL DI configuration script by issuing the following command:
```
./sqldi.sh create
```
3. For each prompt, respond by entering the requested information or accepting the default.
  - Enter the SQLDI_HOME directory where your SQL DI configuration and log files will be stored.
  - Enter the IP address or hostname for your SQL DI application.
  - Enter the port number for your SQL DI application or press Enter to use the default port of 15001.
  - Enter the name for the SQL DI login group or press Enter to use the default group name SQLDIGRP.
  - Enter the max time to live (in hours) for the SQL DI authorization token or press Enter to use the default value of 168.
  - Enter your keystore information.
    SQL DI requires one of the following keystore types:
    1. JCERACFKS (for managing RACF® certificates and keys)
    2. JCECCARACFKS (for managing RACF certificates and keys and exploiting hardware cryptography)
    
    Select your keystore type and then enter the keyring name, the keyring owner, and the label of your SSL certificate.
  - Enter the IP address or hostname of your Spark master.
  - Enter the port number of your Spark master or press Enter to use the default port of 7077.
  - Enter the port number of your Spark master REST API or press Enter to use the default port of 6066.
  - Enter the port number of your Spark master web UI or press Enter to use the default port of 8080.
    Apache Spark provides a suite of web UIs, including the master web UI and the worker web UI, for monitoring the status and resource consumption of your Spark cluster. If needed, see Spark web interfaces for instructions how to configure and use these UIs.
  - Enter the port number of your Spark worker or press Enter to use a system-assigned port.
  - Enter the port number of your Spark worker web UI or press Enter to use the default port of 8081.
  - Enter the port number of your Spark driver or press Enter to use a system-assigned port.
  - Enter the port number of your Spark block manager or press Enter to use a system-assigned port.
  - Enter the driver-specific port for the Spark block manager to listen on or press Enter to use a system-assigned port as the default.
  - Enter the maximum number of retries when binding to a port or press Enter to use the default number of 16.
    The installation process continues. You will see a message similar to the following example when it completes:
```
Congratulations! You have successfully configured SQL Data Insights.
```
  - Confirm or decline to start your SQL DI automatically. If you confirm, the current command process will start SQL DI automatically. If you decline, start SQL DI manually at Step 6.
To configure SQL DI in silent mode:
1. In a bash session, change to the $SQLDI_INSTALL_DIR/templates directory.
2. Create the required command input file by copying and customizing the install_file.template file.
  See Creating the input file for a SQL DI shell command and Shell commands for SQL Data Insights configuration, administration, and object model management for instructions.
  Note that like in interactive mode, SQL DI can automatically start the application in silent mode after it is successfully configured. Set the START_SERVICE property to Y if you want to start SQL DI automatically. Otherwise, keep the default START_SERVICE=N setting so that you can manually start the application at Step 6.
3. Change to the $SQLDI_INSTALL_DIR/sql-data-insights/bin directory.
4. Activate the SQL DI configuration in silent mode by invoking the sqldi.sh script with the create command.
  Assume that you created input file sqldi_silent_cfg_input and that you specified START_SERVICE=N. Issue the create command with the -s option as shown below:
```
./sqldi.sh create -s sqldi_silent_cfg_input
```
  The configuration process runs silently. You will see a message similar to the following example when it completes:
```
Congratulations! You have successfully configured SQL Data Insights.
```
Start your SQL DI application by issuing the following command:
```
./sqldi.sh start
```
Your SQL DI is successfully started if you see a message similar to the following example:
```
SQL Data Insights will use SQLDI_HOME to store configuration files and logs.
Bash version is 5.2.15
Starting SQL Data Insights ...
Reading configurations ...
Generating required configuration files ...
Launching SQL Data Insights ...

.............

SQL Data Insights is successfully started.

You can access it at https://<SQLDI-IPAddress>:<SQLDI-PortNumber>
```
Where:
- SQLDI-IPAddress is the IP address that you entered or the default you accepted for your SQL DI server during the configuration. Make note of this URL and distribute it to your users.
- SQLDI-PortNumber is the port number that you entered or the default you accepted for your SQL DI server during the configuration.
Verify that the SQL DI application is up and running.

You can check if the SQL DI is operational by logging in the application or performing a simple task with the web UI, REST API, or shell CLI. See Verifying the installation and configuration of SQL DI by using the web UI for an example of how to use the web UI to verify the installation and configuration.