Installing Cloud Application Business Insights · Installing Cloud Application Business Insights...

IBM Cloud Application Business InsightsVersion 1.1.1

Installing IBM Cloud ApplicationBusiness Insights

GC27-8792-01

IBM

IBM Cloud Application Business InsightsVersion 1.1.1

Installing IBM Cloud ApplicationBusiness Insights

GC27-8792-01

IBM

NoteBefore using this information and the product it supports, read the information in “Notices” on page 25

This edition applies to the IBM Cloud Application Business Insights, Version 1.1.1 and to all subsequent releasesand modifications until otherwise indicated in new editions.

© Copyright IBM Corporation 2018.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Chapter 1. Installing IBM CloudApplication Business Insights . . . . . 1

Chapter 2. System requirements . . . . 3Hardware requirements. . . . . . . . . . . 3Software requirements . . . . . . . . . . . 4Supported third-party database drivers for JDBCConnector . . . . . . . . . . . . . . . 4

Chapter 3. Installing . . . . . . . . . 7Planning for Cloud Application Business Insightsinstallation . . . . . . . . . . . . . . . 7

Downloading and extracting the software . . . 7Installing Cloud Application Business Insights . . . 8Postinstallation tasks . . . . . . . . . . . 11

Changing default port numbers. . . . . . . 11

Encrypting passwords . . . . . . . . . . 12Adding or modifying user information in registry 12Securing the Cloud Application Business Insightsapplication in WebSphere Application ServerLiberty . . . . . . . . . . . . . . . 13IBM License Metric Tool compliance . . . . . 19Verifying the installation . . . . . . . . . 19Accessing the IBM Cloud Application BusinessInsights web interface . . . . . . . . . . 20

Uninstalling Cloud Application Business Insights. . 22

Notices . . . . . . . . . . . . . . 25Trademarks . . . . . . . . . . . . . . 27Terms and conditions for product documentation. . 27IBM Online Privacy Statement . . . . . . . . 28

© Copyright IBM Corp. 2018 iii

iv Installing Cloud Application Business Insights

Chapter 1. Installing IBM Cloud Application Business Insights

Describes how to install Cloud Application Business Insights application on an RHEL 7.x system. CloudApplication Business Insights doesn’t require any configuration setup to be done to start using it.

About this task

This document has the following sections:v System requirementsv Installationv Postinstallationv Uninstallation

© Copyright IBM Corp. 2018 1

2 Installing Cloud Application Business Insights

Chapter 2. System requirements

A complete set of hardware and software requirements for Cloud Application Business Insights areprovided here.

Lists the supported platforms and components of IBM® Cloud Application Business Insights, V1.1.1.

Cloud Application Business Insights can be connected IBM Cloud Application Performance Managementand IBM Tivoli® Monitoring to create customized dashboards from these data sources.

It can also be connected with third-party databases to retrieve and display data in the designeddashboards.

Hardware requirementsHardware specifications for Cloud Application Business Insights.

MemorySuggested memory (RAM) to run the Cloud Application Business Insights application is 16 GB.

Disk spaceSuggested disk space is at least 200 GB for the Cloud Application Business Insights application.

CPU 4 Core CPU (x86-64) with a processor speed of 2.4 GHz

Desktop resolution1024X786

Port requirements

Make sure that the following ports are opened and available:

Table 1. Port number requirements

Component Port number

Derby database 1529

Cloud Application Business Insights application 443Note: This port number is preconfigured in$install_dir/wlp/usr/servers/icabi/server.xml.

Cloud Application Business Insights OIDC server(icabiap)

9443Note: This port number is preconfigured in$install_dir/wlp/usr/servers/icabiap/server.xml.

Apache NiFi - based Connector Data services 8050

Apache NiFi - based Connector Config services 8051

Apache NiFi UI 8081

Apache Directory Server LDAP 10389


Software requirementsSoftware specifications for Cloud Application Business Insights.

Operating system Version

Red Hat Linux x86-64 bit 6.x

7.x

lsof utility package Supported version for your Operating system. If it is notinstalled, run the following command to install it:

sudo yum install lsof -y

Web browsers Version

Mozilla Firefox ESR 52 or later

Google Chrome 59 and 60 or later

Internet Explorer 11 or later

Safari on Mac Operating System 10.1

Important: Plug-ins or extensions in the browser can result in abnormal behavior of some dashboardfeatures. For example, the Badge widgets might not work as expected if Selenium IDE extension isenabled in your browser. Make sure to disable the plug-ins one by one for all the dashboard features towork as expected.

Bundled software Version

Apache DerbyNote: Derby database is required to store the coredatabase tables from Cloud Application BusinessInsights.

10.14.1.0

Apache NiFi 1.7.0

IBM Java™ 8.0.5.25

WebSphere® Application Server Liberty 18.0.0.4

Apache Directory Server 2.0.0

Supported software for Connector Sources Version

IBM Cloud Application Performance Management 8.1.4

IBM Tivoli Monitoring 6.3 Fix Pack 3 or later

Supported third-party database drivers for JDBC ConnectorYou can set up connectivity to various databases and use content from those databases to populate thedashboards.

The following third-party databases are supported:

Driver name Database version Type of driver File name

Oracle 12.2.0.1

18c (18.3.0.0.0)

Type 4 ojdbc8.jar


Driver name Database version Type of driver File name

IBM Db2® 10.1 Type 4 db2jcc4.jar

11.1

PostgreSQL 9.6 Type 4 postgresql-42.2.2.jar

10

MySQL 8 Type 4 mysql-connector-java-8.0.13.jar

Microsoft SQL Server 10.0 (2008) Type 4 mssql-jdbc-6.4.0.jre8.jar

14.0 (2017)

H2 1.3 Type 4 h2-1.3.175.jar

1.4 h2-1.4.197.jar

Derby 10.1 Type 4 derby.jar

derbyclient.jar11.1

