Versions Compared

Key

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

...

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:8200/v1",
		"secretEngine": "",
		"vaultToken": ""
	},
	"grafana": {
		"grafanaEndpoint": "http://localhost:3000",
		"grafanaDBEndpoint": "jdbc:postgresql://localhost:5432/grafana",
		"adminUserName": "",
		"adminUserPassword": "",
		"dbUserName": "",
        "dbPassword": ""
	},
	"trustedHosts": [
		"localhost"
	],
	"graph": {
		"endpoint": "http://localhost:7474",
		"authToken": "",
		"boltEndPoint": "bolt://localhost:7687",
		"maxIdleConnections": 25,
		"logQueryIfProcessingTimeGreaterThanInMS": 5
	},
	"postgre": {
		"userName": "",
		"password": "",
		"insightsDBUrl": "jdbc:postgresql://localhost:5432/insight",
		"grafanaDBUrl": "jdbc:postgresql://localhost:5432/grafana",
		"c3pMinSize": "9",
		"c3pMaxSize": "25",
		"c3pTimout": "1800",
		"c3pMaxStatements": "300"
	},
	"messageQueue": {
		"host": "localhost",
		"port": 5672,
		"user": "",
		"password": "",
		"prefetchCount": 5,
		"enableDeadLetterExchange":false
	},
	"agentDetails": {
		"isOnlineRegistration": truefalse,
  		  "onlineRegistrationMode": "nexus",
		"browseRepoUrl    "offlineAgentPath": "httpsC://infra.cogdevops.com/service/rest/repository/browse/docroot/insights_install/releaseofflineAgent",
 		"downloadRepoUrl   "unzipPath": "httpsC://infra.cogdevops.com/repository/docroot/insights_install/releaseAgentsDownload",
		"nexusUserName    "agentExchange": "iAgent",
   		 "nexusPasswordagentPkgQueue": "INSIGHTS.AGENTS.PACKAGE",
  		  "docrootUrlgithubAPI": "https://platformapi.cogdevopsgithub.com//insights_install/releaserepos/CognizantOneDevOps/Insights/releases",
 		"offlineAgentPath   "githubAccessToken": "C:\\InSights_Windows\\Agents\\offlineAgent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",
		"unzipPath    "repoUrl": "C:\\InSights_Windows\\Agents\\PlatformAgents\\unzip",
		"agentExchange": "iAgent",
		"agentPkgQueue": "INSIGHTS.AGENTS.PACKAGEhttps://github.com/CognizantOneDevOps/Insights/releases/download",
    "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": "devopsplatform",
    "nexusPassword": "devops123",
    "docrootUrl": "http://platform.cogdevops.com/insights_install/release"
	},
	"endpointData": {
		"elasticSearchEndpoint": "http://localhost:9200"
	},
	"queryCache": {
		"esCacheIndex": "neo4j-cached-results/querycacheresult"
	},
	"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 ? * *"
	},
	"emailConfiguration": {
		"sendEmailEnabled": false,
		"smtpHostServer": "",
		"smtpPort": "",
		"smtpUserName": "",
		"smtpPassword": "",
		"isAuthRequired": true,
		"smtpStarttlsEnable": true,
		"mailFrom": "onedevops@cogdevops.com",
		"subject": "Health Status - {TimeOfReportGeneration}",
		"systemNotificationSubscriber": "",
		"logo": "img/Insight.svg",
        "line": "img/Line.svg",
        "footerLogo": "img/FooterLogo.svg"
	},
	"correlations": {
		"correlationWindow": 48,
		"correlationFrequency": 3,
		"batchSize": 2000
	},
	"schedulerConfigInMin": {
		"auditEngineInterval": 60,
		"webhookEngineInterval": 10,
		"engineAggregatorModuleInterval": 10,
		"engineCorrelatorModuleInterval": 60,
		"offlineDataProcessingExecutorInterval": 10,
		"dataArchivalEngineInterval": 240,
		"projectMapperModuleInterval": 10,
        "dataPurgingExecutorInterval": 300
	},
	"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"
	},
	"mlConfiguration": {
		"h2oEndpoint": ""
	},
	"webhookEngine": {
		"enableWebHookEngine": false,
		"eventProcessingWindowInMin": 60
	},
	"insightsServiceURL": "http://localhost:8080",
	"insightsTimeZone": "UTC",
	"refreshTime": "Jan 22, 2017 5:04:25 PM",
	"enableOnlineDatatagging": false,
	"enableAuditEngine": false,
	"enableDataArchivalEngine": false,
	"autheticationProtocol": "NativeGrafana",
	"pdfkey": "",
	"applicationLogLevel": {
		"updateLevelTransitiveDependency": false,
		"serviceLogLevel": {
			"PlatformService": "DEBUG",
			"PlatformEngine": "DEBUG",
			"PlatformReport": "DEBUG",
			"PlatformRegressionTest": "DEBUG"
		}
	},
	"proxyConfiguration":{
		"isEnableProxy":false,
		"proxyHost":"",
		"proxyPort":0,
		"proxyUsername":"",
		"proxyPassword":""
	
	},
	"userId": "",
    "password": "",
    "enableWebHookEngine": true,
    "enableOnlineBackup": false,
    "enableSSO": false
}
Expand
titleMandatory Fields/Sections
Code Block
languagejson
    "vault": {
		"isVaultEnable": false,
	},
	"grafana": {
		"grafanaEndpoint": "http://localhost:3000",
		"grafanaDBEndpoint": "jdbc:postgresql://localhost:5432/grafana",
		"adminUserName": "",
		"adminUserPassword": ""
	},
	"trustedHosts": [
		"localhost",
		"http://localhost:8080"
	],
	"graph": {
		"endpoint": "http://localhost:7474",
		"authToken": "",
		"boltEndPoint": "bolt://localhost:7687",
	},
	"postgre": {
		"userName": "",
		"password": "",
		"insightsDBUrl": "jdbc:postgresql://localhost:5432/insight",
		"grafanaDBUrl": "jdbc:postgresql://localhost:5432/grafana",
	},
	"messageQueue": {
		"host": "localhost",
		"user": "",
		"password": "",
	},
	"singleSignOnConfig": {
		"tokenSigningKey": "insights_IDP_CogDevops_SSO_Token_string",
	},
	"autheticationProtocol": "NativeGrafana",
	"insightsServiceURL": "http://localhost:8080"

Expand
titleServer Config configuration with Vault

Info

Installing fresh Insights application

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

Info

Upgrade Insights Application to Vault

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

  • Backup your existing server config json file

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

    Code Block
    {
                    "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 copy detail from your backup server config

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

Info
Upgrade Agent Changes with Vault

If existing application have agent configured with vault then it is mandatory to upgrade it using following steps

  • Login to Insights UI , go to Agent Configuration

  • Changes Agent version >= 7.3

  • Update all your secret again so that it will store in new vault  

  • Restart agent

  • New Agent Registration will affect with these changes

...