You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

1. High Level Component Definition and Architectural Relationships (template)



VID (Virtual Infrastructure Deployment) is a UI interface that allows the operations and network infrastructure engineers to orchestrate and change configurations related to the infrastructure expansion and maintenance.

Following is a high level orchestration component diagram that allows to show a compartmentalized view of internal VID components and shows systems that it interacts with


2. Component API definitions

VID Interacts with the following components

Interface Name

Purpose Reason For Use

Version(s)
SOInterface to Service Orchestrator (SO) for various Operations - for example orchestrating a new VNF.
SDCInterface to Service Design Catalog (SDC) for getting Service Model
A&AIInterface to Active & Available Inventory (A&AI) for managing Service Instances - For example for Change Management.



Offered APIs

EntityMethodPath InfoDescription
Health CheckGET/healthCheckThe Health Status of the application checks the DB connection.



Used by IDNS for redundancy

return response entity:
- statusCode Either 200 or 500
- detailedMsg of the result, in case of failure particular error message

Expected:

{
  "statusCode": 200,
  "detailedMsg": "health check succeeded",
  "date": current date
}
Health CheckGETrest/healthCheck/{User-Agent}/{X-ECOMP-RequestID}The Health Status of the application checks the DB connection



return response entity:
- statusCode Either 200 or 500
- detailedMsg of the result, in case of failure particular error message
- date string indicating the current date & time

Expected:

{
  "statusCode": 200,
  "detailedMsg": "health check succeeded",
  "date": current date
}
Commit VersionGET/commitInfoDisplays info about the last commit of the running build



return response entity:
- commitId full id of the commit
- commitMessageShort short message from the commit
- commitTime time of the commit

Expected:

{
  "commitId": id of the last commit
  "commitMessageShort": short message of the last commit
  "commitTime": time of the last commit
}

Maintenance APIs

Maintenance: Category ParametersPOST/maintenance/category_parameter/{categoryName}Populate VID Project/Owning entity/Line of Business/Platform drop downs



{categoryName} is one of lineOfBusiness, platform, project, owningEntity.

POST body:

{
  "options": [ <list of strings> ]
}

Next  Previous

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

  1.  CLAMP Overview & User Guide: https://onap.readthedocs.io/en/latest/submodules/clamp.git/docs/index.html 
  2. CLAMP internal interfaces:  https://onap.readthedocs.io/en/latest/_downloads/d3c9f924c6586fe411d40a05ad9b1bb7/swagger.pdf 




  • No labels