Chapter 2. System requirements 5


Chapter 3. Installing

The installation information contains the installation prerequisites, instructions for preparing to install,installing, and uninstalling the software.

About this task

Install Cloud Application Business Insights to create custom dashboards to visualize data from IBMCloud Application Performance Management, IBM Tivoli Monitoring, or any database with JDBC driverconnectivity.

Planning for Cloud Application Business Insights installationBefore you install the product, read the hardware and software requirements.

Downloading and extracting the softwareDownload the IBM Cloud Application Business Insights installation image from the IBM PassportAdvantage website.

Before you begin

Sufficient disk space must be available on the server where you want to upgrade Cloud ApplicationBusiness Insights.

Procedure1. Download and copy the electronic installation image to a location of your choice. For example,

/home/INSTALLERS is referred to as DIST_DIR.2. Extract the software by using the following command:

tar -xvf ibm_icabi_1.1.1.0_<offering_type>.tar

Where <offering_type> can be BP for Base Private and AP for Advanced Private.You can see the following files and folders in the DIST_DIR directory:v bin

– ibm_icabi_WLP_installer-<build-number>.x86_64.rpm

This rpm package is to install the Cloud Application Business Insights application.– ibm_icabi-<build-number>.x86_64.rpm

This rpm package is to install WebSphere Application Server Liberty.– prdconnector-<build-number>.x86_64.rpm

This rpm package is to install the Apache NiFi-based connectors.v backupForUpgrade.sh

v configure_server_address.sh

v install

v install_cloud

v install_prdconnector

v install_prdui

v Installation.log

Contains the installation log messages.


http://www-01.ibm.com/software/passportadvantage/

http://www-01.ibm.com/software/passportadvantage/

v rollback

v uninstall

v uninstall_prdconnector

v uninstall_prdui

v upgradeScript.sh

v upgradeTechnologyPack.sh

Installing Cloud Application Business InsightsUse this information to install the Cloud Application Business Insights in on-premise mode.

Before you begin

Ensure that the user has recursive write and run access to folder where you copied and extracted the TARfile for Cloud Application Business Insights. For example, /home/INSTALLERS is referred to as DIST_DIR.

Procedure1. Run the following command to install Cloud Application Business Insights as root user:

cd $DIST_DIR./install <installation_mode> <install_dir>

Where:v <installation_mode>

The installation mode is onprem.v <install_dir>

The directory where you want to install the application. If you don’t specify the installationdirectory, it’s installed in /opt/icabi folder by default.

For example, in non-default installation:./install onprem /home/icabi

2. Provide the user name for the default user when prompted. The following tasks are performed in thebackground:v WebSphere Liberty Profile is installed.v IBM Cloud Application Business Insights application is installed in onprem mode.v A tenant by name default is created.v The following schemas are created in the database:

– PRDCONN– PRD_ENGINE– PRD_TOOL

v The following default tenant schemas are created:– T_DEFAULT_CONN– T_DEFAULT_ENGINE– T_DEFAULT_TOOL

3. Optional: If you’re reinstalling Cloud Application Business Insights, then complete the followingsteps:a. Uninstall Cloud Application Business Insights.

See “Uninstalling Cloud Application Business Insights” on page 22.b. Run the install command as specified in step 1.

4. Provide the IP address and hostname of the Cloud Application Business Insights server at the end ofinstallation process when prompted.


5. Optional: If you want to change the IP address and hostname after the installation, run the followingscript:cd $DIST_DIR./configure_server_address.sh <DIST_DIR>

./configure_server_address.sh[WARNING] No installation directory specified.Usage is ’./configure_server_address.sh [installation directory]’.To continue with default installation directory ’/opt/icabi’, press ’y’: y

Provide server address details below:

Enter server IP: xx.xx.xx.xxEnter server hostname ( press Enter to skip ): myserver.ibm.com

[INFO] Server address details updated successfully.

Results

Default installation output:./install onprem

[WARNING] No installation directory specified. Installing at opt/icabi.Installing ICABI UI...

Preparing...########################################Installing ibm_icabi at directory.Updating / installing...ibm_icabi-1.1.1.<build_number>########################################ibm_icabi installed successfully.Writing path to jvm.optionsPreparing...########################################Installing ibm_icabi_WLP at directory.Updating / installing...ibm_icabi_WLP_installer-1.1.1.<build_number>########################################ibm_icabi_WLP installed successfully.[INFO] Package install complete.**********Creating DB**********Executing - tool_createSchema.sqlExecuting - tool_createTable.sqlExecuting - tool_default_data.sqlExecuting - engine_create_schema.sqlExecuting - engine_create_table.sqlDatabase created successfully[INFO] Configuring the cronjob for Logging XML requirement.Cronjob configured Successfully.

[INFO] Default User will have System Administrator privilege in Dashboard Designer and Viewer privilege in Engine.

Please enter Username for Default User and press [Enter]: smadmin

[INFO] Default user created successfully.[INFO] Installation is successful.Installation of ICABI UI is completed, now installing Connector..[WARNING] No installation directory specified. Installing at opt/icabi/connector.Preparing...########################################Updating / installing...prdconnector-1.1.1.<build_number>########################################[INFO] Package install complete.Starting Apache LDAP Server used by Connector...Using ADS_HOME: /opt/icabi/connector/apacheds-2.0.0-M24Using JAVA_HOME: /opt/icabi/connector/ibm-java-1.8.0_191

Chapter 3. Installing 9

Starting ApacheDS instance ’default’...Initiating Connector Configuration Setup...[INFO ] Connector Configuration Setup -> Starting the Initial Configuration Setup for ’Connector’.[INFO ] Connector Configuration Setup -> Success: Initial Configuration Setup for ’Connector’ is complete. Exiting the utility.

Starting Connector Server...

Java home: /opt/icabi/connector/ibm-java-1.8.0_191NiFi home: /opt/icabi/connector/nifi-1.7.0

