1. High Level Component Definition and Architectural Relationships (template)
2. Component API definitions
VID Interacts with the following components
Interface Name | Purpose Reason For Use | Version(s) |
---|---|---|
SO | Interface to Service Orchestrator (SO) for various Operations - for example orchestrating a new VNF. | |
SDC | Interface to Service Design Catalog (SDC) for getting Service Model | |
A&AI | Interface to Active & Available Inventory (A&AI) for managing Service Instances - For example for Change Management. | |
Offered APIs
Entity | Method | Path Info | Description |
---|---|---|---|
Health Check | GET | /healthCheck | The Health Status of the application checks the DB connection. |
Used by IDNS for redundancy return response entity: Expected: { "statusCode": 200, "detailedMsg": "health check succeeded", "date": current date } | |||
Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of the application checks the DB connection |
return response entity: Expected: { "statusCode": 200, "detailedMsg": "health check succeeded", "date": current date } | |||
Commit Version | GET | /commitInfo | Displays info about the last commit of the running build |
return response entity: Expected: { "commitId": id of the last commit "commitMessageShort": short message of the last commit "commitTime": time of the last commit } |
Maintenance APIs
Maintenance: Category Parameters | POST | /maintenance/category_parameter/{categoryName} | Populate VID Project/Owning entity/Line of Business/Platform drop downs |
POST body: { "options": [ <list of strings> ] } |
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