Setting up Jama Connect Webhooks (Kubernetes-Native) v9.41.x

Kelli
Kelli
  • Updated

Jama Connect Webhooks send event notifications from Jama Connect to configured webhook endpoints. In a Kubernetes-Native environment, setup includes configuring the Data Stream Service, configuring Helm values, and validating the deployment.

Architecture overview

Jama Connect Webhooks uses the Data Stream Service to process and deliver event notifications from Jama Connect to configured webhook endpoints. The Jama Connect Helm chart deploys the Data Stream Service in the Kubernetes cluster.

For Jama Connect Interchange installation and server requirements, see the Setting up Jama Connect Webhooks and Self-hosted server specifications.

Process overview

Setting up Jama Connect Webhooks in a Kubernetes-Native environment involves preparing the Data Stream database, and deploying the Data Stream Service through the existing Helm chart.

  1. Check the prerequisites and confirm network access. 
  1. Prepare the Data Stream database and dedicated credentials. 
  1. Configure and deploy the Data Stream Service by running the standard Helm commands. 
  1. Validate the Data Stream Service with the self-hosted Jama Connect stack. Jama Connect Interchange isn't required for this validation.  
  1. After you set up your webhook client, register the webhook URL from Jama Connect Interchange. You can also confirm connectivity between Jama Connect and Jama Connect Interchange during this step. 

Prerequisites

Complete these prerequisites before you set up Jama Connect Webhooks. 

  • Your self-hosted Jama Connect instance is running version 9.41 or later.
  • Your license files include the Webhooks entitlement and are applied to Jama Connect and Jama Connect Interchange. 
  • Add the Data Stream Service to your Jama Connect setup.
  • Complete the version-specific planning, preparation, installation, and upgrade topics in the Kubernetes Native Overview before you configure Jama Connect Webhooks. 

Plan for additional capacity

Setting Default per pod
Replicas 1
CPU request 500m
CPU limit 1000m
Memory request 2Gi
Memory limit 2Gi

Add this workload to the capacity plan established for the base Jama Connect installation. For high availability, use three replicas and confirm that topology spread can place them across the available zones.

Prepare the Data Stream database

Complete the base database procedure in Preparing your environment before creating the separate database or schema required by the Data Stream Service, along with dedicated credentials.

Important: For SQL Server, global.database.schema identifies the jama database, and core.datastream.application.database.schema identifies the datastream schema within that database.

MySQL

  1. Create a separate database named datastream and a dedicated account, such as datastreamuser.
  2. Grant the account full privileges on the database and follow your organization’s password policy and approved host restrictions.

    CREATE CHARACTER SET utf8mb4;
    CREATE USER 'datastreamuser'@'%' IDENTIFIED BY 'password';
    GRANT ALL PRIVILEGES ON datastream.* TO 'datastreamuser'@'%';DATABASE datastream 

Microsoft SQL Server

  1. In the existing Jama Connect database, create a datastream schema.
  2. Create or map a dedicated login and database user.
  3. Set datastream as the database user’s default schema.
  4. Grant the database users the permissions required for schema migration and runtime access.

    USE [jama];
    CREATE SCHEMA [datastream] AUTHORIZATION [datastreamuser];
    ALTER USER [datastreamuser] WITH DEFAULT_SCHEMA = [datastream];
    ALTER ROLE [db_owner] ADD MEMBER [datastreamuser];

Complete Jama Connect Webhooks setup in Jama Connect Interchange 

Once the Data Stream Service is operational, finish configuring Jama Connect Webhooks in Jama Connect Interchange. The setup includes creating a Jama Connect service account, adding a Connected Service connector, configuring the webhook endpoint, creating subscriptions, and validating signed events.

For the remaining steps, see Setting up Jama Connect Webhooks

Troubleshooting

Use these checks to identify common problems with database, tenant initialization, connectivity, and event delivery.

Issue Solution
Jama Connect upgrade Use the standard Helm upgrade workflow, confirm Data Stream readiness, and run the Helm upgrade operation.
Database restore Restore the Data Stream database and its matching signing-key encryption secret, then validate the tenant state.
The pod is not ready Check database reachability, credentials, certificate trust, resource availability, scheduling constraints, and pod logs.
Existing subscriptions fail after a restore Confirm that the restored Data Stream database and APP_SIGNATURE_KEY_ENCRYPTION_LOCAL_KEY_BASE64 value came from the same recovery set.
Jama Connect Interchange can’t connect to the Jama Connect instance Confirm that the Jama Connect URL is reachable over HTTPS from the separate Jama Connect Interchange host.
Events aren’t delivered Complete the endpoint verification, subscription, and signature-validation procedures in the Jama Connect Interchange Help.

 

 

 

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.