Bootstrap Config File: /opt/icabi/connector/nifi-1.7.0/conf/bootstrap.conf

Waiting for Connector Server to start...Please wait...Please wait...Connector Server is started with Process ID: 26733[INFO] Creating ’default’ Tenant for onprem mode...[INFO ] Connector Tenant Setup -> Starting the Tenant Setup process for ’Connector’.[INFO ] Connector Tenant Setup -> Executing the query(s) for adding tenant specific data in Connector.[INFO ] Connector Tenant Setup -> Query(s) execution is complete.[INFO ] Connector Tenant Setup -> Connecting to Apache NiFi Secured URL and getting the access token.[INFO ] Connector Tenant Setup -> Performing changes in Apache NiFi for setting up the tenant specific process group.[INFO ] Connector Tenant Setup -> Waiting for 10 seconds to sync with processors in Apache NiFi.[INFO ] Connector Tenant Setup -> Tenant specific process group is created in Apache NiFi.[INFO ] Connector Tenant Setup -> LDAP entries for tenant specific user -to be used for Connector process flow changes - are added successfully.[INFO ] Connector Tenant Setup -> Waiting for 20 seconds to sync LDAP Entries with Apache NiFi...[INFO ] Connector Tenant Setup -> View and Modify access policies are applied to tenant specific user in Apache NiFi.[INFO ] Connector Tenant Setup -> Success: Tenant is setup in ’Connector’. Exiting the Connector Tenant Setup utility.

Installation of Connector completed successfully.

Provide server address details below:Enter server IP: xx.xx.xx.xxEnter server hostname ( press Enter to skip ):myserver.ibm.com[INFO] Server address details updated successfully.

What to do nextv You can change the default Cloud Application Business Insights port numbers. For more information,

see “Changing default port numbers” on page 11.v Start Cloud Application Business Insights server, Cloud Application Business Insights OIDC server, and

Derby database with the following command:cd $install_dir./start_icabi.sh

You can see the following output:Derby process is already runningStarting server icabi.Server icabi started with process ID 22550.Starting server icabiap.Server icabiap started with process ID 22979.

v After the installation is successful, update the basic-registry.xml with the default user name andencrypted password.For more information, see “Adding or modifying user information in registry” on page 12.

Related tasks:“Encrypting passwords” on page 12After you install Cloud Application Business Insights, you must run the AES_Encryptor.sh script to setand encrypt password for the default user, smadmin. For security reasons, you must also encryptpasswords of all the users that you create to access Dashboard Designer, Engine, and databases.


Postinstallation tasksPerform these postinstallation tasks after the installation of Cloud Application Business Insights.

Changing default port numbersAfter Cloud Application Business Insights installation, Cloud Application Business Insights server isinstalled at a default port, 443 and Cloud Application Business Insights OIDC server is installed at adefault port, 9443. However, you can change these default ports immediately after you install CloudApplication Business Insights before starting Cloud Application Business Insights server or lateraccording to your requirement.

Before you beginv Ensure that Cloud Application Business Insights server is stopped.

To stop Cloud Application Business Insights server, go to the directory where Cloud ApplicationBusiness Insights is installed and run the stop_icabi.sh script that stops the following servers anddatabase:– Cloud Application Business Insights server, ICABI– Cloud Application Business Insights OIDC server, ICABIAP– Derby database

v Ensure that you have the information about the unassigned ports that you want to assign to CloudApplication Business Insights.

Procedure

Complete the following steps to change the default port numbers:1. Go to Cloud Application Business Insights installation directory as follows:

cd $install_dir

Where: install_dir is the directory where you installed the application.2. Open the icabi_config file.3. Change the default port values that are provided for ICABI_APPLICATION_NEW_PORT and

ICABIAP_APPLICATION_NEW_PORT parameters. For example,ICABI_APPLICATION_NEW_PORT=9066ICABIAP_APPLICATION_NEW_PORT=4059

4. Save the icabi_config file.5. Run the following command to change the port numbers:

./changeApplicationsPort.sh

6. Run the following script to start the servers and database:./start_icabi.sh

The ports are updated.

What to do next1. To verify the updated port number that must be used in the URL, open the bootstrap.properties

that is placed at the following location:cd $install_dir/wlp/usr/servers/icabi

2. Copy the port number that is displayed for default.https.port parameter, and use it in the CloudApplication Business Insights URLs:v Dashboard Designer tool URL:

https://<IP_address>:<port_number>/dashboardTool/html/dashboard.jsp

For example, https://xx.xx.xx.xx:9066/dashboardTool/html/dashboard.jsp


v Engine URL:https://<IP_address>:<port_number>/prdAngular/jsp/index.jsp

For example, https://xx.xx.xx.xx:9066/prdAngular/jsp/index.jsp

Encrypting passwordsAfter you install Cloud Application Business Insights, you must run the AES_Encryptor.sh script to setand encrypt password for the default user, smadmin. For security reasons, you must also encryptpasswords of all the users that you create to access Dashboard Designer, Engine, and databases.

About this task

An administrator must encrypt all the passwords and save them in the following files:v All the user passwords must be saved in the $install_dir/wlp/usr/servers/icabiap/basic-

registry.xml file.

Where, install_dir is the location where the Cloud Application Business Insights application is installed.

Procedure

Complete the following steps to set and encrypt a password for smadmin user:1. Go to the resources folder as follows:

cd $install_dir/wlp/usr/servers/icabiap/resources

Where: install_dir is the directory where you installed the application.

Note: The AES_Encryptor.sh script is also available in install_dir/wlp/usr/servers/icabi/resourcesfolder.

2. To set and encrypt a password for smadmin user, run the following script:./AES_Encryptor.shPlease enter a string to encrypt and press [ENTER]: adminpassword

Where, adminpassword is the password for smadmin user.After you type a password and press enter, an encrypted string is displayed. For example,{aes}AJgBvtFdTqE9j+va0P9peq4xfr1K//gVy4vhh13/sAYv

