Versions Compared

Key

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

...

Gliffy
size1200
namevCPEPoliciesAndInformationSources
pagePin18


Homing Workflow

...


SO - HAS API (R) - before retrieving homing policies

Code Block
languagetext
titleSO - HAS API (R)
collapsetrue
requestInfo:

...


  callbackUrl: https://so:5000/callback
  numSolutions: 1
  optimizer:
  - placement
  requestId: yyy-yyy-yyyy
  sourceId: so
  timeout: 600
  transactionId: xxx-xxx-xxxx
  requestType: new
placementInfo:
  orderInfo:
    requestParameters:
      customerLatitude: 32.897480
      customerLongitude: -97.040443
      customerName: some_company
  demandInfo:
    placementDemands:
    - resourceName: vGMuxInfra
      resourceId: some_resource_id
      tenantId: some_tenant_id
      resourceModelInfo:
        modelId: vGMux_model_id
        modelName: ''
        modelType: allotted
        modelVersion: '2.0'
      existingPlacement:
        serviceInstanceId: 87257b49-9602-4ca1-9817-094e52bc873b
      excludedCandidates:
      - candidateType: service
        candidates:
        - serviceInstanceId: 1ac71fb8-ad43-4e16-9459-c3f372b8236d

...


      requiredCandidates:
      - candidateType: service 

...


        candidates:
        - serviceInstanceId: 7e6c3e57-62cd-44f6-aa88-d0896998f7ec

...


    - resourceName: vG
      tenantId: some_tenant_id
      resourceId: 71d563e8-e714-4393-8f99-cc480144a05e
      resourceModelInfo:
        modelId: vG_model_id
        modelName: ''
        modelType: dedicated
        modelVersion: '2.0'
      existingPlacement:
        serviceInstanceId: 21d5f3e8-e714-4383-8f99-cc480144505a
      excludedCandidates:
      - candidateType: service
        candidates:
        - serviceInstanceId: 1ac71fb8-ad43-4e16-9459-c3f372b8236d

...


      requiredCandidates:
      - candidateType: cloud
        candidates:
        - cloud-region-id: TXAUS219

...



  otherInfo:
    serviceInstanceId: d61b2543-5914-4b8f-8e81-81e38575b8ec
  serviceModelInfo:
    serviceName: Residential vCPE
    service_id: vcpe_service_id
    serviceType: service
    serviceVersion: '1.0'


