ARC VID Component Description - Guilin (R7) Release
- Chaker Al-Hakim
- Ikram Ikramullah
Page Status: Copied from R6 - Mar, 22, 2020
Component Status: Pending PTL Updates and ArchCom Review
Last Reviewed on: August 18, 2020
Certified by: @Ikram Ikramullah (ikram@att.com)
1. High Level Component Definition and Architectural Relationships
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) |
|---|---|---|
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. | |
Consumed APIs
https://docs.onap.org/en/elalto/submodules/vid.git/docs/consumedapis.html
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:
4. Known System limitations
Non known.
5. System Deployment Architecture
6. New Release Capabilities
Pause on VF Module Failures.
Pause on VF Module Success.
Pause Markups additions from inside VF Module Edit popup.
Ability to remove Pause points after being added.
VF Module Sequencing in the Drawing Board.