Page Comparison

...

...

...

...

...

...

...

...

...

...

Introduction

New WebHook framework using Python payload parsers and reusing agent registration module and PlatformEngine.

Some Benefits are

•Process complex messages like json array

•Use same Platform Engine for Agent and WebHook

•Create Self relationship using relationship metadata

•Possible to capture data using mixture of pull and push mechanism

•Reduce Maintenance effort like auditing

•Easy to configure from UI screen

•Easy for Enhancement, Implementation engineer will modify based on client requirement

•Possible to use multiple field for insightsTimeX calculation like commitTime, UpdatedAt

...

Prerequisite

• Supported from Insights Application version > 8.0

• Set up WebHook Subscriber PlatformInsightsWebHook as mention in Installing Webhook Subscriber and Webhook Engine

•  Daemon Agent should be configured

• Make sure that your necessary port are open test following URL from any other system which is outside of network http://<HostIP>/webhook/PlatformInsightsWebHook/insightsDevOpsWebHook?webHookName=git_webhook

• Make sure that "webhookHost": updated in uiConfig.json ex: http://<HostIP>/webhook/

Currently Supported tool

• GitHub

• GitLabIssue

UI Configuration

• Click "Agent Management" under the Admin section.

• To configure webhookWebHook, click Add button on the top right corner.

Image RemovedImage Added

• Webhook WebHook configuration from Agent Management screen is supported from version v7v8.90.

• Select the OS type, type as Webhook WebHook, version and tool for which webhook WebHook needs to be configured.

• Note: For agent registration select type as Agent.

...

• Add webhook WebHook details and click on add button below to register. Change Dynamic template as per client needs

• Once webhook WebHook is registered successfully, then URL for the selected webhook WebHook can be copied by using Copy to Clipboard Icon.

...

• Once the link is copied then it needs to be added in the actual tool’s

...

• WebHook.

Webhook Subscriber

Once webhook registration is done, please refer below section to configure an Webhook Subscriber:

...

Image Added

WebHook Subscriber

• Tool WebHook will push data to

  webhook

  WebHook Subscriber when an event occurs and

  webhook

  WebHook subscriber will publish the

  recieved data on

  received data to the WebHook queue mentioned in WebhookPayloadDataQueue.

...

WebHook Agent

Registered webhook WebHook agent will consume data from WebhookPayloadDataQueue, processes message according to the dynamic template in config.json and publish to the data queue.

...

• Platform Engine will consume this message from data queue and store it in neo4j.

• Note: Same Platform Engine will be used for both agent Agent and webhook.For Platform Engine configuration please refer below section:WebHook Agent.