...
Component Status: Pending PTL Updates and ArchCom Review
Last Reviewed: 08/11/2020 (Edited by adding AAF component on 01/21/2021)
Certified by: Sunder Tattavarada
1. High Level Component Definition and Architectural Relationships
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Portal is a GUI platform that provides the ability to integrate different ONAP platform GUIs into a centralized portal.
...
- 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.
...
- 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
Portal SDK:
VID, Policy are built completely on Portal SDK platform which promotes Rapid Application Development and encapsulates Rich UI templates, Security, Logging, communication with AAF/Portal, Transaction Management, Access Management, Reporting etc - https://gerrit.onap.org/r/admin/repos/portal/sdk
2. API definitions
Portal provides the following interfaces: (to be done, add the links)
Interface Name | Interface Definition | Interface Capabilities | Protocol | Version | Status | Consumed Models | API Spec (Swagger) |
---|---|---|---|---|---|---|---|
PortalE-1 | Portal Admin Interface. | GUI to the portal administrator to:
| REST | v1 | Available | Internal | |
PortalE-2 | Application Admin Interface | GUI to the application administrator to:
| REST | v1 | Available | Internal | |
PortalE-3 | External App Interface | Platform API for application to:
| REST | v3 | Available | Link | |
PortalE-4 | Role Approval Interface | Platform API for application to:
| REST | v3 | Available | Link | |
PortalE-5 | Session Communication Interface | Platform API for application to:
| REST | v3 | Available | Link | |
PortalE-6 | Shared Context Interface | Platform API for application:
| REST | v3 | Deprecated | Link | |
PortalE-7 | Ticket Event Interface | Platform API for the application to:
| REST | v3 | Available | Link | |
PortalE-8 | Web Analytics Interface | Platform API for the application to:
| REST | v3 | Available | Link | |
PortalE-9 | External Request Interface | Platform API to:
| REST | v3 | Available | Link | |
PortalE-10 | External Access Role Interface | Platform API application to:
| REST | v3 | Available | Link |
Portal however provides multi-language support.
The multi-language support provides:
- Login user langage language settings
- Update user language settings
- Language options to user
- Ability to add/remove and query supported languages.
3. Component Description:
Add link to read.the.docs
4. known system limitations
Runtime:
...
https://docs.onap.org/projects/onap-portal/en/latest/platform/index.html
Portal SDK Documentation: https://docs.onap.org/projects/onap-portal/en/latest/tutorials/portal-sdk/index.html
4. known system limitations
...
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
noneNone
6. System Deployment Architecture
...
7 References
- Portal Architectural Description: https://docs.onap.readthedocs.ioorg/projects/onap-portal/en/latest/submodules/portal.git/docs/platform/architecture.htmlhtml#
- Portal APIs Specification: https://docs.onap.org/enprojects/beijingonap-portal/submodulesen/portal.gitlatest/docs/platform/offeredapis.htmlhtml#offeredapis
- Portal on OOM