HAS Homing Specification (R') - after retrieving and translating homing policies

Code Block
languagejs
titlevCPE Homing Template (JSON)
collapsetrue
{
  "homing_template_version": "2017-10-10",
  "parameters": {
    "service_name": "Residential vCPE",
    "service_id": "vcpe_service_id",
    "customer_lat": 32.89748,
    "customer_long": -97.040443,
    "REQUIRED_MEM": 4,
    "REQUIRED_DISK": 100,
 
  "pnf_id": "some_pnf_id"
  },
  "locations": {
    "customer_loc": {
      "latitude": {
        "get_param": "customer_lat"
      },
      "longitude": {
        "get_param": "customer_long"
      }
    },
  },
  "brg_locdemands": {
 
    "pnf_host_namevGMuxInfra": [
      {
        "getinventory_paramprovider": "pnf_idaai",
      }
   "inventory_type": "service",
  }   },
  "demands": {
    "vGMuxInfra": [
      {         "inventory_provider": "aai",
        "inventory_type": "service",
        "attributes": {
          "equipment_type": "vG_Mux",
          "customer_id": "some_company"
        },
        "excluded_candidates": [
          {
            "candidate_id": "1ac71fb8-ad43-4e16-9459-c3f372b8236d"
          }
        ],
        "existing_placement": [
          {
            "candidate_id": "21d5f3e8-e714-4383-8f99-cc480144505a"
          }
        ]
      }
    ],
    "vG": [
      {
        "inventory_provider": "aai",
        "inventory_type": "cloud"
      }
    ]
  },
  "constraints": [
    {
      "constraint_vgmux_customer": {
        "type": "distance_to_location",
 
      "demands": [

         "vGMuxInfra"
        ],
 
      "properties": {

         "distance": "< 100 km",
 
        "location": "customer_loc"
 
      }

     },
    },
    {
      "colocation": {

       "type": "zone",
        "demands": [
          "vGMuxInfra",
 
        "vG"

       ],
 
      "properties": {
 
        "qualifier": "same",
          "category": "region"
        }
      }
    },

   {       "hpa_constraint": {

       "type": "hpa",
        "demands": [
 
        "vG"
        ],
        "properties": {
          "evaluate": [
 
          {
 
            "labelflavorLabel": "flavor_label_1",

             "featuresflavorProperties": [
                {
 
                "hpa-feature": "basicCapabilities",

                 "hpa-version": "v1",
                  "architecture": "generic",
 
                "hpa-feature-attributes": [
                    {
                      "hpa-attribute-key": "numVirtualCpu",
                      "hpa-attribute-value": "4",
 
                    "operator": "="
                    },
                    {
 
                    "hpa-attribute-key": "virtualMemSize",
 
                    "hpa-attribute-value": "4",

                     "operator": "=",
 
                    "unit": "GB"
                    }
                  ]

               },
                {
                  "hpa-feature": "numa",
 
                "hpa-version": "v1",

                 "architecture": "generic",
 
                "hpa-feature-attributes": [
 
                  {
                      "hpa-attribute-key": "numaNodes",
                      "hpa-attribute-value": "2",
                      "operator": "="
 
                  },
 
                  {
 
                    "hpa-attribute-key": "numaCpu-0",

                     "hpa-attribute-value": "2",
                      "operator": "="
                    },
 
                  {

                     "hpa-attribute-key": "numaCpu-1",
 
                    "hpa-attribute-value": "4",
 
                    "operator": "="
                    },
                    {
                      "hpa-attribute-key": "numaMem-0",
 
                    "hpa-attribute-value": "2",
                      "operator": "=",
                      "unit": "GB"

                   },
                    {
                      "hpa-attribute-key": "numaMem-1",
 
                    "hpa-attribute-value": "4",

                     "operator": "=",
 
                    "unit": "GB"
 
                  }
                  ]
                },
                {
 
                "hpa-feature": "cpuPinning",
                  "hpa-version": "v1",
                  "architecture": "generic",

                 "hpa-feature-attributes": [
                    {
                      "hpa-attribute-key": "logicalCpuThreadPinningPolicy",
 
                    "hpa-attribute-value": "prefer",

                     "operator": "="
                    },
 
                  {

                     "hpa-attribute-key": "logicalCpuPinningPolicy",
 
                    "hpa-attribute-value": "dedicated",
 
                    "operator": "="
                  }
 }               ]
   ]
                }
              ]
 
          },
 
          {
 
            "labelflavorLabel": "flavor_label_2",
              "featuresflavorProperties": [
 
              {

                 "hpa-feature": "basicCapabilities",
 
                "hpa-version": "v1",
 
                "architecture": "generic",
                  "hpa-feature-attributes": [
                    {
                      "hpa-attribute-key": "numVirtualCpu",
 
                    "hpa-attribute-value": "8",
 
                    "operator": "="
 
                  },

                   {
                      "hpa-attribute-key": "virtualMemSize",
                      "hpa-attribute-value": "16",
 
                    "operator": "=",

                     "unit": "GB"
                    }
 
                ]
                },
                {
                  "hpa-feature": "numa",
 
                "hpa-version": "v1",
 
                "architecture": "generic",
 
                "hpa-feature-attributes": [

                   {
                      "hpa-attribute-key": "numaNodes",
                      "hpa-attribute-value": "2",
 
                    "operator": "="

                   },
                    {
 
                    "hpa-attribute-key": "numaCpu-0",
                      "hpa-attribute-value": "2",
                      "operator": "="
                    },
 
                  {
                      "hpa-attribute-key": "numaCpu-1",
                      "hpa-attribute-value": "4",
 
                    "operator": "="
 
                  },

                   {
 
                    "hpa-attribute-key": "numaMem-0",
                      "hpa-attribute-value": "2",
                      "operator": "=",

                     "unit": "GB"
                    },
                    {
 
                    "hpa-attribute-key": "numaMem-1",

                     "hpa-attribute-value": "4",
 
                    "operator": "=",
 
                    "unit": "GB"
                    }
                  ]
                },
 
              {
 
                "hpa-feature": "memoryPageSize",
 
                "hpa-version": "v1",

                 "architecture": "generic",
                  "hpa-feature-attributes": [
                    {
 
                    "hpa-attribute-key": "memoryPageSize",

                     "hpa-attribute-value": "2",
 
                    "operator": "=",
 
                    "unit": "GB"
                    }
                  ]
                }
 
            ]
            }
          ]

       }
      }
    },
   
{       "check_cloud_min_guaranteecapacity": {
        "type": "attributevim_fit",
        "demands": [
 
        "vG"

       ],
        "properties": {
 
        "evaluatecontroller": {"multicloud",
         "request": {
          "cpu_min_guaranteevCPU": true10,
 
          "mem_min_guaranteeMemory": true{
            "quantity": }{
        }       }"get_param": "REQUIRED_MEM"
     },     {  },
    "check_cloud_capacity": null,       "typeunit": "vim_fit",GB"
          "demands": [},
          "vGStorage": {
     ],       "propertiesquantity": {
             "vim-controller "get_param": "multicloud",REQUIRED_DISK"
            },
"request": {           "vCPUunit": "GB"
 10,         }
 "mem": {      }
      "quantity":}
{    }
  },
  "optimization": {
    "get_paramminimize": "REQUIRED_MEM"{
      "sum": [
      },  {
          "unitdistance_between": "GB"[
            }"customer_loc",
            "diskvGMuxInfra":
{          ]
  "quantity": {     },
        {
  "get_param        "distance_between": "REQUIRED_DISK"[
            }"customer_loc",
            "unitvG":
"GB"           }]
        }
      }]
    }
  ],}
}