Similarly, you can set and encrypt passwords of all the other users.3. You must copy this string to the basic-registry.xml file that is placed at the following location:

$install_dir/wlp/usr/servers/icabiap/basic-registry.xmlWhere, install_dir is the location where the Cloud Application Business Insights application isinstalled.

4. Add the default user name and its encrypted password string within the <basicRegistry> element asfollows:<basicRegistry id="basic" realm="admin">

<user name="smadmin" password="{aes}AJgBvtFdTqE9j+va0P9peq4xfr1K//gVy4vhh13/sAYv"/></basicRegistry>

Similarly, for all the other users, you must copy and paste encrypted password in the$install_dir/wlp/usr/servers/icabiap/basic-registry.xml file.

5. Save the basic-registry.xml file.

Adding or modifying user information in registryAfter you add or delete a user in Dashboard Designer tool, you must also update the basic-registry.xmlfile to include or delete a user name and password of that user.


Before you begin

Ensure that the user is already added or deleted in Dashboard Designer or Engine.

Procedure

Complete the following steps to add user name and password to the basic-registry.xml file:1. As a root user, open the basic-registry.xml file from the following location:

cd $install_dir/wlp/usr/servers/icabiapvi basic-registry.xml

Where, install_dir is the directory where you installed the application. However, during installation, ifyou do not specify a different installation location, then by default the application is installed in/opt/icabi folder.

2. Encrypt the passwords.For more information, see Encrypting passwords section in Installing IBM Cloud Application BusinessInsights.

3. Add, modify, or delete the user and password entry in basic-registry.xml file as follows:a. Add a user name and its encrypted password entry within the <basicRegistry> element as

follows:<server description="External Datasource Configuration"><basicRegistry id="basic" ignoreCaseForAuthentication="true" realm="admin">

<user name="smadmin" password="smadmin" /></basicRegistry>

</server>

Note: If the ignoreCaseForAuthentication is set to true, the case-insensitive username can beused to log in to the application.

b. Optional: Modify an existing user name or password from within the basicRegistry element inbasic-registry.xml.

c. Optional: Delete an existing user name or password entry from the basicRegistry element inbasic-registry.xml.

Note: When you delete a Dashboard Designer tool or Engine user from the user interface, makesure to delete the user entry from the basic-registry.xml file also.

4. Save the basic-registry.xml file.

Securing the Cloud Application Business Insights application inWebSphere Application Server LibertyTo understand the basic workflow of security in Liberty, some common security terms are detailed.


About this task

Security key terms

AuthenticationAuthentication confirms the identity of a user. The most common form of authentication is username and password, such as through basic authentication or from login for web applications.

AuthorizationAuthorization determines whether a user has access to a specific role within the system.

Role A role is defined within the Java EE application. In Java EE, subjects are granted or denied accessto a role based on the roles they perform within the application.

SubjectTypically, the term subject means active entities within the system, such as users on the system,and even the system process itself.

When you are using Cloud Application Business Insights V1.1.1, you can use the OpenID ConnectRelying Party server and the OpenID Connect Provider server both run on the same system, or use athird-party OIDC.

Configuring third party OIDCOIDC is a simple identity protocol and open standard that is built on the OAuth 2.0 protocol. OIDCprovides an abstraction between the application server and the underlying authentication mechanism. Itenables client applications to rely on authentication that is done by an OIDC Provider to verify theidentity of a user. OIDC provides user information encoded in a JSON Web Token, or JWT.

About this task

Use this information to configure third party OIDC provider. Examples in this topic show the usage ofOIDC from Cloud APM. All the examples in the procedure are given with the assumption that you haveinstalled Cloud Application Business Insights server in default location. That is, /opt/icabi.

Note: The date and timestamp must be same on Cloud APM OIDC and Cloud Application BusinessInsights server systems.

Procedure1. Update the icabi_config file as follows:

vi /opt/icabi/icabi_config

Update the following parameter:customOIDC=true

2. Update the bootstrap.properties file in Cloud Application Business Insights server (icabi) as follows:cd /opt/icabi/wlp/servers/icabivi bootstrap.properties

oidc.rp.id=RP #modification not requiredoidc.rp.clientId=icabi # modification not requiredoidc.rp.clientSecret=<your secret key>oidc.id=<OIDC_provider_id>oidc.hostname=<OIDC hostname>oidc.port=<OIDC port>oidc.logout.endpoint.path=<OIDC logout endpoint path>

Where:

oidc.idIt must match the ID used in the OIDC. In Cloud APM, it is OP.


oidc.rp.clientSecret

Provide the encrypted secret passcode for the OIDC server. You can generate an encoded andencrypted password by using the $install_dir/wlp/usr/servers/icabi/resources/AES_Encryptor.sh.

Note: This oidc.rp.clientSecret password must be same on your custom OIDC entry and CloudApplication Business Insights server entry.

oidc.hostname=<Hostname/IP address>The hostname or IP address of your OIDC server. For example, myserver.ibm.com.

oidc.port=port_number

OIDC application port number. For example, 8099 for Cloud APM.

oidc.logout.endpoint.pathThe logout endpoint clears the provider-side session and cookies for a web browser.

3. Optional: If you want to provide any additional information, update the server-relying-party.xmlfile as follows:cd /opt/icabi/wlp/usr/servers/icabivi server-relying-party.xml

Provide the following information:<openidConnectClientid="${oidc.rp.id}"clientId="${oidc.rp.clientId}"clientSecret="${oidc.rp.clientSecret}"authorizationEndpointUrl="https://${oidc.hostname}:${oidc.port}/oidc/endpoint/OP/authorize"tokenEndpointUrl="https://${oidc.hostname}:${oidc.port}/oidc/endpoint/OP/token" >

</openidConnectClient>

