webMethods

Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.

View Only

Back to Library

Tech Bytes IWHI : Integration Runtime Management Overview

18 days ago

Bharath Meka

Introduction

This article explains about integration runtimes how to create and manage them.

Audience

It is assumed that readers of this article know about webMethods.io Integration.

Pre-requisite

webMethods.io Integration tenant with DADA capabilities enabled.

 DADA Introduction

      The Develop anywhere and deploy anywhere (DADA) provides the flexibility to allow developers to build integrations using the WebMethods Designer IDE (on-premises) or web-based Flow Service editors and then deploy them to various runtimes, including cloud, on-premises, or edge environments.

Please refer below link for more: 

https://community.ibm.com/community/user/integration/blogs/john-carter/2023/10/20/what-is-develop-anywhere-deploy-anywhere

What are Integration runtimes?

An integration runtime allows you to run integrations wherever you decide to deploy. In webMethods.io Integration we have multiple integration runtimes.

A screenshot of a computer

AI-generated content may be incorrect., Picture

Different types of Integration runtimes

Cloud Design time: A default runtime that is provided on your tenant to design, develop, and test integrations. This runtime is available only on your non-prod tenants.
During the development phase assets developed like DAF services or custom packages pulled from external repository reside on design time
Cloud Runtime: A default runtime that is provided in your tenant to run integrations. This is available only in production environments.
Edge Runtimes: A runtime that is owned by you and hosted externally to your WebMethods Integration tenant.
We can register Edge Runtime; App Connect runtime, and WebMethods Integration server.

Users can register edge runtime through the public API offered from the platform.

In the section below we will learn how to register runtimes with APIs.

Register Edge Runtime through API:

Create Edge Runtime:

Method: POST

URL: https://<hostname>/apis/v1/rest/control-plane/runtimes

Request Payload:

{

"name": "bhmedgeruntime",

"description": "edge runtime for local development ",

"visibility": "private"

}

Response:

{

"name": "bhmedgeruntime",

"agentID": "89729d8f78ec42238ff20c478d191118",

"createdDate": 1752040739316,

"instanceID": "5229dd45daa3",

"pairingCode": "074452bd99f14ae49f5a9db3606e8d0808e9cf70ae7a4300a799bab1ffd00754",

"ttl": 900,

"pingInterval": 60,

"env": {

"SAG_IS_CLOUD_REGISTER_URL": "https://env1754178.a-vir-c1.int.ipaas.dev.automation.ibm.com",

"SAG_IS_CLOUD_REGISTER_TOKEN": "074452bd99f14ae49f5a9db3606e8d0808e9cf70ae7a4300a799bab1ffd00754",

"SAG_IS_EDGE_CLOUD_ALIAS": "EdgeRuntime_ffd00754"

"imageRegistryURL": "ibmhybridcr.azurecr.io/webmethods-edge-runtime:11.2.0"

}

A screenshot of a computer

AI-generated content may be incorrect., Picture

Create Pairing Request:

Method: POST

URL: https://<hostname>/ apis/v1/rest/control-plane/runtimes/<edgeruntimealias>/instances/new-pairing-request

Request Payload:

<None>

Response :

{

"agentId": "35b3731d415d4b699ec0bd3cdc56afc8",

"agentName": "bhmedgeruntime",

"env": {

"SAG_IS_CLOUD_REGISTER_URL": "https://wmintanywhere.int-aw-au.webmethods.io",

"SAG_IS_CLOUD_REGISTER_TOKEN": "53c4baf2718d4ecaa94dae7b0c7662c4dcb8b6963557408da50bf1f3f3b08b97",

"SAG_IS_EDGE_CLOUD_ALIAS": "EdgeRuntime_f3b08b97"

"imageRegistryURL": "ibmwebmethods.azurecr.io/webmethods-edge-runtime:11.0.11",

"dockerRunCommand": "docker run -p 5555:5555 -d -e SAG_IS_CLOUD_REGISTER_URL=https://wmintanywhere.int-aw-au.webmethods.io -e SAG_IS_EDGE_CLOUD_ALIAS=EdgeRuntime_bhmedgeruntime -e SAG_IS_CLOUD_REGISTER_TOKEN=53c4baf2718d4ecaa94dae7b0c7662c4dcb8b6963557408da50bf1f3f3b08b97 --name=bhmedgeruntime_f3b08b97 ibmwebmethods.azurecr.io/webmethods-edge-runtime:11.0.11"

}

Picture 1, Picture

Steps to be performed in edge instance:

Now finally execute docker run command in your edge instance to pull the instance and setup the image.

Open terminal or command prompt and copy the dockerRunCommand from the above API response and execute.

Picture 2, Picture

Container gets created after pulling the image.

A screenshot of a computer

AI-generated content may be incorrect., Picture

Multi-instance in edge runtimes:

To maintain high availability (HA) and for better performance with improved efficiency, edge runtime supports multi-instance. This also helps in auto scaling of instances when needed.

To create an instance, click on overview of edge runtime and say Add Instance

After adding an instance, it will show up on the instance page.

When the user clicks on create a new instance, it will get the configurations details and packages from the agent manifest and create a new instance with different container ID.

To know more about the agent manifest refer to. https://community.ibm.com/community/user/viewdocument/promotion-of-develop-anywhere-deplo?CommunityKey=82b75916-ed06-4a13-8eb6-0190da9f1bfa

look for section about “Download the agent manifest file” under Create custom Edge runtime image.

Configurations under runtimes:

When we navigate inside the integration runtimes it provides various details like