ARC Usecase-UI Component Description – Montreal-R13
- Chaker Al-Hakim
- Byung-Woo Jun
Page Status: Updated for Montreal - Nov 1, 2023
Component Status: Approved
Last Reviewed on:
Certified by:
1. High Level Component Definition and Architectural Relationships
Usecase-UI is an application portal which provides the ability to manage ONAP service instances.
Usecase-UI allows customers to create/delete/update service instances, as well as to monitor the alarm and performance of these instances.
2. API definitions
Usecase-UI provides the following interfaces(Since Usecase-UI doesn't offer APIs, we just provide the architecture of the two portal):
Interface Definition | Interface Capabilities | API Spec (Swagger) | |
|---|---|---|---|
UU-APIE-1 | Operator Portal | User interface for operators:
| |
UU-APIE-2 | Customer Portal | User interface for customer:
|
Note: xxxI interface is a Component internal interface. xxxxE interface is a component external interface
The provided UI interfaces are found at: Usecase-UI latest user guide
Usecase-UI consumes the following interfaces:
Interface Name | Interface Definition | Interface Capabilities | API Spec (Swagger) |
|---|---|---|---|
SDCE-6* | SDC Interface | An interface to receive resource Templates from SDC design catalog. | https://docs.onap.org/projects/onap-sdc/en/latest/offeredapis.html |
SO-E-01* | Service and Resource order requests | Service Instance management (Service, Volume Group, VF Module, VNF) Health check, global and node. Infrastructure provider management (Certificates, networks, sub-networks, security groups) | https://docs.onap.org/projects/onap-so/en/latest/api/offered_consumed_apis.html |
Service Orchestrator / Policy Interface | An interface to allow Service Orchestrator and Policy request NS Lifecycle Management ( ETSI SOL-005 ). | https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/latest/platform/APIs/index.html | |
AAIE-1* | Inventory Service Interface | An interface to create, update, query, and delete resource information and relationships. | |
MSBE-1* | Micro Service Bus Interface | An interface for registration and discovery with the ONAP Micro Service Bus. | |
Modelling Tosca Parser Interfaces and catalog interfaces | An interface for the Tosca Parser from Modelling project to parse the NS and VNF Descriptors. | ||
DCAE-DES | DCAE Service Components | An interface for DataLake Exposure Service Rest APIs |
*Current description is based on Guilin documentation, will be updated accordingly if correspondent API update in Honolulu.
3. Component Description:
Note: MSB is deprecated. So, no interface to MSB.
Usecase-UI is a web application which contains three parts:
Usecase-UI GUI
Usecase-UI Server
Usecase-UI NLP Server(from I Release)
Usecase-UI INTENT ANALYSIS SERVER(from K Release)
4. known system limitations
Now the component Redundancy and scaling depends on Kubernetes.
5. Used Models
Usecase-UI use the following models:
TOSCA - VNF Descriptor/NS Descriptor ETSI NFV SOL001 v2.4.1 & v2.5.1
6. System Deployment Architecture
Usecase-UI consists of 6 containers:
Usecase-UI-Operator Portal
Usecase-UI-Operator Server
Usecase-UI-Customer Portal
Usecase-UI-Customer Backend
Usecase-UI-NLP Server(from H Release)
Usecase-UI-Intent-Analysis Server(from K Release)
7. New Release Capabilities
The London Release supports six capabilities:
Optimize the Intent analysis server to improve the general intent solutions.
Introduce AI technology to improve the intelligent level of intent processing.
Support interaction with Nephio by adding Nephio adapter to intent analysis server.
Enhance the functions of intent translation for Cloud-network Convergence Services.
8. References
Usecase-UI Installation & User Guide: usecase-ui docs