The server-relying-party.xml takes the information that is provided in the bootstrap.propertiesfile in the previous step.

4. Register Cloud Application Business Insights as a client in your OIDC server as follows:Locate the server.xml file in your OIDC server.For example, if you are using OIDC from Cloud APM, it is located in /opt/ibm/wlp/usr/servers/oidcpath.

Note: Registering the OIDC client depends on how OIDC server is configured. If you are usingWebSphere Application Server Liberty that is provided with localstore, use following information asan example and add it under the <localStore> tag.In the following section, update the following parameters:<localStore>



<client name="${oidc.client1.name}"preAuthorizedScope="openid"secret="${oidc.client1.secret}"scope="${oidc.client1.scope}"redirect="https://${oidc.client1.hostname}:${oidc.client1.port}/

oidcclient/redirect/${oidc.client1.id},https://${oidc.client1.ip}:${oidc.client1.port}/oidcclient/redirect/${oidc.client1.id}" />

</localStore>

Where:

${oidc.client1.name}A unique name for client.


${oidc.client1.secret}A secret password for this client. The same password must be used in Cloud Application BusinessInsights oidc.rp.clientSecret configuration property.

${odic.client1.scope}OIDC scope like openid.

${oidc.client1.hostname}The hostname of Cloud Application Business Insights server.

${oidc.client1.port}The port number of the Cloud Application Business Insights server.

${oidc.client1.id}Cloud Application Business Insights ID, which is RP.

${oidc.client1.ip}The IP address of the server on which Cloud Application Business Insights is running.

5. Add the signer certificate for the OIDC server to the Cloud Application Business Insights server as atrusted certificate.a. Export the personal certificate from the OIDC server keystore by using these commands: Go to the

keystore file location. In Cloud APM, use the following example:cd /opt/ibm/wlp/usr/shared/resources/security/keytool -exportcert -keystore <keystore_filename> -storepass<keystore_password> -alias <certificate_alias_name> -file <output_certificate_name>

Where:

<keystore_filename>Name of the keystore file.

<keystore_password>Password for the keystore.

<certificate_alias_name>Alias name for the certificate.

<output_certificate_name>The name of the certificate that is produced. For example, APMOIDC.cer for Cloud APM OIDC.

b. Import the signer certificate from the OIDC server to the Cloud Application Business Insightsserver keystore by using the following commands: Copy the <output_certificate_name> file to/opt/icabi/wlp/usr/servers/icabi/resources/security path:keytool -importcert -keystore key.jks -storepass <ICABI_keystore_password>-alias <certificate_alias_name> -file <output_certificate_name>.cer -noprompt

Where:

<certificate_alias_name>Unique name of the alias name for the certificate.

<ICABI_keystore_password>It is persistent123.

Note: It is recommended that you modify the default password of this keystore. SeeConfiguring the keystore password section in Administering IBM Cloud Application Business Insights.

<output_certificate_name>The name of certificate that is generated in the previous step.

6. Add the signer certificate of Cloud Application Business Insights server to the OIDC provider serveras a trusted certificate.


a. Export the certificate from the Cloud Application Business Insights server keystore by using thefollowing commands:cd /opt/icabi/wlp/usr/servers/icabi/resources/securitykeytool -exportcert -keystore key.jks -storepass <ICABI_keystore_password>-alias default -file <ICABI_cert_name>.cer

Note: The default <ICABI_keystore_password> is persistent123. It is recommended that youmodify the default password of this keystore. See Configuring the keystore password section inAdministering IBM Cloud Application Business Insights.

b. Import the generated certificate into the third party OIDC that is by using the followingcommand:keytool -importcert -keystore <trust_store_filename> -storepass<password> -alias <ICABI_cert_alias> -file <ICABI_cert_name>.cer -noprompt

Where:

<trust_store_filename>The name of the trust store file.

<password>Password for the trust store.

<ICABI_cert_alias>A unique name of certificate inside the keystore. For example, icabi.

<ICABI_cert_name>The name of certificate generated in the previous step.

7. Restart the Cloud Application Business Insights server.For more information, see the Restarting the Cloud Application Business Insights server topic inAdministering IBM Cloud Application Business Insights.

8. Restart the OIDC server. If you are using Cloud APM as your OIDC server, use the followingcommand to restart:apm restart oidc

Configuring LDAP registriesYou can configure one or more Lightweight Directory Access Protocol (LDAP) servers with Liberty forauthentication. Import or add users in configured LDAP in Cloud Application Business Insights to get theauthorization and access to Dashboard Designer or Engine.

Before you begin

Ensure that your LDAP server is up and running, and that the host name and port number of the LDAPserver are noted.

About this task

You can configure different LDAP servers for user authentication. For example:v Microsoft Active Directory Serverv OpenLDAP

Procedure1. Create ldap-registry.xml file and place it in the same path as your server.xml file.2. Update the server.xml file in Cloud Application Business Insights server as follows:

a. Open the server.xml for editing as follows:cd /opt/icabi/wlp/servers/icabiapvi server.xml


You can see the following lines at the end of the file:

b. Add the following line to use the LDAP registry:<include optional="true" location="ldap-registry.xml"/>

Note: If you saved the ldap-registry.xml file in a non-default location, specify the absolute pathfor the file.

3. Update the /opt/icabi/wlp/servers/icabiap/ldap-registry.xml file based on your LDAP server:The configuration settings change based on the LDAP authentication server that you are using.v Microsoft Active Director

<ldapRegistryid="basic" realm="admin"host="myserver.ibm.com"port="389"ignoreCase="true"baseDN="DC=myserver,DC=com"ldapType="Microsoft Active Directory"searchTimeout="1m"connectTimeout="2m"reuseConnection="true"recursiveSearch="true"bindDN="CN=Administrator,CN=Users,DC=myserver,DC=com"bindPassword="XXXXXXX"><activedFilters

