Versions Compared

Key

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

Table of Contents

Base Candidate Class 

AttributeRequiredContent
ValuesDescription
inventory_providerYString

aai

inventory_typeY

String

Cloud, Service, Vfmodule, Transport, NSSI
candidate_idYString
candidate_
id
typeYString
uniquenessYBoolean
costYString

Inventory Types

 1) Cloud

 2) Service

 3) Vfmodule

 4) Transport

 5) NSSI

All the candidate for every inventory types extend from the candidate base class.

(Should the fields in models (cloud_info, complex_info, location_info ..) come from the configuration (or) should be defined in the models itself as instance variables  (or) should the fields be derived from AAI)

Cloud object

Following are the AAI objects from which the respective candidates takes the required data:

Cloud object

EXAMPLE : https://docs.onap.org/projects/onap-optf-has/en/latest/sections/homingspecification.html

MODEL

AttributeRequiredContent
ValuesDescriptionlocation_info
cloud-regionYdict
complexY

dict

flavorsY
Object
dict

location_id, location_type

complex_infoY

Object

physical_location_id, complex_name, latitude, longitude, state, country, city, regioncloud_infoNObjectcloud_region_version, cloud_ownerother attributesObjectflavours,  sriov_automation 

Service object

...

location_id, location_type

...

Object

...

Vfmodule object

...

location_id, location_type

...

Object

...

Transport object

...

location_id, location_type

...

Object

...

sriov_automation*Nboolean


Service object

EXAMPLE : https://docs.onap.org/projects/onap-optf-has/en/latest/sections/homingspecification.html

MODEL

AttributeRequiredContent
generic-vnfYdict
vlan_info*Y

dict

cloud-regionYdict
service-instanceYdict
complexYdict
sriov_automation*Nboolean


Vfmodule object

EXAMPLE : https://docs.onap.org/projects/onap-optf-has/en/latest/sections/homingspecification.html

MODEL

AttributeRequiredContent
generic-vnfYdict
cloud-regionY

dict

vlan_info*Ydict
vserverYdict
service-instanceYdict
vf-moduleYdict
complexYdict
l-interfacesYdict
sriov_automation*Nboolean


Transport object

EXAMPLE : https://docs.onap.org/projects/onap-optf-has/en/latest/sections/homingspecification.html

MODEL

AttributeRequiredContent
service-instanceYdict
complexY

dict

zoneYdict

Design

In the data module, after fetching the data from AAI the candidate gets populated like this 

JSON Viewer
modeText
width475
height500
{
   "candidate_id":"1ac71fb8-ad43-4e16-9459-c3f372b8236d",
   "candidate_type":"service",
   "inventory_type":"service",
   "inventory_provider":"aai",
   "cost":"100",
   "cloud_region":{
      "location_id":"DLLSTX9A",
      "location_type":"azure",
      "cloud_owner":"att-aic",
      "cloud_region_version":"1.1"
   },
   "generic_vnf":{
      "host_id":"vnf_123456"
   },
   "complex":{
      "latitude":"32.897480",
      "longitude":"-97.040443",
      "city":"Dallas",
      "state":"TX",
      "country":"USA",
      "region":"US",
      "complex_name":"dalls_one",
      "physical_location_id":"DLLSTX9A"
   }
}

While returning to solver;

JSON Viewer
modeText
width475
height400
{
    "candidate_id": "1ac71fb8-ad43-4e16-9459-c3f372b8236d",
    "candidate_type": "service",
    "inventory_type": "service",
    "inventory_provider": "aai",
    "host_id": "vnf_123456",
    "cost": "100",
    "location_id": "DLLSTX9A",
    "location_type": "azure",
    "latitude": "32.897480",
    "longitude": "-97.040443",
    "city": "Dallas",
    "state": "TX",
    "country": "USA",
    "region": "US",
    "complex_name": "dalls_one",
    "cloud_owner": "att-aic",
    "cloud_region_version": "1.1",
    "physical_location_id": "DLLSTX9A"
}

...

NSSI object

...