This is a working wiki to capture the ONAP architecture component descriptions
<< Component Name >>:
STATUS: Draft
...
1 High Level Component Definition and
...
Architectural Relationships
xxxxxx provides
| Drawio | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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. xxxx API definitions
|
2. Template Component API definitions
Template Component provides the following interfaces:
| Interface Name | Interface Definition | Interface Capabilities |
|---|
| Version | Status | Consumed Models |
|---|---|---|
| xxxE-1 | External |
| Interface Definition. |
capabilities | x.y.z (according to strategy) | |||
| xxxI-2 | Internal |
| interfaces if we want to raise them | Display and update: xxxxx |
Note: xxxI interface is a CLMAP internal a 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 Template Component consumes the following Interfaces:
| Interface Name | Purpose Reason For Use | Version(s) |
|---|---|---|
| SDCE-6 | To Recieve the Control Loop Blueprint from SDCTo recieve | |
| PolicyE-2 | To create and configure the closed Loop Operational Policies | |
| DCAEE-x | Retrieve DCAE appplication status | |
| DCAEE-y | Deploy/remove DCAE application. |
3. Component Description:
A more detailed figure and description of the component.
<< For later inclusion link to project-specific description elsewhere >>
4. known system limitations
Architectural Technical Debt
Runtime: None
Clamp data redundancy is dependant on kubernetes and the persisten volume.
Clamp appliation redundancy HA reliease on kubernetes
5.
...
Clamp uses the following models:
- please fill in (and references if possible)
- << include model that you recieve from SDC >>
- << Include the model that you configure in the policy >>
6. System Deployment Architecture
Clamp consists of 4 containers:
- CLAMP container
- MariaDB container
- Kibana ontainer
- E_Search ontainer
- LogStash container
...
System Deployment Architecture
FFS
6. New Release Capabilities
<< list the new capabilities that were introduced in this release, or a hot-link to the key features. New sub-chapter per release, as per a release notes document >>
7. References
- CLAMP Overview & User Guide: https://onap.readthedocs.io/en/latest/submodules/clamp.git/docs/index.html
- CLAMP internal interfaces: https://onap.readthedocs.io/en/latest/_downloads/d3c9f924c6586fe411d40a05ad9b1bb7/swagger.pdf
...