"optimization":
{
    "minimize": {
      "sum": [
        {
          "distance_between": [
    
Code Block
languagetext
titlevCPE Homing Template (YAML)
collapsetrue
---
homing_template_version: '2017-10-10'
parameters:
  service_name: Residential vCPE
  service_id: vcpe_service_id
  customer_lat: 32.89748
  customer_long: -97.040443
  REQUIRED_MEM: 4
  REQUIRED_DISK: 100
locations:
  customer_loc:
    latitude:
      get_param: "customer_loc",lat
    longitude:
       "vGMuxInfra"
get_param: customer_long
demands:
  vGMuxInfra:
  - inventory_provider: aai
 ]   inventory_type: service
    },attributes:
      equipment_type: vG_Mux
 {     customer_id: some_company
    "distanceexcluded_between"candidates:
[    - candidate_id: 1ac71fb8-ad43-4e16-9459-c3f372b8236d
      "customer_loc",
            "vG"
          ]
        }
      ]
    }
  }
}


Code Block
languagetext
titlevCPE Homing Template (YAML)
collapsetrue
---
homing_template_version: '2017-10-10'
parameters:
  service_name: Residential vCPE
  service_id: vcpe_service_id
  customer_lat: 32.89748
  customer_long: -97.040443
  REQUIRED_MEM: 4
  REQUIRED_DISK: 100
  pnf_id: some_pnf_id
locations:
  customer_locexisting_placement:
    - candidate_id: 21d5f3e8-e714-4383-8f99-cc480144505a
  vG:
  - inventory_provider: aai
    inventory_type: cloud
constraints:
  constraint_vgmux_customer:
    type: distance_to_location
    demands:
    latitude:- vGMuxInfra
    properties:
get_param: customer_lat     longitudedistance: "< 100 km"
    get_param  location: customer_longloc
  brg_loccolocation:
    pnf_host_nametype: zone
    demands:
get_param: pnf_id demands:  - vGMuxInfra:
    - inventory_provider: aaivG
    properties:
      inventory_typequalifier: service
same
   attributes:   category: region
  equipmenthpa_typeconstraint:
vG_Mux       customer_idtype: some_companyhpa
    excluded_candidatesdemands:
    - candidate_id: 1ac71fb8-ad43-4e16-9459-c3f372b8236dvG
    existing_placementproperties:
    -  candidate_idevaluate:
21d5f3e8-e714-4383-8f99-cc480144505a   vG:   - inventory_provider: aai flavorLabel: flavor_label_1
        inventory_typeflavorProperties:
cloud  constraints: - constraint_vgmux_customer:    - typehpa-feature: basicCapabilities
distance_to_location     demands:     hpa-version: vGMuxInfrav1
    properties:       distancearchitecture: "<generic
100 km"       location: customer_loc hpa-feature-attributes:
colocation:     type: zone    - demands:hpa-attribute-key: numVirtualCpu
    -   vGMuxInfra     hpa-attribute- vGvalue: '4'
     properties:       qualifieroperator: "="
 same       category: region - hpa_constraint-attribute-key: virtualMemSize
   type: hpa     demands:   hpa-attribute-value: '4'