userFilter="(&(sAMAccountName=%v)(objectcategory=user))"groupFilter="(&(cn=%v)(objectcategory=group))"userIdMap="user:sAMAccountName"groupIdMap="*:cn"groupMemberIdMap="memberOf:member" >

</activedFilters><ldapEntityType name="Group">

<objectClass>user</objectClass></ldapEntityType></ldapRegistry>

v Open LDAP<ldapRegistry

id="basic"realm="admin"host="<IP_Address>"port="389"ignoreCase="true"baseDN="dc=example,dc=com"ldapType="Custom"searchTimeout="1m"connectTimeout="2m"reuseConnection="true"recursiveSearch="true"bindDN="cn=Manager,dc=example,dc=com"bindPassword="XXXXXXX"><customFilters

userFilter="(&(uid=%v)(objectClass=account))"groupFilter="(&(cn=%v)(objectClass=posixGroup))"userIdMap="*:uid"groupIdMap="*:cn"groupMemberIdMap="groupOfUniqueNames:uniquemember" >

</customFilters><ldapEntityType name="PersonAccount"><objectClass>account</objectClass></ldapEntityType>

</ldapRegistry>

4. Save the ldap-registry.xml file.


Related information:

Configuring LDAP user registries in Liberty

IBM License Metric Tool complianceIBM License Metric Tool, also known as BigFix® Inventory tool, helps you to manage software inventoryand license consumption on supported systems. In general, it recognizes and monitors the products thatare installed and in use on your system. It helps to assess your compliance with licensing requirements.

In the Cloud Application Business Insights installation directory, the License Metric Tool scans thefollowing files at a preconfigured interval:v swidtag file is used to identify the version of IBM Cloud Application Business Insights that is installed

on your computer. By default, the file is available at the following location:/opt/icabi/swidtag.

v icabi_users.slmtag.xml file is used to obtain the number of users that access Cloud ApplicationBusiness Insights daily. By default, the file is available at the following location:/opt/icabi/wlp/usr/servers/icabi/derby/scripts.

Related information:

IBM License Metric Tool

Verifying the installationVerify that the installation is successful.

Procedure1. Check the status of Cloud Application Business Insights server with this command:

lsof -i :1529 -t

You can see the PIDs for both Derby process, NiFi Connector, and the Cloud Application BusinessInsights server.

2. Check the status of Cloud Application Business Insights server application alone with this command:lsof -i :<port_number> -t

Where, <port_number> is either the default port number, which is 443 or the configured port numberfor Cloud Application Business Insights server application.You can see the PID for Cloud Application Business Insights server.

3. Check the status of Cloud Application Business Insights OIDC server with this command:lsof -i :<port_number> -t

Where, <port_number> is either the default port number, which is 9443 or the configured port numberfor Cloud Application Business Insights server OIDC server.You can see the PID for Cloud Application Business Insights server.

4. Check the status of Connector services with this command:lsof -i :8050 -tlsof -i :8051 -t

Installation directory structureUse this information to understand the default folders that are created after the installation.

These directories are created in /opt/icabi/ if you installed Cloud Application Business Insights in thedefault path:


https://www.ibm.com/support/knowledgecenter/was_beta_liberty/com.ibm.websphere.wlp.nd.multiplatform.doc/ae/twlp_sec_ldap.html

https://www-01.ibm.com/support/knowledgecenter/SS8JFY_9.2.0/com.ibm.lmt.doc_9.2/com.ibm.license.mgmt.doc/ic-homepage_lmt.html?lang=en&view=kc

connectorFolder contains all the files and folders for Apache NiFi-based connectors. Copy all the JDBCdriver JAR files in the /jdbcdrivers folder. The following bundled software is available in thesub folders here:v Apache NiFiv IBM Javav Apache Directory Server

ibm-java-x86_64-80Folder that contains IBM Java that is bundled with the application.

LicenseFolder that contains the multilingual license files for IBM Cloud™ Application Business Insights.You can find separate license files for Base Private and Advanced Private offerings.

prddb Folder that contains database files that contain the information about the dashboards that arecreated.

wlp Folder that contains all the files that are related to WebSphere Application Server Liberty that isbundled with the application.

The Derby database directory can be found in the following location:install_dir/wlp/usr/servers/icabi/derby

backup.shData backup in Cloud Application Business Insights is done by using the backup.sh script.

changeApplicationsPort.shThe script to change the port numbers of the application.

derby.logContains the messages that indicate the health of the Derby database.

icabi_configIt is required for configuring the new port numbers of the application and for custom OIDC.

showVersion.shRun this script to see the version of the Cloud Application Business Insights application.

restore.shThe backup contents are restored in Cloud Application Business Insights by using the restore.shscript.

start_icabi.shRun this script to start Cloud Application Business Insights server, Cloud Application BusinessInsights OIDC server, and Derby database.

stop_icabi.shRun this script to stop Cloud Application Business Insights server, Cloud Application BusinessInsights OIDC server, and Derby database.

version.txtContains details about the current version of Cloud Application Business Insights.

Accessing the IBM Cloud Application Business Insights web interfaceAfter the installation is complete, access the Dashboard Designer web interface to check that theinstallation is successful.

About this task

Use this information to start Dashboard Designer tool and Engine.


Procedure

Logging in to the Dashboard Designer tool.v Access the Dashboard Designer tool to create your custom dashboards from the following URL:

https://<IP_address>/dashboardTool/html/dashboard.jsp

Orhttps://<IP_address>:<port_number>/dashboardTool/html/dashboard.jsp

Where:– <IP_address>

<IP_address> is the IP address of the server where Cloud Application Business Insights is deployed.The default user name and password are smadmin/smadmin.

Note: You can also use the fully qualified domain name (FQDN) of the server. For example,myserver.ibm.com.

– <port_number>

<port_number> is the configured port number for the Cloud Application Business Insightsapplication.For more information about changing the default port number for Cloud Application BusinessInsights, see Changing default port numbers in Installing IBM Cloud Application Business Insights.

