Page Status: Updated for Istanbul -
Component Status: Pending PTL updates and ArchCom Review
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:
| usecase-UI architecture |
| UU-APIE-2 | Customer Portal | User interface for customer:
| usecase-UI architecture |
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 |
| VFCE-2 | 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. | Microservice Bus API Documentation |
| etsicatalogAPIE1~4 | Modelling Tosca Parser Interfaces and catalog interfaces | An interface for the Tosca Parser from Modelling project to parse the NS and VNF Descriptors. | Etsicatalog API Document |
| 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:
Usecase-UI is a web application which contains three parts:
- Usecase-UI GUI
- Usecase-UI Server
- Usecase-UI NLP Server(from I 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 5 containers:
Usecase-UI-Operator Portal
Usecase-UI-Operator Server
- Usecase-UI-Customer Portal
- Usecase-UI-Customer Backend
- Usecase-UI-NLP Server(from H Release)
7. New Release Capabilities
The Jakarta Release supports three capabilities:
- IBN module: A common user interface for CCVPN, E2E Slicing and other usecases by intent-based service.
- IBN module: A common data set for NLP training.
- IBN module: Enhancing the NLP algorithm and model for more accurate intent translation. .
- “Network/ccvpn-network” module: Ability to display underlay L1 network topology and resource utilization status.
- “Network/ccvpn-network” module: Ability to display installation and configuration for each OTN tunnel.
8. References
Usecase-UI Installation & User Guide: usecase-ui docs