The following figure shows a high-level architecture of Unified Inventory and Topology and how the services communicate.

Figure 1-1 High-level Architecture of Unified Inventory and Topology

Description of "Figure 1-1 High-level Architecture of Unified Inventory and Topology"

See the corresponding architecture diagrams of the services for more information.

UIM is a standards-based telecommunications inventory management application that enables you to model and manage customers, services, and resources. UIM supports complex business relationships and provides full life-cycle management of services and resources. UIM provides you with a real-time, unified view of customers, services, and resource inventory, enabling you to develop and introduce new services quickly and cost-effectively. UIM supports two deployment models: traditional (on-premise) deployment and cloud native deployment in a Kubernetes cluster.

Active Topology Automator (ATA) enables you to view the service, network, and resource topologies in the form of topology graphs. ATA uses Oracle Property Graph DB to manage the topology hierarchy.

ATA has the following sub components.

• ATA API
• ATA PGX
• ATA Consumer
• ATA UI
• Alarm Consumer
• SmartSearch Consumer
• Impact Analysis API

See ATA User’s Guide for more information.

Authentication leverages SAML 2.0 (Security Assertion Markup Language) and Open ID Connect (OIDC) authentication protocol of Identiy Provider (IdP) to implement the Single Sign-On (SSO) authentication solution with the services (UIM, ATA, Authorization, Message Bus, SmartSearch, OpenSearch). This enables you to seamlessly access multiple applications without being prompted to authenticate for each application separately. The main advantage of SSO is that you are authenticated only once, which is when you log in to the first application and you do not need to authenticate again when you subsequently access different applications within the same web browser session.

IdP also supports the single logout (SLO) feature. If you access multiple applications using SSO within the same web browser session, and then if you log out of any one of the applications, you are logged out of all of the applications.

Examples for authentication services are: IDCS, Keycloak, OAM, and so on.

For more information about IDCS, see https://www.oracle.com/technical-resources/articles/middleware/oracle-identity-cloud-service.html

For more information about OAM, see Administering Oracle Access Management

Authorization service defines a simplified and centralized approach for managing the authorization configurations for Unified Inventory and Topology services by defining the authorization policies. Authorization is the process of granting or denying access to specific resources based on the verified identity of a user whereas authentication is about verifying the identity of the user.

Authorization service is designed to provide permissions to access resources of an application for the authenticated user(s) with allowed role(s) or group(s).

Authorization service provides the capability to define various roles or groups in an application and define the permissions to resources under each role. For more information on Authorization, see "Deploying Authorization Service".

OpenSearch is a NoSQL database. It is an open-source search and analytics suite that makes it easy to ingest, search, visualize, and analyze data.

SmartSearch is a micronaut application, when integrated with OpenSearch, offers a powerful, flexible, and feature-rich search experience that can be tailored to specific business and user needs. Using OpenSearch as the underlying engine, SmartSearch can handle large volumes of data, perform real-time indexing, and support complex querying to enhance search relevancy. Features such as autocomplete, fuzzy matching, synonym recognition, and intelligent ranking make it easier for users to locate precise information, even if search terms are partially matched or misspelled.

Message Bus is a distributed event store and stream-processing service. Message Bus service sends and receives events and messages asynchronously to a specific destination (called as Topic) between the services. The Message Bus service uses Apache Kafka, which is a distributed event store and stream-processing platform, as the messaging platform. For packaging or deploying, Strimzi is used. Strimzi simplifies the process of running Apache Kafka in a Kubernetes cluster. Strimzi also provides container images and operators for running Kafka on Kubernetes.

The following workflow helps you with information required for UIM installation.

Description of the illustration uim_planning_workflow_1.png

#If true, render new canvas in network visualization tab.
uim.ui.networkPlanAndBuild.canvas.enabled=false
openSearchEnabled=false

# Topology MicroService
disableTopology=true
microServiceEnabled=false

This section provides information about planning your UIM upgrade for traditional and cloud native environments.

ATA uses Oracle Property Graph of Oracle Database that offers a powerful graph support to explore and discover complex relationships within ATA graphs.

Graph Server and Client is a software package that is required for Property Graph.

To install Property Graph:

1. Download Oracle Graph Server, oracle-graph-plsql-<version>.zip, from Oracle E-Delivery: https://www.oracle.com/database/technologies/spatialandgraph/property-graph-features/graph-server-and-client/graph-server-and-client-downloads.html

   Note:

   The versions are available at: Oracle Graph Server. See "UIM Software Compatibility" in UIM Compatibility Matrix for the corresponding version of Oracle Graph PL/SQL Patch.

2. Extract oracle-graph-plsql-<version>.zip and open the 19c and above folder.
3. Follow the instructions in the readme.md file to install Property Graph.