Server Configuration (server-config.json)

"endpointData": {
"elasticSearchEndpoint": "http://localhost:9200"
}

• endpointData - It has the configuration for Elaticsearch database.

  • elasticSearchEndpoint - It is the server path, where Elasticsearch database is hosted.

"graph":{
"endpoint":"http://localhost:7474",
"authToken":"",
"boltEndPoint":"bolt://localhost:7687",
"maxIdleConnections":25
}

• graph - This section refers to Neo4j database configurations.

  • endpoint - It is the server/hostname where Neo4j is hosted.

  • authToken - It is token for Neo4j authentication.

  • boltEndPoint - Its Neo4j boltEndPoint

  • maxIdleConnections - Maximum connection use for Neo4j (use only with java Neo4j driver)

"grafana": {
"grafanaEndpoint": "http://localhost:3000",
"grafanaDBEndpoint": "jdbc:postgresql://localhost:5432/grafana",
"adminUserName": "admin",
"adminUserPassword": "admin",
"dbUserName": "user",
"dbPassword": "password"
}

• grafana - It contains the details of Grafana.

  • grafanaEndpoint - It is the web server location where Grafana is hosted.

  • grafanaDBEndpoint - It's the configuration to connect PostgreSQL database.

  • adminUserName - It is the username of admin for Grafana.

  • adminUserPassword - It is the corresponding password for the username of admin for Grafana.

  • dbUserName - It is the username to log intoPostgreSQL.

  • dbUserName - It is the corresponding password for the username to log into PostgreSQL.

"postgre": {
"userName" : "user",
"password" : "password",
"insightsDBUrl": "jdbc:postgresql://127.0.0.1:5432/insight",
"grafanaDBUrl": "jdbc:postgresql://127.0.0.1:5432/grafana"
}

• postgre - This module has the configurations for PostgreSQL

  • userName - It is the username to log into PostgreSQL

  • password - It is the corresponding password for the username to log into PostgreSQL.

  • insightsDBUrl - It is the JDBC connectivity URL of Insights data storage index, which stores information related to Insights Application.

  • grafanaDBUrl - It is the JDBC connectivity URL of Grafana data storage index, which stores information related to Grafana.

"messageQueue": {
"host": "localhost",
"port": 5672,
"user": "",
"password": "",
"prefetchCount": 5,
"enableDeadLetterExchange":false

}

• messageQueue - These are the configurations related to RabbitMQ server.

  • host - It is the host location at which RabbitMQ is running.

  • user - It is username to log into RabbitMQ application.

  • port - port of RabbitMQ application, If not defined then application connect to default port 5672

  • password - It is the corresponding password for the username to log into RabbitMQ application.

  • prefetchCount - It is to control the number of files consumed by the Insights Engine.The value should be calculated based on number of messages and system configuration.

  • enableDeadLetterExchange - If true then this will enable DeadLetterExchange for RabbitMq, make sure that it enabled in Agent Daemon also

"agentDetails": {

"isOnlineRegistration":true,
"onlineRegistrationMode":"nexus",
"browseRepoUrl":"",
"downloadRepoUrl":"”,
"nexusUserName":"",
"nexusPassword":"",
"docrootUrl":"https://platform.cogdevops.com//insights_install/release",
"offlineAgentPath":"D:\Project\Insights\InSights_Windows\Agents\offlineAgent",
"unzipPath":"D:\Project\Insights\InSights_Windows\Agents\PlatformAgents\unzip",
"agentExchange":"iAgent",
"agentPkgQueue":"INSIGHTS.AGENTS.PACKAGE"

}

• agentDetails - These are the configurations needed to setup agents in Insights Application.

  • isOnlineRegistration : This property is used to decide mode of agent registration online or offline

  • onlineRegistrationMode : It is server from where you are downloading Agent package nexus or docroot, After 7.0 we migrated all package on nexus.

  • browseRepoUrl - use browse agent package in online mode

  • downloadRepoUrl - use to download agent package in online mode

  • docrootUrl - It is the location from which agent would be downloaded in a zip file.

  • unzipPath - It is the local system path where the downloaded zip file would be extracted.

  • agentExchange - It is the channel where agent related data exchanges will take place.

  • agentPkgQueue - It is the queue name where all the various agents will be queued. This is use by daemon agent for connnection

"queryCache": 
{
     "esCacheIndex": "neo4j-cached-results-custom"
}

• queryCache - This configuration helps us to set custom Neo4j data source's query caching index in Elasticsearch.
  esCacheIndex - It is the custom index of Elaticsearch where cache results will be stored.

• For more detail check https://onedevops.atlassian.net/wiki/spaces/OI/pages/456097795

