STATUS: Project approved (waiting for Architectural Approval)
Portal:
1 High Level Component Definition and Architectural Relationships
Portal is a GUI platform that provides the ability to integrate different ONAP platform GUIs into a centralized portal.
It provides:
- The capability to allow other ONAP components to run within their own infrastructure while providing common management services and capabilities in a centralized way
- Provides common capabilities such as application on-boarding and management, centralized access management and hosting application widgets, Context-Aware UIControls, Visualization & Reporting Engine
- Provides SDK capabilities to access portal capabilities
Portal is used by:
- VID, Policy, AAI, SDC, MSB and CLI
In addition to regular user, there are admin roles available for Portal to perform some administrative activities of Portal itself and the administration of on-boarded apps.
From the ONAP Portal, administrators:
- access the same functionality accessible to users
- manage users and application admins
- onboard applications and widgets (developed using the Portal as a platform)
- edit the functional menu
2. API definitions
Portal provides the following interfaces: (to be done, add the links)
Interface Name | Interface Definition | Interface Capabilities |
---|---|---|
PortalE-1 | Portal Admin Interface. | GUI to the portal administrator to:
|
PortalE-2 | Application Admin Interface | GUI to the application administrator to
|
PortalE-3 | External App Interface | Platform API for application to:
|
PortalE-4 | Role Approval Interface | Platform API for application to:
|
PortalE-5 | Session Communication Interface | Platform API for application to:
|
PortalE-6 | Shared Context Interface | Platform API for application:
|
PortalE-7 | Ticket Event Interface | Platform API for the application to:
|
PortalE-8 | Web Analytics Interface | Platform API for the application to:
|
PortalE-9 | External Request Interface | Platform API to:
|
PortalE-10 | External Access Role Interface | Platform API application to:
|
Portal however provides multi-language support.
The multi-language support provides:
- Login user langage settings
- Update user language settings
- Language options to user
- Ability to add/remove and query supported languages.
3. Component Description:
A more detailed figure and description of the component.
The main functional components of portal are:
- Portal Core Integration: APIs in the SDK provide simplified integration between the ONAP Portal Core and ONAP applications. By default, any application built on the SDK will have implicit integration with the Portal Core.
- Centralized Access Control: The Portal core acts as a gatekeeper for all ONAP applications. Site administrators decide who gets access to which applications with a distributed access management scheme.
- Common UI Controls: These are used to ensure a common look and feel and a consistent user experience.
- Context-Aware UI Controls: Since the ONAP Portal Core serves both as the point of entry and as the provider of context-aware menus and UI controls, it can ensure that when a user jumps from one application to another, the application menu items remain consistent and comply with the user’s access level. (This property of access control is called "Single Sign-On (SSO)".)
- Visualization & Reporting Engine: This component is used to develop analytical reports and visualizations on AVP / RCloud / RSpeed / RAPTOR.
- Collaborative Services: Collaboration services include video, text chatting, and screen sharing.
- Web Component & Widget Development Framework: This framework is used to build widgets and visual components that will be hosted on the ONAP Portal Core. It has access to services exposed by ONAP applications running in separate environments.
- Management for Internal/External Users: The administrators will import, or integrate with, internal and external users.
- Dashboards: The Portal provides customizable dashboards tailored for each user, based on their access level. Dashboards are comprised of widgets that provide summary content hosted by applications.
- Application Administration: Portal Core administrators can on-board and manage applications.
- Services Registration/Discovery: Applications can publish or discover services & APIs.
4. known system limitations
Runtime:
- For https Apps on-boarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
- For on-boarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
Language capability limitations:
- Language support for different screens
- Portal applications that do not use the portal SDK will not get multi-language support.
5. Used Models
none
6. System Deployment Architecture
Portal Consists of 5 containers:
- Portal Platform container - Actual centralized platform with dashboard showing the ONAp components like Policy, SDC, VID, AAI etc...
- Portal Database container - DB to support Portal data requirements
- Portal SampleApp container - Sample SDK based app which is good reference for other ONAP components
- Portal Widgets container - to support the required widgets
- Portal Cassandra container - used for music session management
- Portal Zookeeper container - used for music session management
- VNC portal container - to provide easy access to the deployed instance
7 References
- Portal Architectural Description: https://onap.readthedocs.io/en/latest/submodules/portal.git/docs/platform/architecture.html
- Portal APIs Specification: https://docs.onap.org/en/beijing/submodules/portal.git/docs/platform/offeredapis.html
- Portal on OOM