Maximo Application Suite core services

Refer to the details about IBM® Maximo® Application Suite architecture, topology, components and how the components are distributed as micro services solutions.

Kubernetes control plane

Controller managers

ibm-mas-operator: ibm-mas-operator watches Suite.core.mas.ibm.com, acts as the primary controller manager for an installation of the Maximo Application Suite core services, installing all required entity managers and provisioning the primary resources detailed on this page.

ibm-truststore-mgr-controller-manager: ibm-truststore-mgr-controller-manager watches Truststore.ibm-truststore-mgr.ibm.com and manages all of the truststores in use in the core services namespace.

Entity managers

entitymgr-addons: entitymgr-addons add ons configuration.

entitymgr-bascfg: entitymgr-bascfg watches BASCfg.config.mas.ibm.com, manages the DRO integration with Maximo Application Suite.

entitymgr-coreidp: entitymgr-coreidp watches CoreIDP.internal.mas.ibm.com, manages the Core IDP component.

entitymgr-idpcfg: entitymgr-idpcfg watches IDPCfg.config.mas.ibm.com, manages IDP integration with Maximo Application Suite.

entitymgr-jdbccfg: entitymgr-jdbccfg watches JDBCCfg.config.mas.ibm.com, manages JDBC integration with Maximo Application Suite, performing configuration validation.

entitymgr-kafkacfg: entitymgr-kafkacfg watches KafkaCfg.config.mas.ibm.com, manages Kafka integration with Maximo Application Suite, performing configuration validation.

entitymgr-jdbccfg: entitymgr-jdbccfg watches MongoCfg.config.mas.ibm.com, manages Mongo integration with Maximo Application Suite, performing configuration validation.

entitymgr-objectstorage: entitymgr-objectstorage watches ObjectStorageCfg.config.mas.ibm.com, manages ObjectStorage integration with Maximo Application Suite, performing configuration validation.

entitymgr-pushnotificationcfg: entitymgr-pushnotificationcfg, watches PushNotificationCfg.config.mas.ibm.com, manages PushNotification integration with Maximo Application Suite, performing configuration validation.

entitymgr-scimcfg: entitymgr-scimcfg watches SCIMCfg.config.mas.ibm.com, manages SCIM (LDAP User sync) integration with Maximo Application Suite, performing configuration validation and resources creation such as scimsync-agent job and scimsync liberty pod.

entitymgr-slscfg: entitymgr-slscfg watches SLSCfg.config.mas.ibm.com, manages SLS integration with Maximo Application Suite, performing configuration validation and resources creation such as licensing-mediator pod. This pod is also responsible to register the SLS client in the SLS server.

entitymgr-smtpcfg: entitymgr-smtpcfg watches SMTPCfg.config.mas.ibm.com, manages SMTP integration with Maximo Application Suite, performing configuration validation.

entitymgr-watsonstudiocfg: entitymgr-watsonstudiocfg watches WatsonStudioCfg.config.mas.ibm.com, manages Watson Studio integration with Maximo Application Suite, performing configuration validation.

entitymgr-ws: entitymgr-ws watches Workspace.core.mas.ibm.com, manages Workspace creation in Maximo Application Suite.

Suite administration

Core API: The coreapi deployment provides a RESTful API to support management of the Maximo Application Suite, as an alternative to working directly with Kubernetes resources natively. The API is made available on the route https://api.{masdomain}.
Internal API: The internalapi deployment provides an internal API available to applications in the Maximo Application Suite, for example, user management. internalapi is used by internal components only. Application to application communication.
Mobile API: The mobileapi deployment provides the backend for the mobile application package API, serving up the navigator application package. Other implementations of the mobile API exist in each application that supported mobile application packages, Core API controls access to these backend services.
Monitoring agent: The monagent-mas deployment is responsible for tracking the health of the core services. It reports status to the Maximo Application Suite status subresource broken down into three categories:; Mongo configuration status; SLS integration status; DRO integration status
PNS integration: The pushnotifications deployment provides support for integration to an external push notification service (PNS). PNS support is an optional extension that is configured by a system administrator, enabling push notification support across Maximo Application Suite applications; it is available at https://api.{{domain}}/pushnotification only if the system scope PushNotificationCfg resource has been created.

Identity provider

Core IDP: The coreidp deployment serves as the identity provider for all applications across Maximo Application Suite.
Core IDP login: The coreidp-login deployment hosts the authentication login screens and superuser login logic for Maximo Application Suite. This is not meant to be a Maximo Application Suite endpoint but used as part of the redirect during Maximo Application Suite authentication flow. The service is available on the route https://auth.{masdomain}.
Group sync coordinator: The groupsync-coordinator deployment is responsible for coordinating user group synchronization across all installed applications.
User sync coordinator: The usersync-coordinator deployment is responsible for coordinating user synchronization across all installed Applications.

Catalog management

The Maximo Application Suite Catalog acts as the mechanism for customers to discover the resources in Maximo Application Suite that they are interested in, it allows the Maximo Application Suite to abstract the actual resource (that is, implementation) of a capability away from how it is presented as a catalog item.

Catalog API

The catalogapi deployment provides read access to the catalog inventory. The catalog API is exposed from the endpoints in Core API which proxy requests to the internal catalog API service.

Catalog manager

The catalogmanager deployment provides internal inventory management and AppPoint reservation APIs.

Catalog manager topology

Console

Admin dashboard: The admin-dashboard deployment provides the administration console available on the route https://admin.{masdomain}.
Suite homepage: The homepage deployment provides the primary home screen for the Maximo Application Suite, available on the route https://home.{masdomain}.
Application navigator: The navigator deployment serves the application navigator available at https://{workspace}.home.{masdomain}.

Licensing and usage data collection

Account AppPoints reporter

The accapppoints deployment submits events to IBM Data Reporter Operator (DRO) on an hourly basis. It obtains and converts data from the IBM Suite License Service.

AppPoint reports are converted to account contractual usage events
License usage reports are converted to account adoption usage events

Note: Starting in IBM Maximo Application Suite 9.0, 8.11.7, and 8.10.10, the User Data Services (UDS) is deprecated and replaced with IBM Data Reporter Operator (DRO).

For more information, see Data Reporter Operator.

Adoption usage API

The adoptionusageapi deployment provides an internal API, which enables applications in the Maximo Application Suite to report metrics that are used to generate AppPoint and License usage reports.

Adoption usage reporter

The adoptionusage-reporter deployment pulls the data that is related to adoption of different applications by users. It gathers data in terms of number of users and total AppPoints of these users who login to each of the Maximo Application Suite applications, whenever the users login to these applications.

This application runs as a cronjob and sends this data to Data Reporter Operator (DRO). DRO in turn sends this data to the IBM growth stack to provide IBM an insight into how customers are using the Maximo Application Suite.

SLS mediator

The licensing-mediator deployment provides internal APIs that act as the bridge between the Maximo Application Suite installation and the Suite License Service (SLS). It will also periodically run a synchronization process, which ensures licensing information in the user registry and in SLS are in alignment. Suite License Service mediator topology

Milestones API

The milestonesapi deployment is responsible for reporting critical user events, which are known as "milestones", to Data Reporter Operator (DRO). DRO forwards these events into the IBM Growth Stack, which includes tools to help IBM gain insight into customer usage and assist with campaign administration. Milestones API topology