This is a working wiki to capture the ONAP architecture component descriptions
<< Component Name >>:
...
STATUS: Draft
1 High Level Component Definition and
...
Architectural Relationships
| Drawio | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
2.
...
A more detailed figure and description of the component.
3 <<XXXX>> Target Functional Architecture
A Description of the target functional architecture
4. SDC Current Release API definitions
<< Figure to show the interfaces >>
...
Template Component API definitions
Template Component provides the following interfaces:
| Interface Name | Interface |
|---|
| Definition | Interface Capabilities | Version | Status | Consumed Models |
|---|---|---|---|---|
| xxxE-1 | External |
xxxxI-1
Internal Interface
SDCE-2
Service designer creates a service model from Design Catalog items
SDCI-2
Designer Studio stores and retrieves Design Catalog items
SDCE-3
Ops designer creates monitoring templates with mS data flows
SDCI-3
DCAE Designer Studio stores and retrieves monitoring flow with mS elements
SDCE-4
Service tester certifies service models for distribution
SDCE-5
Service tester distributes service models
SDCE-6
Distribution Engine publishes service notification to DMaaP.
ONAP components subscribe to service notification from DMaaP
SDCE-7
ONAP components retrieve service models from the Design Catalog
| 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 internal interface. xxxxE interface is a
...
external interface
The current API documents can be found at:
5. The XXX dublin view :
<< Functional Dublin View>>
6 SDC Architecture Evolution (optional item)
optional description of the SDC Architectural Evolution
7 SDC Overall ONAP Architecture Principle Compliance
8 XXXX near term focus on architecture deficincies are (optional):
<<Represenation of the architectural compliance >>
9 XXXXX - Current System Deployment Architecture
xxxxxx
...
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.
<< 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. 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