Step - by - step guide on how to Install Insights Advanced Features - Audit related features

Prerequisite

Environment variable INSIGHTS_HOME and server-config.json.
- Windows: Server 2 - SetEnvVariables.bat
- Linux: insights_first.sh
Java
Apache-Tomcat

Refer here for installation steps if required.

Assumption:

FABRIC_HOME will be used to refer to the directory where all the network related files are extracted

Step1: Configuration

Create the file blockchainConfig.json in $INSIGHTS_HOME/.InSights/ and make the necessary changes.

Sample: blockchainConfig.json

"cogdevops" is a sample domain name used in the configuration which has to be replaced with the actual domain name
The CA, peer, and user should be from the same org
The Eventhub is not available as a separate container but obtained by using the peer instance and so it can use the peer url
The user private key (ends with "_sk") can be found in FABRIC_HOME/ledger/ca/msp/keystore
The public key (pem) can be found in FABRIC_HOME/ledger/ca/msp/signcerts
Copy the user private key (ends with "_sk") and public key (pem) into any suitable directory and provide their path

SFTP should be used to move the private key and public key files between different machines as FTP corrupts them.
Reference: click here
The USER_SER_PATH is a path for storing the serialized format of the user context which is generated from the user private key (ends with "_sk") and public key (pem)
If TLS_ENABLED is false, then the values for the corresponding TLS files USER_CA_TLSCERT, PEER_ORG_TLSPEM, PEER_CLIENT_TLSCERT, PEER_CLIENT_TLSKEY, and ORDERER_TLS_PEM can be empty ("N/A").
All TLS files can be located in the corresponding path as specified in the sample blockchainConfig.json
Place the datamodel.json and Process.json files in any directory suitable and provide the path in blockchainConfig.json

Sample	Explanation
datamodel.json	datamodelDescription
Process.json	ProcessDescription

Step2: Run PlatformAuditEngine

Set flag as true for AuditEngine in "server-config.json" as mentioned below:

{

"enableAuditEngine" : true

}

Give latest release version in <version> in the following download URL and download the PlatformAuditEngine jar from https://infra.cogdevops.com/repository/InsightsEnterpriseRelease/com/cognizant/devops/PlatformAuditEngine/<version>/PlatformAuditEngine<version>.jar Example: https://infra.cogdevops.com/repository/InsightsEnterpriseRelease/com/cognizant/devops/PlatformAuditEngine/6.1/PlatformAuditEngine-6.1.jar

(The above link is nexus enterprise repository which is restricted with user credentials. Use authorized credentials or contact DevOpsPlatformSupport@cognizant.com )

Run the downloaded jar using the command:

java -jar PlatformEngine-<version>.jar

Example: java -jar PlatformEngine-6.1.jar

If you want to run the jar as a background service instead, use the below command:

nohup java -jar PlatformEngine-<version>.jar &

Example: nohup java -jar PlatformEngine-6.1.jar &

To specify the interval at which data is read from neo4j, the time interval in seconds can be specified as arguments. First argument is to read data from all tools except ALM and second argument is to read data from ALM.

Example: nohup java -jar PlatformEngine-<version>.jar & 400 350

The logs will be available at $INSIGHTS_HOME/logs/PlatformEngine

Note

The server running PlatformAuditEngine must have the blockchainConfig.json file with the dependency files (datamodel.json, Process.json, private and public keys) in appropriate locations

Step3: Run PlatformAuditService

git clone -b InsightsAuditingService https://github.com/TheCognizantFoundry/Insights.git
Give latest release version in <version> in the following download URL and download the PlatformService war from https://infra.cogdevops.com/repository/InsightsEnterpriseRelease/com/cognizant/devops /PlatformService/<version>/PlatformService-<version>.war

Example: https://infra.cogdevops.com/repository/InsightsEnterpriseRelease/com/cognizant/devops /PlatformService/6.1/PlatformService-6.1.war

(The above link is nexus enterprise repository which is restricted with user credentials. Use authorized credentials or contact DevOpsPlatformSupport@cognizant.com )

PlatformService Enterprise has PlatformAuditService bundled inside the PlarformService war

Create a folder named Audit-report under $INSIGHTS_HOME/.Insights/ and provide write privilege. This is required for placing the uploaded files.
Provide the Mail server configuration in server-config.json file present in $INSIGHTS_HOME/.InSights/ as below.
"emailConfiguration":
{
"smtpHostServer": "",
"smtpPort": "",
"smtpUserName": "",
"smtpPassword": "",
"mailFrom": ""
}
Make sure Reports folder is generated by default in ${INSIGHTS_HOME}/logs/PlatformAuditService/ . If not create a folder named Reports under PlatformAuditService and provide write access to collect log for each report
Copy folders keystore, sign and static available from Insights/PlatformAuditService/src/main/resources/ (cloned in the first step) into $INSIGHTS_HOME/.InSights/Pdf/
Move the PlatformService war into webapps directory of apache-tomcat and restart tomcat
- Use the following commands inside the apache-tomcat directory to restart
- ./bin/shutdown.sh
- ./bin/startup.sh

Note

The server running Apache Tomcat must have the blockchainConfig.json file with the dependency files (datamodel.json, Process.json, private and public keys) in appropriate locations

Browser not supported