- vG     properties:       evaluateoperator:    "="
  - label: flavor_label_1        unit: features:GB
        - hpa-feature: basicCapabilitiesnuma
          hpa-version: v1
          architecture: generic
          hpa-feature-attributes:
          - hpa-attribute-key: numVirtualCpunumaNodes
            hpa-attribute-value: '42'
            operator: "="
          - hpa-attribute-key: virtualMemSizenumaCpu-0
            hpa-attribute-value: '42'
            operator: "="
            unit: GB
        - hpa-feature: numa- hpa-attribute-key: numaCpu-1
            hpa-versionattribute-value: v1'4'
            architectureoperator: "="
generic          - hpa-featureattribute-attributeskey: numaMem-0
          -  hpa-attribute-keyvalue: numaNodes'2'
            hpa-attribute-valueoperator: '2'"="
            operatorunit: "="GB
          - hpa-attribute-key: numaCpunumaMem-01
            hpa-attribute-value: '24'
            operator: "="
            unit: GB
        - hpa-attribute-keyfeature: numaCpu-1cpuPinning
            hpa-attribute-valueversion: '4'v1
            operatorarchitecture: "="generic
          - hpa-attributefeature-keyattributes:
numaMem-0          -   hpa-attribute-valuekey: '2'logicalCpuThreadPinningPolicy
            operatorhpa-attribute-value: "="prefer
            unitoperator: GB"="
          - hpa-attribute-key: numaMem-1logicalCpuPinningPolicy
            hpa-attribute-value: '4'dedicated
            operator: "="
      - flavorLabel: flavor_label_2
         unitflavorProperties:
GB         - hpa-feature: cpuPinningbasicCapabilities
          hpa-version: v1
          architecture: generic
          hpa-feature-attributes:
          - hpa-attribute-key: logicalCpuThreadPinningPolicynumVirtualCpu
            hpa-attribute-value: prefer'8'
            operator: "="
          - hpa-attribute-key: logicalCpuPinningPolicyvirtualMemSize
            hpa-attribute-value: dedicated'16'
            operator: "="
      - label: flavor_label_2         featuresunit: GB
        - hpa-feature: basicCapabilitiesnuma
          hpa-version: v1
          architecture: generic
          hpa-feature-attributes:
          - hpa-attribute-key: numVirtualCpu
            hpa-attribute-value: '8'
            operator: "="
          - hpa-attribute-key: virtualMemSizenumaNodes
            hpa-attribute-value: '162'
            operator: "="
            unit: GB
        - hpa-feature: numa- hpa-attribute-key: numaCpu-0
            hpa-attribute-versionvalue: v1'2'
          architecture: generic operator: "="
        hpa-feature-attributes:
          - hpa-attribute-key: numaNodesnumaCpu-1
            hpa-attribute-value: '24'
            operator: "="
          - hpa-attribute-key: numaCpunumaMem-0
            hpa-attribute-value: '2'
            operator: "="
            unit: GB
          - hpa-attribute-key: numaCpunumaMem-1
            hpa-attribute-value: '4'
            operator: "="
          - hpa-attribute-key: numaMem-0
   unit: GB
        - hpa-feature: memoryPageSize
          hpa-attribute-valueversion: '2'v1
            operatorarchitecture: "="generic
            unithpa-feature-attributes:
GB           - hpa-attribute-key: numaMem-1memoryPageSize
            hpa-attribute-value: '42'
            operator: "="
            unit: GB
  check_cloud_capacity: 
    - hpa-featuretype: memoryPageSizevim_fit
    demands:
    - hpa-version:vG
v1    properties:
      architecturecontroller: genericmulticloud
          hpa-feature-attributesrequest:
          - hpa-attribute-keyvCPU: memoryPageSize10
         Memory:
  hpa-attribute-value: '2'        quantity:
       operator: "="    get_param: REQUIRED_MEM
       unit: GB - cloud_min_guaranteeunit: GB
   type: attribute     demandsStorage:
    - vG     propertiesquantity:
      evaluate:      get_param: REQUIRED_DISK
  cpu_min_guarantee: true       unit: GB
mem_min_guaranteeoptimization:
true - check_cloud_capacityminimize:
     typesum:
vim_fit    - demandsdistance_between:
      - customer_loc
vG      properties:- vGMuxInfra
    - controllerdistance_between: multicloud
      request:- customer_loc
      - vCPU:vG
10



HAS Homing Response

State - Done

