Versions Compared

Version Old Version 53 New Version 54
Changes made by

Gaurav

Gaurav

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top81
top81

...

Expand
titleSample Server Config Json file
Info

server-config.json file is present at "%INSIGHTS_HOME%"\.InSights environment variable path location.

Sample Server Config Json file

Code Block
languagejson
{
    "vault":{
    	"isVaultEnable":false,
        "vaultEndPoint":"http://localhost:3000/v1/",
        "secretEngine":"",
        "vaultToken":""
    },
	"grafana":{
        "grafanaEndpoint":"http://localhost:3000",
        "grafanaDBEndpoint":"jdbc:postgresql://localhost:5432/grafana",
        "adminUserName":"",
        "adminUserPassword":""
    },
	"trustedHosts":[
        "localhost"
    ],
    "graph":{
        "endpoint":"http://localhost:7474",
        "authToken":"",
        "boltEndPoint":"bolt://localhost:7687",
        "maxIdleConnections":25
    },
    "postgre":{
        "userName":"",
        "password":"",
        "insightsDBUrl":"jdbc:postgresql://localhost:5432/insight",
        "grafanaDBUrl":"jdbc:postgresql://localhost:5432/grafana"
    },
    "messageQueue":{
        "host":"localhost",
        "user":"",
        "password":"",
        "prefetchCount":5
    },
    "agentDetails":{
        "isOnlineRegistration":true,
        "onlineRegistrationMode":"nexus",
        "browseRepoUrl":"https://infra.cogdevops.com:8443/service/rest/repository/browse/docroot/insights_install/release",
        "downloadRepoUrl":"https://infra.cogdevops.com:8443/repository/docroot/insights_install/release",
        "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"
    },

    "endpointData":{
        "elasticSearchEndpoint":"http://localhost:9200"
    },
    "queryCache":{
        "esCacheIndex":"neo4j-cached-results/querycacheresult"
    },
   "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": ""
	},
    "correlations":{
        "correlationWindow":48,
        "correlationFrequency":3,
        "batchSize":2000
    },
    "schedulerConfigInMin":{
        "auditEngineInterval":60,
        "webhookEngineInterval":10,
        "engineAggregatorModuleInterval":10,
        "engineCorrelatorModuleInterval":60,
        "projectMapperModuleInterval":10,
        "dataPurgingExecutorInterval":300,
        "offlineDataProcessingExecutorInterval":10,
        "inferenceJobExecutor":20,
        "dataArchivalEngineInterval":240
    },
    "singleSignOnConfig":{
        "entityId":"",
        "appId":"",
        "metadataUrl":"",
        "metdataFilePath":"",
        "keyStoreFilePath":"C:\\InSights_Windows\\Server2\\INSIGHTS_HOME\\.InSights\\saml-keystore.jks",
        "keyAlias":"mykeyalias",
        "keyPass":"mykeypass",
        "keyStorePass":"samlstorepass",
        "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"
    },
    "assessmentReport":{
        "outputDatasource":"NEO4J",
        "maxWorkflowRetries":3,
        "fusionExportAPIUrl":"http://localhost:1337/api/v2.0/export"
    },
    "workflowDetails":{
        "corePoolSize":8,
        "maximumPoolSize":20,
        "keepAliveTime":20,
        "waitingQueueSize":10,
        "workflowExecutorCron":"1 0 0 * * ?",
        "workflowRetryExecutorCron":"0 0 */4 ? * *"
    },
    "mlConfiguration":{
		"h2oEndpoint":""
	},
    "insightsServiceURL":"http://localhost:8080",
    "insightsTimeZone":"UTC",
    "userId":"",
    "password":"",
    "refreshTime":"Jan 22, 2017 5:04:25 PM",
    "enableOnlineDatatagging":true,
    "enableAuditEngine":true,
    "enableWebHookEngine":true,
    "enableDataArchivalEngine":false,
    "enableOnlineBackup":false,
    "autheticationProtocol":"NativeGrafana",
    "pdfkey":"",
	"applicationLogLevel": {
		"updateLevelTransitiveDependency": false,
		"serviceLogLevel": {
			"PlatformService": "DEBUG",
			"PlatformEngine": "DEBUG",
			"PlatformReport": "DEBUG",
			"PlatformRegressionTest": "DEBUG"
		}
	}
}
Expand
titleServer Config with Vault

  • Configure Vault with Storage Engine as PostgreSQL, all configuration steps mention in Vault Configuration with PostgreSQL DB

  • Add following minimum configuration inside Insights INSIGHTS_HOME\.InSights\server-config.json

    Code Block
    languagejson
    {
                "vault": {
                                "isVaultEnable": true,
                                "vaultEndPoint": "http://10.10.90.42:8200/v1",
                                "secretEngine": "database-insights",
                                "vaultToken": "<vault root token>"
                },
                "grafana":{
                                "grafanaEndpoint":"http://localhost:3000"
                },
                "trustedHosts":[
                                "localhost"
                ]
}

  • Make sure that isVaultEnable = true with correct vault token, Vault is started and unsealed

  • Start Tomcat application

  • Login Insights UI with basic grafana credential using user ‘admin’ most probably password is ‘admin’

  • On successful login, It will load server configuration on UI, do the respective changes

  • Save the changes, It will store all your configuration in vault in encrypted format

  • If you want to edit any field in server configuration then use Insights UI

  • With Native Grafana authentication there is no need to restart tomcat, it automatically loads server config changes.

  • In case of SSO, initial login will be with initial grafana credential, do respective changes and restart tomcat.

Expand
titleComponents of server-config.json

Component

Significance

"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",
"user": "iSight",
"password": "iSight",
"prefetchCount" : 10

}

  • 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.

    • 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.


"agentDetails": {

"isOnlineRegistration":true,
"onlineRegistrationMode":"nexus",
"browseRepoUrl":"https://infra.cogdevops.com:8443/service/rest/repository/browse/docroot/insights_install/release",
"downloadRepoUrl":"https://infra.cogdevops.com:8443/repository/docroot/insights_install/release",
"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

    • 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.

"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.

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

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

"disableAuth": false

  • disableAuth - This option is used to turn ON/OFF authentication service.

"enableNativeUsers": true

  • enableNativeUsers - This option is used to enable native users from Grafana to log into Insights application.

"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"

...


Top Section