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"
  existing_placement:
       ]
        }
      ]
    }
  }
}


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_loc- 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     longitude:distance: "< 100 km"
      get_paramlocation: customer_longloc
  brg_loccolocation:
    pnf_host_nametype: zone
    demands:
get_param: pnf_id demands:  - vGMuxInfra:
    - inventory_provider:vG
aai    properties:
inventory_type: service     attributesqualifier: same
     equipment_type category: vG_Muxregion
  hpa_constraint:
    customer_idtype: some_companyhpa
    excluded_candidatesdemands:
    - candidate_id: 1ac71fb8-ad43-4e16-9459-c3f372b8236d vG
    properties:
      existing_placementevaluate:
      - candidate_id: 21d5f3e8-e714-4383-8f99-cc480144505a flavorLabel: flavor_label_1
    vG:   - inventory_providerflavorProperties:
aai     inventory_type: cloud constraints: - constraint_vgmux_customerhpa-feature: basicCapabilities
   type: distance_to_location       demandshpa-version: v1
   -  vGMuxInfra     propertiesarchitecture: generic
      distance: "< 100 km"
 hpa-feature-attributes:
     location: customer_loc - colocation:     type- hpa-attribute-key: zonenumVirtualCpu
    demands:     - vGMuxInfra  hpa-attribute-value: '4'
 - vG     properties:     operator: "="
qualifier: same       category: region - hpa_constraint-attribute-key: virtualMemSize
   type: hpa     demands:   hpa-attribute-value: '4'
- vG     properties:       evaluateoperator: "="
     - label: flavor_label_1     unit: GB
  features:         - hpa-feature: basicCapabilitiesnuma
          hpa-version: v1
          architecture: generic
          hpa-feature-attributes:
          - hpa-attribute-key: numVirtualCpunumaNodes
            hpa-attribute-value: '42'
            operator: "="
          - hpa-attribute-key: virtualMemSize numaCpu-0
            hpa-attribute-value: '42'
            operator: "="
            unit: GB
        - hpa-feature: numa- hpa-attribute-key: numaCpu-1
            hpa-version: v1attribute-value: '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-1
 cpuPinning
          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
   unit     flavorProperties:
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        unit: features:GB
        - hpa-feature: basicCapabilitiesnuma
          hpa-version: v1
          architecture: generic
          hpa-feature-attributes:
          - hpa-attribute-key: numVirtualCpunumaNodes
            hpa-attribute-value: '82'
            operator: "="
          - hpa-attribute-key: virtualMemSizenumaCpu-0
            hpa-attribute-value: '162'
            operator: "="
          - hpa-attribute-key: numaCpu-1
           unit: GB hpa-attribute-value: '4'
            operator: "="
          - hpa-attribute-featurekey: numanumaMem-0
            hpa-version: v1attribute-value: '2'
            operator: "="
architecture: generic           hpa-feature-attributes:unit: GB
          - hpa-attribute-key: numaNodesnumaMem-1
            hpa-attribute-value: '24'
            operator: "="
            unit: GB
        - hpa-attribute-keyfeature: numaCpu-0memoryPageSize
            hpa-attribute-valueversion: '2'
  v1
          architecture: generic
          operatorhpa-feature-attributes:
"="
          - hpa-attribute-key: numaCpu-1memoryPageSize
            hpa-attribute-value: '42'
            operator: "="
            unit: GB
  check_cloud_capacity: 
    - hpa-attribute-keytype: numaMem-0vim_fit
    demands:
       hpa-attribute-value: '2' vG
    properties:
       operatorcontroller: "="multicloud
      request:
     unit: GB  vCPU: 10
       - hpa-attribute-keyMemory:
numaMem-1          quantity:
  hpa-attribute-value: '4'         get_param: REQUIRED_MEM
  operator: "="       unit: GB
    unit: GB   Storage:
     - hpa-feature: memoryPageSize   quantity:
       hpa-version: v1    get_param: REQUIRED_DISK
     architecture: generic    unit: GB
optimization:
    hpa-feature-attributesminimize:
    sum:
     - hpa-attribute-keydistance_between:
memoryPageSize      - customer_loc
      hpa-attribute-value: '2'vGMuxInfra
    - distance_between:
      operator: "="- customer_loc
      - vG




unit: GB
- cloud_min_guarantee:
    type: attribute

HAS Homing Response

State - Done