"insightsServiceURL": "https://localhost:8080"

• insightsServiceURL - It is the web server host and port where "PlatformService.war" file is deployed and run.

"insightsTimeZone": "US/Central"

• insightsTimeZone - It is the local timezone of the country/place.

"enableOnlineDatatagging": true

• enableOnlineDatatagging - This property is required to enable/disable Business Mapping on data.

"enableOnlineBackup": true

• enableOnlineBackup - This property is required to enable the backup when the Engine is running.

"autheticationProtocol":"NativeGrafana"

• autheticationProtocol- This property is used to set particular authentication protocol . For Native Grafana use "NativeGrafana", For SAML use "SAML"

"emailConfiguration": {
"sendEmailEnabled": false,
"smtpHostServer": "",
"smtpPort": "",
"smtpUserName": "",
"smtpPassword": "",
"isAuthRequired": true,
"smtpStarttlsEnable": true,
"mailFrom": "onedevops@cogdevops.com",
"mailTo": "",
"subject": "Health Status - {TimeOfReportGeneration}",
"emailBody": "Hi Team, Attaching the report File",
"systemNotificationSubscriber": ""
}

This section use to configure Email

• sendEmailEnabled : if true then Email functionality enabled

• smtpHostServer : SMTP server Host

• smtpPort : SMTP server port

• smtpUserName : SMTP username Detail

• smtpPassword : SMTP username

• isAuthRequired : if true then SMTP authentication enable

• smtpStarttlsEnable : SMTP ttl enable

• mailFrom : Mail from email id

• mailTo : No need to configure, configure it from UI like Report Management

• emailBody : This is aonly use for Health check Naotification page

• systemNotificationSubscriber : Only use for Health check Notification messages

"singleSignOnConfig": {
"entityId": "",
"appId": "",
"metadataUrl": "",
"metdataFilePath": "",
"keyStoreFilePath": "C:\InSights_Windows\Server2\INSIGHTS_HOME\.InSights\saml-keystore.jks",
"keyAlias": "",
"keyPass": "",
"keyStorePass": "",
"appBaseUrl": "baseURL",
"relayStateUrl": "relayStateUrl",
"defaultTargetUrl": "defaultTargetUrl",
"postLogoutURL": "logoutURL",
"tokenSigningKey": "insights_IDP_CogDevops_SSO_Token_string",
"servicePrincipalKerberos": "",
"keyTabLocationKerberos": "C:\InSights_Windows\Server2\INSIGHTS_HOME\.InSights\kerberos_keytab_file.keytab"
}

• entityId: Identifier (Entity ID) for your SMAL configuration

• appId:copy app id from App Federation Metadata Url

• metadataUrl:App Federation Metadata Url

• metdataFilePath :Download SAML Signing Certificate from sso provider site and store it in INSIGHTS_HOME

• keyStoreFilePath:path of certificae like saml-keystore.jks, Download this certificate from your sso provider URL

• keyAlias :saml-keystore.jks username

• keyPass :saml-keystore.jks password

• keyStorePass :saml-keystore.jks password

• appBaseUrl :Application service Host URL, Example <https://<HostOrDomainName>/PlatformService>

• relayStateUrl :SSO login UI page URL, Example <https://<HostOrDomainName>/app/#/ssologin>

• defaultTargetUrl :Application user authenticate url, Example <https://<HostOrDomainName>/user/authenticate>

• postLogoutURL :SAML or SSO provider logout URL, Example value

• tokenSigningKey :This is use as secrete key to sign JWT token,It should be 128 character ,Example value:"insights_IDP_CogDevops_SSO_Token_string"

• servicePrincipalKerberos: Use during Kerberos Authentication protocol for service Principal Kerberos

• keyTabLocationKerberos: Use during Kerberos Authentication protocol for Keytab location

"assessmentReport": {
"outputDatasource": "NEO4J",
"maxWorkflowRetries": 3,
"fusionExportAPIUrl": "http://localhost:1337/api/v2.0/export"
}

This functionality user for Reporting feature

• outputDatasource : Datasouce for KPI query execution

• maxWorkflowRetries : No of retires for Report execution if not executed correctly

• fusionExportAPIUrl : User for Fusion Report

"proxyConfiguration":{
"isEnableProxy":false,
"proxyHost":"",
"proxyPort":0,
"proxyUsername":"",
"proxyPassword":""

}

This block help user to add proxy information, proxy information is mainly use in online agent registration/update

isEnableProxy : if true then it denote that Insights Application use proxy

proxyHost : Proxy host information

proxyPort : Proxy port information

proxyUsername : Proxy user information if needed, If no user information required then keep this filed blank

proxyPassword : Proxy user password if needed, If no password required then keep this filed blank