Has anyone done Service Mapping for IBM API Connect?

jordimsant
Mega Sage

38m ago

Hi everyone,

 

I'm working on modelling IBM API Connect in ServiceNow using Service Mapping, and I'd love to hear from anyone who has done something similar.

 

What I've found so far

  • IBM API Connect is made up of four subsystems: Management, Gateway, Portal and Analytics.
  • Its "endpoints" are not just API URLs. They are named configuration entries (admin, manager, consumer, api, portal, rgwd/gwd, etc.), each mapped to a hostname exposed via Ingress/Route, and secured by a TLS certificate. Some of them (api.portal, apic-a7s-client, apic-a7s-ai) use mutual TLS and are used for communication between subsystems rather than by end users.
  • IBM's documentation I've been using: https://www.ibm.com/docs/en/api-connect/software/10.0.1?topic=deployment-overview-endpoints-certific...
  • I haven't found an out-of-the-box pattern for API Connect in Discovery and Service Mapping Patterns or on the Store. The IBM App Connect Enterprise (WMB) patterns exist, but that's a different product.

 

My current plan

  • Model "IBM API Connect" as a parent service with one child service per subsystem, and use the API Manager UI (manager) and Cloud Manager UI (admin) URLs as entry points, plus possibly the Gateway's API Invocation Endpoint.

What I'd like to know

  1. Has anyone mapped IBM API Connect with Service Mapping? Did you use a custom pattern, traffic-based mapping, tags, or a manual/hybrid approach?
  2. Is there an existing pattern or Store content (from ServiceNow or a partner) that I may have missed
  3. Which entry points did you use (manager, admin, gateway invocation endpoint, others)?
  4. Was your deployment on Kubernetes/OpenShift (Operator) or VMs/OVA? How did that affect discovery and the resulting map?
  5. What did you need from the API Connect team (hostnames, credentials, network access from the MID Server, access to the platform REST API, etc.)?
  6. If you built a custom pattern, did you query the API Connect REST API (platform-api) to discover components? Any pitfalls to avoid?
  7. How did you represent the dependencies between subsystems (Management, Gateway, Portal, Analytics) in the CMDB?

Any advice, lessons learned or examples (even partial ones) would be really appreciated.

 

Thanks in advance!

0 Helpfuls
  • 22 Views
0 REPLIES 0