1. ONAP OF - Homing API
Date Aug 21, 2017

2. OF-HAS: API Dependencies
VF-C SO
APP-C
Potential Dependencies
Existing/current Dependencies
OF-HAS
DCAE
A&AI
SDNC
SDC
Policy Framework
MultiCloud

3. API - Incoming Dependency
API this release is expecting from other releases.
API Name
API Description
API Definition Date
API Delivery date
API Definition link (i.e.swagger)
A&AI
API to pull cloud sites and existing service instance locations.
SDNC
API to check capacity of existing service instances, and sites.
MULTICLOUD
VIM Management- resource consumption
Tenant Management - List tenants, Get Limits of tenant VM Lifecycle management - List VM
Flavor Management - List flavor
VIM type - List all supported VIM/Cloud type and version
POLICY FRAMEWORK
Policy Query API – retrieve homing policies for the service components during runtime.
DCAE
SDC

4. For example, API calls to A&AI
GET /api/aai-cloudInfrastructure/v1/cloud-regions
GET /api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}
GET /api/aai-vnfm/v1/vnfms
GET /api/aai-vnfm/v1/vnfms/vnfm/{vnfmId}

5. API - Outgoing Dependency
API this release is delivering to other releases.
API Name
API Description
API Definition Date
API Delivery date
API Definition link (i.e.swagger) SO
API to get a homing solution given an input of decomposed service components (or demands), and the runtime order parameters that will assist in the homing decision.
APP-C
VF-C

6. Required inputs for homing
Runtime parameters: 
  # Required Bandwidth
  # Service ID
  # Customer's preferred location
Constraints:
# vDNS must be within 100 km of the customer
# vFW can be deployed on an existing instance only if it has enough capacity. The constraint will call the capacity check API in SDN-C
# The vDNS and vFW must be deployed in the same country
 # For each VNF
  - inventories from which potential candidates can be fetched: aai, multicloud
  - What types of candidates to fetch: Existing instances, new cloud sites where a new instance could be spun up
- attributes by which to select initial candidates:
Opaque dictionary of key,value pairs
     service_type: VFW
     customer_id: customer_12345
version: x.y
optimization:
# Minimize the distance between customer's preferred location and vDNS, and place the vDNS as close as possible to vFW
minimize {w1 * distance_between [vdns, vfw] + w2 * distance_between [customer_pref_loc, vdns]}

7. Sample homing policies for vFW and vDNS
Runtime parameters: 
  # Required Bandwidth
  BANDWIDTH: 10
  UNIT: Mbps
  # Service ID
  SERVICE_ID: abc123
locations:
  # Customer's preferred location
  customer_pref_loc: {"latitude": " ", "longitude": " "}
Constraints:
 # vDNS must be within 100 km of the customer
  constraint_vdns_customer:    
    type: distance_to_location
    demands: [vdns]
    properties:
      distance: < 100 km
      location: customer_pref_loc
# The vDNS and vFW must be deployed in the same country
  colocation:
    type: zone
    demands: [vdns, vfw]
    properties:
      qualifier: same
      category: country
 demands: # vFW and vDNS
 vfw:
  - inventory_provider: aai
    inventory_type: service
attributes:[
     service_type: VFW
     customer_id: customer_12345]
- inventory_provider: aai, multicloud
    inventory_type: cloud
  vdns:
  - inventory_provider: aai
attributes: [
     customer_id: customer_12345] 
# vFW can be deployed on an existing instance only if it has enough capacity. The constraint will call the capacity check API in SDN-C
  check_vfw_instances:
    type: instance_capacity
    demands: [vfw]
    properties:
      controller: SDNC
      request:
        entity-type: service-instance
        entity-id: {SERVICE_ID}
        required-bw: {BANDWIDTH}
        bw-unit: {UNIT}
        vnf-type: VFW
optimization:
  # Minimize the distances between customer's preferred location and vDNS.
  minimize:
    sum:
    - product:
      - 1 # weight
      - {distance_between : [vdns,vfw]}
      - 1 # weight
      - {distance_between: [customer_pref_loc, vdns]}