Code Block
languagejs
titlevCPE homing response (JSON)
collapsetrue
{
  "plans": [
    demands:{
    - vG "status": "done",
  properties:       evaluate"id": "plan_id",
       cpu_min_guarantee"name": true"Plan Name 1",
      mem_min_guarantee"links": true[
 - check_cloud_capacity:      type:[
vim_fit     demands:     -{
vG     properties:       controller: multicloud"href": "http://conductor:8091/v1/plans/plan_id",
      request:      "rel": "self"
 vCPU: 10        }
Memory:        ]
  quantity:    ],
      "recommendations": [
get_param: REQUIRED_MEM       {
   unit: GB      "vG": {
 Storage:           quantity"inventory_provider": "aai",
            get_param"candidate": REQUIRED_DISK{
          unit: GB optimization:   minimize"candidate_id": "DLLSTX1A",
   sum:     - distance_between:       - customer_loc"cloud_owner": "CloudOwner1",
       - vGMuxInfra     - distance"inventory_betweentype": "cloud",
     - customer_loc       - vG

HAS Homing Response

Success: 

Code Block
languagejs
titlevCPE homing response (JSON)
collapsetrue
{
  "plans": [ "location_id": "DLLSTX1A",
       {       "statuslocation_type": "solvedopenstack-cloud",
       "id": "plan_id",    },
  "name": "Plan Name 1",       "linksattributes": {
[         [     "flavors":  {
   {             "hrefflavor_label_1": "http://conductor:8091/v1/plans/plan_id",vim_flavor_X",
             "rel   "flavor_label_2": "selfvim_flavor_Y"
          }    },
    ]       ],       "recommendations": ["cloud_owner": "CloudOwner1",
         {     "physical-location-id": "DLLSTX1A",
    "vG": {         "cloud_version": "3.0",
			  "inventory_providervim-id": "aaiCloudOwner1_DLLSTX1A",
            "candidate":}
{           }
   "candidate_id": "DLLSTX1A",    },
          "cloud_owner": "CloudOwner1",
  {
           "inventory_typevGMuxInfra": "cloud",{
              "location_idattributes": "DLLSTX1A",{
              "locationhost_typeid": "openstack-cloud"vgmux_host_name",
            },             "attributes"cloud_owner": {"CloudOwner1",
              "flavorsphysical-location-id": {"DLLSTX1A",
                "flavorservice_labelinstance_1id": "vim_flavor_X21d5f3e8-e714-4383-8f99-cc480144505a",
              "cloud_version": "3.0",
			  "flavor_label_2vim-id": "vimCloudOwner1_flavor_YDLLSTX1A"
              },
 
            "cloudinventory_ownerprovider": "CloudOwner1aai",
              "physical-location-"service_resource_id": "DLLSTX1A12345",
              "cloud_versioncandidate": "3.0"{
            }    "is_rehome": "false",
      }         }"location_id": "DLLSTX1A",
        {           "vGMuxInfra": {"inventory_type": "service",
              "attributescandidate_id": {"21d5f3e8-e714-4383-8f99-cc480144505a",
              "host_id": "vgmux_host_name",
              "cloud_owner": "CloudOwner1",
              "physical-location-id_type": "DLLSTX1A",openstack-cloud"
            }
          "service_instance_id": "21d5f3e8-e714-4383-8f99-cc480144505a",}
        }
      ]
"cloud_version": "3.0"   }
  ]
}


State - Error 

Code Block
languagejs
titleHAS Error Response
collapsetrue
{
  },
"plans": [
    {
      "inventory_providerstatus": "aaierror",
      "message": "Some error message",
   "service_resource_id   "name": "12345Plan Name 1",
      "links": [
    "candidate": {   [
          {
"is_rehome": "false",               "location"href": "http://conductor:8091/v1/plans/plan_id": "DLLSTX1A",
 
            "inventory_typerel": "serviceself",
          }
      "candidate_id": "21d5f3e8-e714-4383-8f99-cc480144505a",
 ]
      ],
      "host_id": "vgmuxplan_host_nameid",
    }
  ]
}


State - Template 

Code Block
languagejs
titleHAS Plan in Template State
collapsetrue
{
  "cloud_ownerstatus": "CloudOwner1template",
  "name": "Plan Name 1",
  "links": [
    [
"location_type": "openstack-cloud"     {
       } "href": "http://conductor:8091/v1/plans/plan_id",
        }
"rel": "self"
       }
      ]
  ],
 }   ]"id": "plan_id"
}


...

State - Solving

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