Welcome to ICABI page opens.v In the Log In area, enter your user name and password, and then click Log In. Dashboard Designer

page opens.The page displays your user name at the upper-right corner along with a twistie. Expand the twistie toview your user role, role description, Tool Content Groups, Engine User Groups, and Engine Instancesthat are assigned to you.The page also displays the following options that help you get started:1. To start creating your custom dashboards, click CREATE DASHBOARDS.

The Create a New Dashboard: Select a Layout window is displayed. You can either select any oneof the available layouts or click Create a New Layout.The Dashboard Designer page is displayed. The page displays a navigation pane listing all thecomponents that are needed to create and publish a dashboard.For more information about the Dashboard components, see Managing and using Dashboard Designerin Using IBM Cloud Application Business Insights.

2. To start creating components that can be reused to create dashboards, click CREATECOMPONENTS.The Create Components page opens that displays the following components:– LAYOUTS

– WIDGETS

– DATA DEFINITION

– FILTERS

Click any component that you want to create, the Dashboard Designer page displays a navigationpane and lists all the components that are needed to create and publish a dashboard.

3. To start using the Dashboard Designer tool directly, click the Expand icon on the upper-leftcorner of the page.The page displays a navigation pane listing all the components that are needed to create andpublish a dashboard.


Logging in to the Engine web interface.v Access the Engine from the following URL:

https://<IP_address>/prdAngular/jsp/index.jsp

Orhttps://IP_address:<port_number>/prdAngular/jsp/index.jsp

Where:– <IP_address>

<IP_address> is the IP address of the server where Cloud Application Business Insights is deployed.The default user name and password are smadmin/smadmin.

Note: You can also use the fully qualified domain name (FQDN) of the server. For example,myserver.ibm.com.

– <port_number>

<port_number> is the configured port number for the Cloud Application Business Insightsapplication.For more information about changing the default port number for Cloud Application BusinessInsights, see Changing default port numbers in Installing IBM Cloud Application Business Insights.

The Engine page opens. The page displays the Settings icon. You can configure the Dashboardand Dashboard export settings from here.For more information about these settings, see Configuring user preferences topic in Using IBM CloudApplication Business Insights.After you publish the dashboards to Engine web interface, you can see the menu that you created as aseparate tab.

Related tasks:“Encrypting passwords” on page 12After you install Cloud Application Business Insights, you must run the AES_Encryptor.sh script to setand encrypt password for the default user, smadmin. For security reasons, you must also encryptpasswords of all the users that you create to access Dashboard Designer, Engine, and databases.

Uninstalling Cloud Application Business InsightsWhen you run the uninstall script, both Cloud Application Business Insights application and CloudApplication Business Insights WebSphere Liberty Profile are uninstalled.

Before you begin

If you need to back up your database before you uninstall, see Database administration in AdministeringIBM Cloud Application Business Insights.

Procedure1. Stop Cloud Application Business Insights server, Cloud Application Business Insights OIDC server,

and Derby database, if they are already running by using the following commands:cd $install_dir./stop_icabi.sh

You can see the following output:

Stopping server icabi.Server icabi stopped.Stopping server icabiap.Server icabiap stopped.


2. On the command line, go to DIST_DIR directory.DIST_DIR is the directory where the software is downloaded and extracted.

3. To uninstall the Cloud Application Business Insights, run the following command:./uninstall

Typically, the icabi and all its subdirectories are removed if installation directory is the default. Thatis, /opt/icabi.

Note: If you installed Cloud Application Business Insights in a non-default location, run thecommand as follows:./uninstall <custom_install_dir>

4. Run the following command to check if Cloud Application Business Insights and Derby processes arerunning:lsof -i:1529 -t

5. Kill the processes if they are running.6. Run the following command to check if any Connector processes are running:

lsof -i:8050 -tlsof -i:8051 -t

7. Kill the processes if they are running.8. Optional: Manually, remove all the subdirectories in the install_dir by using the following command:

This step is required after killing the processes that are found to be running in Step 4 through Step 7.rm -rf *

9. Optional: Manually, remove the install_dir by using the following command:rmdir install_dir

Results

Default uninstallation output:

./uninstall /opt/icabi/[INFO] Verifying build is installed on the /opt/icabi path[INFO] build is available at /opt/icabi path, starting uninstallation..**********Uninstalling Connector***************** Stopping Connector Server ********Java home: /opt/icabi/connector/ibm-java-1.8.0_161NiFi home: /opt/icabi/connector/nifi-1.7.0Bootstrap Config File: /opt/icabi/connector/nifi-1.7.0/conf/bootstrap.conf2018-10-29 21:39:41,821 INFO [main] org.apache.nifi.bootstrap.CommandApache NiFi has accepted the Shutdown Command and is shutting down now2018-10-29 21:39:41,823 INFO [main] org.apache.nifi.bootstrap.Command Waitingfor Apache NiFi to finish shutting down...2018-10-29 21:39:41,825 INFO [main] org.apache.nifi.bootstrap.Command NiFi has finished shutting down.Using ADS_HOME: /opt/icabi/connector/apacheds-2.0.0-M24Using JAVA_HOME: /opt/icabi//connector/ibm-java-1.8.0_161Stopping ApacheDS instance ’default’ running as 12862ApacheDS stopping 12862: 0, 60 attempts remainingApacheDS instance ’default’ stopped successfullyPreparing packages...prdconnector-1.1.0.0-<build_number>.x86_64Uninstallation of Connector completed successfully.**********Uninstalling ICABI UI********Preparing packages...Uninstalling ibm_icabi..ibm_icabi-<build_number>.x86_64ibm_icabi uninstalled successfully.Preparing packages...Uninstalling ibm_icabi_WLP..ibm_icabi_WLP_installer-<build_number>.x86_64ibm_icabi_WLP uninstalled successfully.



