Introduction

This readme explains how to run the webhook sample in Kubernetes.

Doing so requires to have Decision Center set up in Kubernetes beforehand.

Also, before following the steps below, make sure you have built the images as explained in README.md.

Running this sample on Kubernetes

Push the webhook notifier images to your Docker registry

docker login $REGISTRY_HOST -u $REGISTRY_USERNAME -p "$REGISTRY_PASSWORD" --tls-verify=false

docker tag webhooknotifier-logfile $REGISTRY_HOST/webhooknotifier-logfile
docker tag webhooknotifier-slack $REGISTRY_HOST/webhooknotifier-slack

docker push $REGISTRY_HOST/webhooknotifier-logfile
docker push $REGISTRY_HOST/webhooknotifier-slack

where $REGISTRY_HOST should be set to the hostname of the Docker registry optionally followed by the relevant repository depending on your Docker registry.

Start one pod for each image

Set the current context to the namespace the Decision Center pods are running, and then run:
```
kubectl run webhooknotifier-logfile \
--image=$REGISTRY_HOST/webhooknotifier-logfile:latest \
--expose --port 3000

kubectl run webhooknotifier-slack \
--image=$REGISTRY_HOST/webhooknotifier-slack:latest \
--expose --port 3000
```
NOTE 2: These commands also create one service (of type ClusterIP) for each pod, allowing to send requests to the pods using the following URLs:
- http://webhooknotifier-logfile.NAMESPACE.svc.cluster.local:3000
- http://webhooknotifier-slack.NAMESPACE.svc.cluster.local:3000
where NAMESPACE is the namespace in which the pods and the services have been created.
Additionally, you may need to specify the secret containing the Docker registry credentials in the pods definition (in the parameter spec.imagePullSecrets) if this is not done automatically.

To do so, first create the secret:
```
kubectl create secret docker-registry regcred --docker-server=<your-registry-server> --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
```
Then run kubectl edit pod webhooknotifier-logfile and add the two lines below under spec: :
```
spec:
  imagePullSecrets:
  - name: regcred
```
Do the same for the pod webhooknotifier-slack.

Configure the webhook notifications in Decision Center

Log files notifications

curl -k -X 'PUT' \
'https://$DC_HOST/decisioncenter-api/v1/webhook/notify?url=http%3A%2F%2Fwebhooknotifier-logfile.$NAMESPACE.svc.cluster.local%3A3000%2Fprint' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d 'null' \
-u odmAdmin:odmAdmin

where

$DC_HOST should be set to the hostname of Decision Center,
$NAMESPACE should be set to the name of the namespace/project in which the webhook notifier pods and service have been created,
odmAdmin:odmAdmin should be replaced by the actual username and password of a user with rtsAdministrator role.

Slack Notifications

export SLACK_TOKEN=`kubectl exec -ti webhooknotifier-slack -- curl 'http://localhost:3000/token.generate' -H 'accept: */*' -H 'Content-Type: application/json'`

curl -X 'PUT' -k \
'https://$DC_HOST/decisioncenter-api/v1/webhook/notify?url=http%3A%2F%2Fwebhooknotifier-slack.$NAMESPACE.svc.cluster.local%3A3000%2Fslack' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d "$SLACK_TOKEN" \
-u odmAdmin:odmAdmin

where:

$DC_HOST should be set to the hostname of Decision Center,
$NAMESPACE should be set to the name of the namespace/project in which the webhook notifier pods and service have been created,
odmAdmin:odmAdmin should be replaced by the actual username and password of a user with rtsAdministrator role.

The expected output looks like:

{"id":"57896361-62f8-4a0e-a86b-3da46417f493","url":"http://webhooknotifier-slack.<NAMESPACE>.svc.cluster.local:3000/slack","authToken":"*****************************************************"}%

Using the sample

Once webhooks are configured, specific events in Decision Center will trigger notifications.

Below is an example scenario that illustrates the process:

Scenario: Creating a Snapshot in the Business Console

Log in to the Business Console at https://$DC_HOST/decisioncenter using the credentials:
- Username: odmAdmin
- Password: odmAdmin
Navigate to the Library tab. Select the Loan Validation Service box (click anywhere except the name) and choose the main branch.
Take a Snapshot:
- Click the Take a Snapshot button in the toolbar.
- In the dialog that appears:
  - Enter a name for the snapshot: mysnapshot
  - Click Create

Viewing the notification file output

After creating this snapshot, a notification will be triggered.

To view the content of the generated log file, run the following command:

kubectl exec -ti <webhooknotifier-logfile-container-id> sh -c 'cat /app/results/default.txt'

The snapshot creation triggers a webhook notification with the following sample payload:

