STATUS: DraftProject approved, ArchCom Approved
Portal:
1 High Level Component Definition and
...
Architectural Relationships
| draw.io Diagram | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Portel is as common capability used by other components, hence not a architectural functional entitiy in itself.
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 capabitilities capabilities in a centralised centralized way
- Provides common capablities capabilities such as application onboarding 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...... Others?
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 does not in itself provide APIs to other ONAP components, the Portal users do.provides the following interfaces: (to be done, add the links)
Interface Name | Interface Definition | Interface Capabilities | Version | Status | Consumed Models |
|---|---|---|---|---|---|
| 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 Clamp however provides multi-language support.
The multilanguage multi-language support provides:
- Login user langage settinssettings
- Update user langage 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.
<< For later inclusion >>
Add link to read.the.docs
4. known system limitations
Runtime: none
- 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:
...
6. System Deployment Architecture
...
FFS.
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