Notices

This information was developed for products and services offered in the US. This material might beavailable from IBM in other languages. However, you may be required to own a copy of the product orproduct version in that language in order to access it.

IBM may not offer the products, services, or features discussed in this document in other countries.Consult your local IBM representative for information on the products and services currently available inyour area. Any reference to an IBM product, program, or service is not intended to state or imply thatonly that IBM product, program, or service may be used. Any functionally equivalent product, program,or service that does not infringe any IBM intellectual property right may be used instead. However, it isthe user's responsibility to evaluate and verify the operation of any non-IBM product, program, orservice.

IBM may have patents or pending patent applications covering subject matter described in thisdocument. The furnishing of this document does not grant you any license to these patents. You can sendlicense inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785US

For license inquiries regarding double-byte character set (DBCS) information, contact the IBM IntellectualProperty Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodicallymade to the information herein; these changes will be incorporated in new editions of the publication.IBM may make improvements and/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM websites are provided for convenience only and do not inany manner serve as an endorsement of those websites. The materials at those websites are not part ofthe materials for this IBM product and use of those websites is at your own risk.

IBM may use or distribute any of the information you provide in any way it believes appropriate withoutincurring any obligation to you.


Licensees of this program who wish to have information about it for the purpose of enabling: (i) theexchange of information between independently created programs and other programs (including thisone) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785US

Such information may be available, subject to appropriate terms and conditions, including in some cases,payment of a fee.

The licensed program described in this document and all licensed material available for it are providedby IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement orany equivalent agreement between us.

The performance data discussed herein is presented as derived under specific operating conditions.Actual results may vary.

Information concerning non-IBM products was obtained from the suppliers of those products, theirpublished announcements or other publicly available sources. IBM has not tested those products andcannot confirm the accuracy of performance, compatibility or any other claims related tonon-IBMproducts. Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

Statements regarding IBM's future direction or intent are subject to change or withdrawal without notice,and represent goals and objectives only.

This information is for planning purposes only. The information herein is subject to change before theproducts described become available.

This information contains examples of data and reports used in daily business operations. To illustratethem as completely as possible, the examples include the names of individuals, companies, brands, andproducts. All of these names are fictitious and any similarity to actual people or business enterprises isentirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programmingtechniques on various operating platforms. You may copy, modify, and distribute these sample programsin any form without payment to IBM, for the purposes of developing, using, marketing or distributingapplication programs conforming to the application programming interface for the operating platform forwhich the sample programs are written. These examples have not been thoroughly tested under allconditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of theseprograms. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative workmust include a copyrightnotice as follows:© (your company name) (year).Portions of this code are derived from IBM Corp. Sample Programs.© Copyright IBM Corp. 2005, 2016.


TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International BusinessMachines Corp., registered in many jurisdictions worldwide. Other product and service names might betrademarks of IBM or other companies. A current list of IBM trademarks is available on the web at"Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.

Linux is a trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in theUnited States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/orits affiliates.

Terms and conditions for product documentationPermissions for the use of these publications are granted subject to the following terms and conditions.

Applicability

These terms and conditions are in addition to any terms of use for the IBM website.

Personal use

You may reproduce these publications for your personal, noncommercial use provided that allproprietary notices are preserved. You may not distribute, display or make derivative work of thesepublications, or any portion thereof, without the express consent of IBM.

Commercial use

You may reproduce, distribute and display these publications solely within your enterprise provided thatall proprietary notices are preserved. You may not make derivative works of these publications, orreproduce, distribute or display these publications or any portion thereof outside your enterprise, withoutthe express consent of IBM.

Rights

Except as expressly granted in this permission, no other permissions, licenses or rights are granted, eitherexpress or implied, to the publications or any information, data, software or other intellectual propertycontained therein.

IBM reserves the right to withdraw the permissions granted herein whenever, in its discretion, the use ofthe publications is detrimental to its interest or, as determined by IBM, the above instructions are notbeing properly followed.

Notices 27

http://www.ibm.com/legal/us/en/copytrade.shtml

You may not download, export or re-export this information except in full compliance with all applicablelaws and regulations, including all United States export laws and regulations.

IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE PUBLICATIONS. THEPUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OFMERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.

IBM Online Privacy StatementIBM Software products, including software as a service solutions, (“Software Offerings”) may use cookiesor other technologies to collect product usage information, to help improve the end user experience, totailor interactions with the end user or for other purposes. In many cases no personally identifiableinformation is collected by the Software Offerings. Some of our Software Offerings can help enable you tocollect personally identifiable information. If this Software Offering uses cookies to collect personallyidentifiable information, specific information about this offering's use of cookies is set forth in thefollowing paragraphs.

Depending upon the configurations deployed, this Software Offering may use session cookies that collecteach user's user name for purposes of session management, authentication, and single sign-onconfiguration. These cookies can be disabled, but disabling them will also likely eliminate thefunctionality they enable.

If the configurations deployed for this Software Offering provide you as customer the ability to collectpersonally identifiable information from end users via cookies and other technologies, you should seekyour own legal advice about any laws applicable to such data collection, including any requirements fornotice and consent.

For more information about the use of various technologies, including cookies, for these purposes, SeeIBM's Privacy Policy at http://www.ibm.com/privacy and IBM's Online Privacy Statement athttp://www.ibm.com/privacy/details the section entitled “Cookies, Web Beacons and OtherTechnologies” and the “IBM Software Products and Software-as-a-Service Privacy Statement” athttp://www.ibm.com/software/info/product-privacy.


http://www.ibm.com/privacy

http://www.ibm.com/privacy/details

http://www.ibm.com/software/info/product-privacy

Notices 29

IBM®

Printed in USA

GC27-8792-01

Date post:	23-May-2020
Category:	Documents
Upload:	others
View:	6 times
Download:	0 times

Installing Cloud Application Business Insights · Installing Cloud Application Business Insights...

Documents