{
  "version": "1.0",
  "id": "e749da20-1f2f-47bb-8a97-568eab4c7f3b",
  "author": "odmAdmin",
  "date": 1730196680692,
  "type": "SnapshotCreated",
  "content": [
    {
      "id": "6f41d82c-d20f-4a2a-8c1d-d6eb5a49f5dd",
      "internalId": "brm.Snapshot:71:71",
      "name": "mysnapshot",
      "createdBy": "odmAdmin",
      "createdOn": 1730196679000,
      "lastchangedBy": "odmAdmin",
      "lastChangedOn": 1730196679000,
      "parentId": "1558f25b-daa6-4982-8b0b-48a388c7c202",
      "documentation": "",
      "buildMode": "DecisionEngine",
      "initial": false,
      "kind": "StandardSnapshot"
    }
  ],
  "details": [
    {
      "targetURL": "http://172.19.0.4:9060/decisioncenter/t/library#overviewsnapshot?id=brm.Snapshot%3A71%3A71&datasource=jdbc%2FilogDataSource&baselineId=brm.Snapshot%3A71%3A71"
    }
  ],
  "sourceName": "Decision Center",
  "sourceLink": "http://172.19.0.4:9060/decisioncenter?datasource=jdbc%2FilogDataSource"
}

The Slack webhook notifier forwards the notifications to Slack and the log files notifier saves them in the results directory in the log files below:

deployments.txt: Deployment details.
rules.txt: Rule changes.
releases.txt: Release details.
activities.txt: Activity details.
default.txt: Others details.

Viewing the Slack notification output

If you have configured the Slack notification, a message with the following content should be displayed in the log of the webhooknotifier-slack pod:

slack-1    | {
slack-1    |   "version": "1.0",
slack-1    |   "id": "a1039496-4add-40d5-b36f-558f6db5438f",
slack-1    |   "author": "odmAdmin",
slack-1    |   "date": 1730208680316,
slack-1    |   "type": "SnapshotCreated",
slack-1    |   "content": [
slack-1    |     {
slack-1    |       "id": "c6d806d7-f569-44a4-add1-f2ab46f2bd9a",
slack-1    |       "internalId": "brm.Snapshot:71:71",
slack-1    |       "name": "mysnapshot",
slack-1    |       "createdBy": "odmAdmin",
slack-1    |       "createdOn": 1730208680000,
slack-1    |       "lastchangedBy": "odmAdmin",
slack-1    |       "lastChangedOn": 1730208680000,
slack-1    |       "parentId": "1558f25b-daa6-4982-8b0b-48a388c7c202",
slack-1    |       "documentation": "",
slack-1    |       "buildMode": "DecisionEngine",
slack-1    |       "initial": false,
slack-1    |       "kind": "StandardSnapshot"
slack-1    |     }
slack-1    |   ],
slack-1    |   "details": [
slack-1    |     {
slack-1    |       "targetURL": "http://172.18.0.4:9060/decisioncenter/t/library#overviewsnapshot?id=brm.Snapshot%3A71%3A71&datasource=jdbc%2FilogDataSource&baselineId=brm.Snapshot%3A71%3A71"
slack-1    |     }
slack-1    |   ],

and a message should appear your slack channel :

Stopping the Sample

To remove the webhooks configured in Decision Center, first list them:

curl -X 'GET' \
  'https://$DC_HOST/decisioncenter-api/v1/webhooks/notify' \
  -H 'accept: */*'

where $DC_HOST should be set to the hostname of Decision Center.

The expected output looks like:

{
  "elements": [
    {
      "id": "d2808ed5-f074-45ff-8905-a20d90279378",
      "url": "http://webhooknotifier-slack.default.svc.cluster.local:3000/slack",
      "authToken": "*************************************************************************************************************************************************************************************"
    },
  ...

You can then remove a webhook from Decision Center, by running the command below:

curl -X 'DELETE' \
  'https://$DC_HOST/decisioncenter-api/v1/webhooks/$WEBHOOK_ID/notify' \
  -H 'accept: */*'

where

$DC_HOST should be set to the hostname of Decision Center,
$WEBHOOK_IDshould be set to the id of the webhook you want to remove (eg. d2808ed5-f074-45ff-8905-a20d90279378 in the example above)

Finally, remove the notifier pods and their services:

oc delete svc,pod webhooknotifier-logfile
oc delete svc,pod webhooknotifier-slack

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README-KUBERNETES.md

README-KUBERNETES.md

Introduction

Running this sample on Kubernetes

Using the sample

Scenario: Creating a Snapshot in the Business Console

Viewing the notification file output

Viewing the Slack notification output

Stopping the Sample

Files

README-KUBERNETES.md

Latest commit

History

README-KUBERNETES.md

File metadata and controls

Introduction

Running this sample on Kubernetes

Using the sample

Scenario: Creating a Snapshot in the Business Console

Viewing the notification file output

Viewing the Slack notification output

Stopping the Sample