Code Block
languagejs
titlevCPE homing response (JSON)
collapsetrue
{
  "plans": [
Memory:    {
      quantity"status": "done",
      "id": "plan_id",
   get_param: REQUIRED_MEM  "name": "Plan Name 1",
     unit "links": GB[
        Storage:[
          quantity:{
            get_param: REQUIRED_DISK"href": "http://conductor:8091/v1/plans/plan_id",
          unit: GB optimization"rel": "self"
 minimize:     sum:    }
- distance_between:       -]
customer_loc      ],
- vGMuxInfra     - distance_between:"recommendations": [
       - customer_loc{
      - vG

HAS Homing Response

State - Done: 

Code Block
languagejs
titlevCPE homing response (JSON)
collapsetrue
{   "plansvG": {
[     {       "statusinventory_provider": "solvedaai",
      "id      "candidate": "plan_id",
 {
    "name": "Plan Name 1",       "linkscandidate_id": ["DLLSTX1A",
        [         "cloud_owner": "CloudOwner1",
 {             "hrefinventory_type": "http://conductor:8091/v1/plans/plan_idcloud",
              "rellocation_id": "selfDLLSTX1A",
          }    "location_type": "openstack-cloud"
    ]        ]},
       "recommendations": [    "attributes": {
   {           "vGflavors": {
                "inventoryflavor_label_provider1": "aaivim_flavor_X",
            "candidate    "flavor_label_2": {"vim_flavor_Y"
              "candidate_id": "DLLSTX1A"},
              "cloud_owner": "CloudOwner1",
              "inventory_typephysical-location-id": "cloudDLLSTX1A",
              "location_cloud_version": "3.0",
			  "vim-id": "CloudOwner1_DLLSTX1A",
            }
     "location_type": "openstack-cloud"    }
        },
        {
          "attributesvGMuxInfra": {
              "flavorsattributes": {
                "flavorhost_label_1id": "vimvgmux_flavorhost_Xname",
 
              "flavorcloud_label_2owner": "vim_flavor_YCloudOwner1",
              }"physical-location-id": "DLLSTX1A",
              "cloudservice_instance_ownerid": "CloudOwner121d5f3e8-e714-4383-8f99-cc480144505a",
              "physical-location-idcloud_version": "DLLSTX1A3.0",
            			  "cloud_versionvim-id": "3.0CloudOwner1_DLLSTX1A"
            },
          }  "inventory_provider": "aai",
      },      "service_resource_id": "12345",
 {           "vGMuxInfracandidate": {
              "attributesis_rehome": {"false",
              "hostlocation_id": "vgmux_host_nameDLLSTX1A",
              "cloudinventory_ownertype": "CloudOwner1service",
              "physical-location-candidate_id": "DLLSTX1A21d5f3e8-e714-4383-8f99-cc480144505a",
              "service_instancehost_id": "21d5f3e8-e714-4383-8f99-cc480144505avgmux_host_name",
              "cloud_versionowner": "3.0CloudOwner1",
            },  "location_type": "openstack-cloud"
         "inventory_provider": "aai",  }
          "service_resource_id": "12345",}
        }
    "candidate": { ]
    }
  ]
}


State - Error 

Code Block
languagejs
titleHAS Error Response
collapsetrue
{
  "is_rehomeplans": "false",[
      {
       "location_idstatus": "DLLSTX1Aerror",
       
      "inventory_typemessage": "serviceSome error message",
      "name": "Plan Name 1",
      "candidate_idlinks": "21d5f3e8-e714-4383-8f99-cc480144505a", [
        [
       "host_id": "vgmux_host_name",  {
            "cloud_ownerhref": "CloudOwner1http://conductor:8091/v1/plans/plan_id",
              "location_typerel": "openstack-cloudself"

           }
        ]
 }     ],
   }       ]"id": "plan_id"
     }
  ]
}


State -

...

Template 

Code Block
languagejs
titleHAS Error ResponsePlan in Template State
collapsetrue
{
  "plans": [
    {
      "status": "errortemplate",
   
  "message": "Some error message",
      "name": "Plan Name 1",
  
   "links": [
   
    [
          {
            "href": "http://conductor:8091/v1/plans/plan_id",
            "rel": "self"
          }   "rel": "self"
    ]  }
    ],
   ],
  "id": "plan_id"
  
 }


]
}


State -

...

Solving

Code Block
languagejs
titleHAS Plan in Template StateSolving state
collapsetrue
{
  "plans": [
    {
      "status": "templatesolving",
      "name": "Plan Name 1",
      "links": [
        [
          {
            "href": "http://conductor:8091/v1/plans/plan_id",
            "rel": "self"
          }
        ]
      ],
      "id": "plan_id"
    }
  ]
}