STATUS: DraftProject approved, ArchCom Approved
Portal:
1 High Level Component Definition and
...
Architectural Relationships
| draw.io Diagram | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Portal is a GUI platform that The clamp functional entity provides the capability to manage runtime control loops. It provides the capaiblity to
- configure DCAE applications of the control loop
- Associate policies to the DCAE application
- Configure the oprations to be taken by the cotnrol loop (by creating/updating/deleting operational policies)
- Deploy/un-deploy control loop flow (blueprints) to DCAE
- Control loop visulization.
Clamp Relise on Policy to communite to App-C/VF-C/SDN-C/SO in runtime, hence these are not part of CLAMP
2. CLAMP API definitions
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)CLAMP provides the following interfaces:
Interface Name | Interface Definition | Interface Capabilities |
|---|
| Version | Status | Consumed Models | |
|---|---|---|---|
| PortalE-1 |
| Portal Admin Interface. |
- Selecting the control loop flow
- entering configuration policy paramaters
- entering operational policy parameters
- Managing lifecycle of DCAE conrol flow blueprint
Display and update:
xxxxx
Note: xxxI interface is a CLMAP internal interface. xxxxE interface is a SDCE external interface
The current API documents can be found at:
The provided UI interfaces are found at: CLAMP latest user guide
- CLAMP internal APIs can be found: clamp swagger pdf
CLAMP consumes the following Interfaces:
...
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:
Add link to read.the.docs
3. Component Description:
A more detailed figure and description of the component.
<< For later inclusion >>
4. known system limitations
Runtime: None
Clamp data redundancy is dependant on kubernetes and the persisten volume.
Clamp appliation redundancy HA reliease on kubernetes
5. Used Models
Clamp uses the following models:
...
- 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
Clamp consists of 4 containers:
- CLAMP container
- MariaDB container
- Kibana ontainer
- E_Search ontainer
- LogStash container
...
7. References
...
FFS.
7 References
- Portal Architectural Description: https://onap.readthedocs.io/en/latest/submodules/
...
...
...
- Portal APIs Specification: https://docs.onap.
...
...
...