Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Status: Updated for

...

Montreal -

...

 
Component Status:

...

Approved

Last Reviewed on:

Certified by:


1. High Level Component Definition and Architectural Relationships - Deprecated

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.

...

Drawio
bordertrue
diagramNamevid_r11r13
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth851
revision12


2. Component API definitions

VID Interacts with the following components

Interface Name

Purpose Reason For Use

Version(s)API Spec (swagger)
SOInterface to Service Orchestrator (SO) for various Operations - for example orchestrating a new VNF.
SO API
SDCInterface to Service Design Catalog (SDC) for getting Service Model

SDC API,

https://docs.onap.org/projects/onap-sdc/en/latest/offeredapis.html

A&AIInterface to Active & Available Inventory (A&AI) for managing Service Instances - For example for Change Management.
AAI REST API Documentation - Honolulu




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:

Image Modified

4. Known System limitations

Non known.

5. System Deployment Architecture


6. New Release Capabilities

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyREQ-430

7. References

  1. https://docs.onap.org/en/elalto/submodules/vid.git/docs/consumedapis.html
  2. VID R4 M3 Architecture Review

...