Optional: Installing the Db2 Big SQL console

To extend the power of Cloudera Data Platform (CDP), install the Db2® Big SQL console, the tool for administering, monitoring, and managing Db2 Big SQL performance.

Before you begin

The Db2 Big SQL service must be installed and started before you can install the Db2 Big SQL console.

You can assign the Db2 Big SQL console to a different node from the Hive metastore.

To enable the Db2 Big SQL console to connect to Db2 Big SQL over SSL, the truststore that contains the root certificate for Db2 Big SQL SSL must be copied to the Db2 Big SQL console host. The console user must be able to access and read the truststore.

To enable HTTPS for the Db2 Big SQL console, create a keystore that contains a key pair based on a root CA (self-signed or third party), and a truststore that contains the root CA. The keystore and truststore must be available on the Db2 Big SQL console host and be readable by the console user.

To install the Db2 Big SQL console, you must be the root user or have passwordless sudo root privileges. In addition, java must be added to the path.

About this task

During the Db2 Big SQL console installation process, information in the configuration file /usr/ibmpacks/IBM-Big_SQL/7.1.0.0/bigsql-cli/config/ucconfig.ini is used to properly install and configure the Db2 Big SQL console. As needed, review and update the following properties in the file.

Table 1. Db2 Big SQL console configuration parameters
Property Description Default value
Db2 Big SQL console parameters
uc.hostname Required. The host where you want to install the console. If the value is not provided, the console is installed on the host where the install utility is run.  
uc.http.port Required. The console port. 11080
uc.install.uid Required. The console uid. 2825
uc.install.gid Required. The console group id. 43211
uc.install.user Required. The console service user. consuser
uc.install.group Required. The console group. console
Db2 Big SQL parameters
uc.bigsql.username Required. The Db2 Big SQL service user. bigsql
uc.bigsql.password Required. The Db2 Big SQL service user password. You are prompted to provide the password during installation.  
uc.bigsql.host Required. The Db2 Big SQL service host name. If you do not provide this value, the installation process uses the name of the host where the uc-install utility is run.  
uc.bigsql.port Required. The Db2 Big SQL service port. 32051
Db2 Big SQL console Kerberos client authentication parameter
uc.kerberos.client.auth Required. Instructs the Db2 Big SQL console to authenticate with Db2 Big SQL using Kerberos client authentication. false
Db2 Big SQL console server SSL parameters
uc.https.enabled Specifies access to the Db2 Big SQL console by using HTTPS. false
uc.https.port Default port when SSL is enabled for the Db2 Big SQL console. 11081
uc.keystore.location The file location of the keystore file on the Db2 Big SQL console host. /usr/ibmpacks/bigsql-uc/7.1.0.0/ibm-datasrvrmgr/wlp/usr/servers/dsweb/resources/security/key.jks
uc.truststore.location The file location of the truststore file on the Db2 Big SQL console host. /usr/ibmpacks/bigsql-uc/7.1.0.0/ibm-datasrvrmgr/wlp/usr/servers/dsweb/resources/security/cacerts
Db2 Big SQL console configuration parameters when High Availability (HA) is enabled
uc.bigsql.ha.enabled Specifies whether HA configuration for the Db2 Big SQL console is enabled. false
uc.bigsql.ha.port HA port. 20008
uc.bigsql.secondary.host When Db2 Big SQL HA is enabled, the Db2 Big SQL secondary host name.  
Db2 Big SQL console configuration parameters when Db2 Big SQL SSL is enabled
uc.bigsql.ssl.enabled Specifies whether to connect the Db2 Big SQL console to Db2 Big SQL over SSL. false
uc.bigsql.ssl.port The Db2 Big SQL SSL port. 32052
uc.bigsql.truststore.location The file location of the Db2 Big SQL SSL truststore on the Db2 Big SQL console host. /home/bigsql
Tip: You can configure the options that are not required after the Db2 Big SQL console service is installed.

Procedure

  1. Modify the installation configuration parameters to match your cluster environment by editing the /usr/ibmpacks/IBM-Big_SQL/7.1.0.0/bigsql-cli/config/ucconfig.ini file.
  2. Ensure that Java is available in the path.
    Note: During the installation process, the following command is run to verify that Java is available:
    ssh <uc.hostname> sudo "which java"
  3. If Ranger is enabled, create a policy in the Db2 Big SQL plugin (cm_bigsql) to give the bigsql user all permissions on the database IBMCONSOLE.
  4. Install the Db2 Big SQL console by running the uc-install utility. 
    cd /usr/ibmpacks/IBM-Big_SQL/7.1.0.0/bigsql-cli/
    ./uc-install
  5. When prompted, enter the required passwords.
    For example, enter the Cloudera Manager administrator and Db2 Big SQL user passwords. You might have to enter other passwords, depending on the configuration parameters that you specified, such as the Db2 Big SQL console SSL truststore password.
  6. If Kerberos client authentication is configured, do the following steps to enable access to the Db2 Big SQL console.
    1. Make the following changes to the /usr/ibmpacks/bigsql-uc/7.1.0.0/ibm-datasrvrmgr/Config/metadb.properties file:
      1. Set securityMechanism to 11.
      2. Encrypt the password value.
        Tip: You can use the dsutil/bin/crypt.sh file to encrypt the password.
      3. If the Kerberos principal was created with a different user than bigsql, update the user value.
      Note: The Kerberos principal that is used by the console to connect to Db2 Big SQL must be manually pre-created by a Kerberos administrator with the required password. The principal name must match the user value in metadb.properties, which by default is bigsql.
    2. Stop and start the web gateway dsweb. 
      /usr/ibmpacks/bigsql-uc/7.1.0.0/ibm-datasrvrmgr/wlp/bin/server stop dsweb
      /usr/ibmpacks/bigsql-uc/7.1.0.0/ibm-datasrvrmgr/wlp/bin/server start dsweb
  7. If you want to update the Db2 Big SQL console configuration file after the Db2 Big SQL console was installed, do the following steps:
    1. In the Cloudera Manager UI, stop the Db2 Big SQL console service.
    2. Make the changes in the ucconfig.ini file.
    3. Re-run the uc-install utility.

What to do next

Optional: Enabling SLM tags