...

Resources Related to Policy

OOF

...

Policies (multiple applications)

Anchor
OOF-HAS Policies OOF-HAS Policies

OOF-HAS Policies

OOF-HAS Service Design Policies

...

Service design policies are typically defined as a part of a service design model and evaluated/enforced prior to the service instantiation phase. For example, Hardware Platform Enablement (HPA) policies are defined in an SDC service model and evaluated/enforced during the homing optimization process in ONAP.

The HPA requirements are captured in a VNF descriptor provided by a vendor. During the service-design phase, these requirements are extracted out from the VNF descriptor and captured in a service model. Some of the HPA requirements cannot be changed during the lifecycle of a service; while other optional requirements can be changed by a service designer or operator over time (e.g. the use of SR-IOV may be preferred by an operator if the SR-IOV capability is optionally provided by a vendor). Once a service model is designed and uploaded into the SDC repository, SDC notifies the policy service about the distribution of a new service model. The policy service then fetches the service model and extracts out the HPA requirements through model decomposition. Next, the policy service creates HPA policies for the homing service (OOF-HAS) by populating the HPA requirements in policy models provided by OOF, and stores the policies in a repository. When the homing service receives a homing request from SO, the homing service asks for the associated HPA policies from the policy platform. Finally, the homing service finds homing solutions based on the evaluation of the received HPA policies and returns the solutions to SO.

...

border	true

...

width	60%

...

language	js
theme	Eclipse
title	HPA Hyper-Threading Policy Example
linenumbers	true
collapse	true

...

As per meeting minutes here: OOF 2018-02-19 Meeting Notes, it was understood that all HPA requirements for a given VM can be put in one policy or across different policies. Also, it was discussed that each HPA capability can be enhanced to include mandatory and score attributes. Keeping this in mind, HPA capabilities are defined here. As indicated, policy can have multiple capabilities.

Section
border true
Column width 60% Code Block language js theme Eclipse title Template for the HPA policies linenumbers true collapse true { "service": "{the model name of a policy}", "policyName": "{policy scope folder}.{policy name; must be unique}", "description": "{description of a policy}", "templateVersion": "{policy model version}", "version": "{policy version}", "priority": "{priority in 1-10; larger the number higher the priority is}", "riskType": "{the type of risk}", "identityriskLevel": "hyper_threading_vGMuxInfra{the level of risk}", "policyScopeguard": "{True/False flag to indicate whether guard is applicable "serviceType": ["vCPE"]or not}", "content": { "geoRegionresource": ["US", "INTERNATIONAL"]{resource name}", "networkTypeidentity": ["ip{policy identity}"], "resourceInstanceTypepolicyScope": ["vGMuxInfra"]{a tag representing policy scope}"], "typepolicyType": "HPA_hyper_threading{policy type}", "resourceInstanceTypeflavorFeatures": ["vGMuxInfra"] { } } Column width 45% Expand title Comments and Notes: HPA Hyper-Threading Policy Example The fields in this example policy are typically generated from a TOSCA service model specified by VNF vendors or service designers. This policy cannot be changed during the life-cycle of a service.
Section
border true
Column width 60% Code Block language js theme Eclipse title Distance Policy Example linenumbers true collapse true { "serviceflavorLabel": "DistancePolicy",{VM/VFC id}", "policyName": "OOF_Beijing.DistancePolicy_vGMuxInfra", "descriptionflavorProperties":[ "Distance Policy for vGMuxInfra", "templateVersion": "0.0.1", "version": "ONAP_Beijing", { "priority": "3", "riskType": "test", "riskLevel": "2", "guardhpa-feature" : "False{HPA feature type}", "content": { "distance_properties": { "locationInfomandatory" : "{ "value": "customer_location", "operator": "="},mandatoriness of the feature}", "distance": { "value": "500", "operator": "<score", "unit": "km" }, "resourceInstanceType": { "value": "vGMuxInfra", "operator": "="},{priority of this feature if the feature is not mandatory for VM}" }, "identityarchitecture": "distance-bGMuxInfra{supported architecuture}", "policyScope": { "serviceTypehpa-version": ["vCPE"]"{version for hpa capability}", "geoRegion": ["US", "INTERNATIONAL"], "networkTypehpa-feature-attributes": ["ip"], "resourceInstanceType": ["vGMuxInfra"] }, { "type": "distance" } } Column width 45% Expand title Comments and Notes: Distance Policy The fields in this example policy are typically generated from a TOSCA service model specified by VNF vendors or service designers. However, the policy can be updated over time by operators.
Section
border true
Column width 60% Code Block language js theme Eclipse title HPA AES Policy Example linenumbers true collapse true { "service": "HPA_AES_Policy", "policyNamehpa-attribute-key": "OOF_Beijing.AES_vGMuxInfra{attribute name}", "description": "AES policy for vGMuxInfra", "templateVersion": "0.0.1", "versionhpa-attribute-value": "ONAP_Beijing{attribute value}", "priority": "3", "riskType": "test", "riskLeveloperator": "2{comparison operator}", "guard": "False", "contentunit": "{the unit of an attribute}"} "AES_properties": { "version": { "values": 1.0, "operator": "="}, ] "hw_arch": { "values": "intel_64", "operator": "="}, "aes_feature": {"values": "true","operator": "="} ] }, "identity": "AES_vGMuxInfra", } "policyScope": { "serviceType": ["vCPE"], "geoRegion": ["US", "INTERNATIONAL"], } } Column width 45% Expand title Comments and Notes: HPA CPU Topology Policy Example Template for the HPA policies.

Section
border true
Column width 60% Code Block language js theme Eclipse title HPA Policy Example linenumbers true collapse true { "service": "hpaPolicy", "networkTypepolicyName": ["ipoofBeijing.hpaPolicy_vGMuxInfra"], "description": "HPA policy for vGMuxInfra", "resourceInstanceTypetemplateVersion": ["vGMuxInfra"]0.0.1", "version": "1.0", "priority": "3", },"riskType": "test", "riskLevel": "2", "typeguard": "HPA_AESFalse", "content": { "resourceInstanceTyperesources": ["vGMuxInfra"], } } Column width 45% Expand title Comments and Notes: HPA AES Policy The fields in this example policy are typically generated from a TOSCA service model specified by VNF vendors or service designers. This policy cannot be changed during the life-cycle of a service.
Section
border true
Column width 60% Code Block language js theme Eclipse title HPA OCS_DPDK Policy Example linenumbers true collapse true { "identity": "hpaPolicy_vGMuxInfra", "servicepolicyScope": "HPA_OVS_DPDK_Policy["vCPE", "policyName": "OOF_Beijing.HPA_DPDK_vGMuxInfra", "description": "HPA OVS DPDK policy for vGMuxInfra","US", "INTERNATIONAL", "ip", "vGMuxInfra"], "templateVersionpolicyType": "0.0.1hpaPolicy", "versionflavorFeatures": "ONAP_Beijing", [ "priority": "3", { "riskType": "test", "riskLevelflavorLabel": "2flavor_label_vm_01", "guard": "False", "contentflavorProperties":[ { "OVS_DPDK_properties": { "version": { "values": 1.0, "operatorhpa-feature" : "=cpuTopology"}, "hw_arch": { "valuesmandatory" : "*True", "operator": "="}, "OVS_DPDK": {"values": "true", "operatorarchitecture": "=generic"}, }, "identity"hpa-version": "OVS_DPDK_vGMuxInfrav1", "policyScope": { "hpa-feature-attributes": [ "serviceType": ["vCPE"], "geoRegion{"hpa-attribute-key":"numCpuSockets", "hpa-attribute-value": ["US2","operator": "INTERNATIONAL>="], "networkType"unit": ["ip"]}, "resourceInstanceType": ["vGMuxInfra"] {"hpa-attribute-key":"numCpuSockets", "hpa-attribute-value": "4","operator": "<=", "unit": ""}, }, {"typehpa-attribute-key": "HPA_OVS_DPDKnumCpuCores", "hpa-attribute-value": "resourceInstanceType"2", "operator":">=", "unit": ["vGMuxInfra"]"}, } } Column width 45% Expand title Comments and Notes: HPA OVS_DPDK Policy The fields in this example policy are typically generated from a TOSCA service model specified by VNF vendors or service designers. This policy cannot be changed during the life-cycle of a service.
Section
border true
Column width 60% Code Block language js theme Eclipse title HPA CPU_Pinning Policy Example linenumbers true collapse true { "service": "HPA_CPU_Pinning_Policy", "policyName": "OOF_Beijing.HPA_CPU_Pinning_vGMuxInfra", "description": "CPU Pinning policy for vGMuxInfra", "templateVersion": "0.0.1", "version": "ONAP_Beijing", "priority": "3", "riskType": "test", "riskLevel": "2", "guard": "False", "content": { {"hpa-attribute-key":"numCpuCores", "hpa-attribute-value": "4", "operator":"<=", "unit": ""}, {"hpa-attribute-key":"numCpuThreads", "hpa-attribute-value": "4", "operator":">=", "unit": ""}, "CPU_pinning_properties": { "pinning": { "values{"hpa-attribute-key":"numCpuThreads", "hpa-attribute-value": "prefer8", "operator":"<=", "unit": "="} ] }, "identity": "CPU_pinning_vGMuxInfra", }, "policyScope": { "serviceTypehpa-feature" : ["vCPEbasicCapabilities"], "geoRegionmandatory" : ["USTrue", "INTERNATIONAL"], "networkTypearchitecture": ["ipgeneric"], "resourceInstanceTypehpa-version": ["vGMuxInfrav1"], }, "hpa-feature-attributes": [ "type {"hpa-attribute-key": "HPA_CPU_pinningnumVirtualCpu", "hpa-attribute-value": "6", "operator": "=", "resourceInstanceTypeunit": ["vGMuxInfra"]"}, } } Column width 45% Expand title Comments and Notes: HPA CPU_Pinning Policy The fields in this example policy are typically generated from a TOSCA service model specified by VNF vendors or service designers. This policy cannot be changed during the life-cycle of a service.
Section
border true
Column width 60% Code Block language js theme Eclipse title HPA NUMA Policy Example linenumbers true collapse true { "service": "HPA_NUMA_Policy", "policyName": "OOF_Beijing.Hyper_NUMA_vGMuxInfra", "description": "Hyper NUMA policy for vGMuxInfra", "templateVersion": "0.0.1", "version": "ONAP_Beijing", "priority": "3",] "riskType": "test", "riskLevel": "2", "guard": "False", "content": { {"hpa-attribute-key": "virtualMemSize", "hpa-attribute-value":"6", "operator": "=", "unit": "GB"} ] }, { "NUMA_properties": { hpa-feature" : "ovsDpdk", "version": { "values": 1.0, "operatormandatory" : "=False"}, "hw_arch": { "valuesscore" : "*3", "operator "architecture": "=generic"}, "numa_nodes": { "values": 2, "operator "hpa-version": "=v1"}, "complex_, "hpa-feature-attributes": [ { "numa_cpu": { "values": [0, 1], "operator": "="}, "numa_mem": { "values": 2 {"hpa-attribute-key":"dataProcessingAccelerationLibrary", "hpa-attribute-value":"ovsDpdk_version", "operator": "=", "unit": "GB"}, }, { "numa_cpu": { "values": [2, 3, 4, 5], "operator": "="}, "numa_mem": { "values": 4, "operator": "=", "unit": "GB" ] }, { } ] "hpa-feature" : "cpuInstructionSetExtensions", }, "identitymandatory" : "NUMA_vGMuxInfraTrue", "policyScope": { "serviceType"architecture": ["vCPEINTEL-64"], "geoRegionhpa-version": ["USv1", "INTERNATIONAL"], "networkTypehpa-feature-attributes": ["ip"], "resourceInstanceType": ["vGMuxInfra"] {"hpa-attribute-key":"instructionSetExtensions", "hpa-attribute-value":["<CPUINST>", "<CPUINST>"] "operator": "ALL", "unit":""} }, ] "type": "HPA_NUMA",} "resourceInstanceType": ["vGMuxInfra"] } } Column width 45% Expand title Comments and Notes: HPA NUMA Policy The fields in this example policy are typically generated from a TOSCA service model specified by VNF vendors or service designers. This policy cannot be changed during the life-cycle of a service.
Section
border true
Column width 60% Code Block language js theme Eclipse title HPA SGX Policy Example linenumbers true collapse true , { "service": "HPA_SGX_Policy", "policyNameflavorLabel": "OOF_Beijing.SGX_vGMuxInfra",flavor_label_vm_02", "descriptionflavorProperties":[ "SGX policy for vGMuxInfra", "templateVersion": "0.0.1", { "version": "ONAP_Beijing", "priority": "3", "riskTypehpa-feature" : "testcpuPinningy", "riskLevel": "2", "guardmandatory" : "FalseTrue", "content": { "SGX_propertiesarchitecture": "generic", { "version": { "values": 1.0, "operator": "="}, "hw_arch": { "valueshpa-version": "intel_64v1", "operator": "="}, "sgx_mem_size": { "values": "128", "operator": "=", "unit": "MB"}, "hpa-feature-attributes": [ "sgx_pubkey_hash": { "values": "octect_string{"hpa-attribute-key":"logicalCpuThreadPinningPolicy", "hpa-attribute-value":"<CPUTHREADPOLICY>", "operator": "=", "unit":""}, }, {"hpa-attribute-key":"logicalCpuPinningPolicy", "identityhpa-attribute-value": "SGX_vGMuxInfra<CPUPOLICY>", "policyScope"operator": {"=", "unit":""}, "serviceType": ["vCPE"]] }, "geoRegion": ["US", "INTERNATIONAL"],{ "networkTypehpa-feature" : ["ipbasicCapabilities"], "resourceInstanceTypemandatory" : ["vGMuxInfraTrue"], }, "typearchitecture": "HPA_SGXgeneric", "resourceInstanceType": ["vGMuxInfra"] } } Column width 45% Expand title Comments and Notes: HPA SGX Policy The fields in this example policy are typically generated from a TOSCA service model specified by VNF vendors or service designers. This policy cannot be changed during the life-cycle of a service.

CMSO Policies

TBD

Policy Fetching Modes

OOF can fetch optimzation policies using the getConfig API of the policy system. The policies can be searched and filtered in two different modes; by-name and by-scope from the policy system.

By-name: OOF can send an explicite policy name or a regular expression matching a set of policy names as a part of the getConfig API payload. In return, OOF expects to receive a specific policy or a set of policies with name matching to the regular expression.

By-scope: A scope is the domain to which a policy is applicable. Scope information can be captured as a set of attribute-value pairs, which can be sent as a part of the getConfig API payload. In response, the policy system is expected to return a set of policies with the matching attribute-value pairs. A policy can only be included in the response if all the matching attribute-value pairs exist.

...

"hpa-version": "v1",
              "hpa-feature-attributes": [
                {"hpa-attribute-key": "numVirtualCpu", "hpa-attribute-value": "6", "operator": "=", "unit": ""},
                {"hpa-attribute-key": "virtualMemSize", "hpa-attribute-value":"6", "operator": "=", "unit": "GB"}
              ]
            },
            {
              "hpa-feature" : "localStorage",
              "mandatory" : "False",
              "score" : "5",
              "architecture": "generic",
              "hpa-version": "v1",
              "hpa-feature-attributes": [
                {"hpa-attribute-key": "diskSize", "hpa-attribute-value": "2", "operator": "=", "unit": "GB"},   
      	        {"hpa-attribute-key": "ephemeralDiskSize", "hpa-attribute-value": "2", "operator": "=", "unit": "GB"},
		        {"hpa-attribute-key": "swapMemSize", "hpa-attribute-value":"16", "operator": "=", "unit": "MB"},
              ]
            },
            {
              "hpa-feature" : "pcie",
              "mandatory" : "True",
              "architecture": "generic",
              "hpa-version": "v1",
              "hpa-feature-attributes": [
                {"hpa-attribute-key": "pciCount", "hpa-attribute-value": "2", "operator": "=", "unit": ""},
                {"hpa-attribute-key": "pciVendorId", "hpa-attribute-value":"8086", "operator": "=", "unit": ""},
	            {"hpa-attribute-key": "pciDeviceId", "hpa-attribute-value": "2", "operator": "=", "unit": ""} 
                {"hpa-attribute-key": "functionType", "hpa-attribute-value": "<PCITYPEVALUE>","operator": "=", "unit": ""} 
              ]
            }
          ] 
        },
        {
          "flavorLabel": "flavor_label_vm_03",
          "flavorProperties":[
            {
              "hpa-feature" : "numa",
              "mandatory" : "False",
              "score" : "5",
              "architecture": "generic",
              "hpa-version": "v1",
              "hpa-feature-attributes": [
                {"hpa-attribute-key": "numaNodes", "hpa-attribute-value": "2", "operator": "=", "unit": ""},
                {"hpa-attribute-key": "numaCpu-0", "hpa-attribute-value":"2", "operator": "=", "unit": ""},
                {"hpa-attribute-key": "numaMem-0", "hpa-attribute-value": "2048", "operator": "=", "unit": "MB"}
                {"hpa-attribute-key": "numaCpu-1", "hpa-attribute-value":"4", "operator": "=", "unit": ""},
                {"hpa-attribute-key": "numaMem-1", "value": "4096", "operator": "=", "unit": "MB"}
              ]
            },
            {
              "hpa-feature" : "basicCapabilities",
              "mandatory" : "True",
              "architecture": "generic",
              "hpa-version": "v1",
              "hpa-feature-attributes": [
                {"hpa-attribute-key": "numVirtualCpu", "hpa-attribute-value": "6", "operator": "=", "unit": ""},
                {"hpa-attribute-key": "virtualMemSize", "hpa-attribute-value":"6", "operator": "=", "unit": "GB"}
              ]
            },
            {
              "hpa-feature" : "hugePages",
              "mandatory" : "False",
              "score" : "7",
              "architecture": "generic",
              "hpa-version": "v1",
              "hpa-feature-attributes": [
                 {"hpa-attribute-key": "memoryPageSize", "hpa-attribute-value": "<MEMORYPAGESIZE>", "operator": "=", "unit": ""}
              ]
            }
          ] 
        }
      ]
    }
}

{
  "service": "distancePolicy",
  "policyName": "oofBeijing.distancePolicy_vGMuxInfra",
  "description": "Distance Policy for vGMuxInfra",
  "templateVersion": "0.0.1",
  "version": "oofBeijing",
  "priority": "3",
  "riskType": "test",
  "riskLevel": "2",
  "guard": "False",
  "content": {
    "distanceProperties": {
      "locationInfo": customer_location",
      "distance": { "value": "500", "operator": "<", "unit": "km" }
    },
    "resources": ["vGMuxInfra", "vG"],
    "applicableResources": "any",
    "identity": "distance-vGMuxInfra",
    "policyScope": ["vCPE", "US", "INTERNATIONAL", "ip", "vGMuxInfra"],
    "policyType": "distancePolicy"
  }
}

{
    "hpa-feature" : "basicCapabilities",
    "mandatory" : "False",
    "score" : "5",
    "architecture": "generic",
    "hpa-version": "v1",
    "hpa-feature-attributes": [
       {"hpa-attribute-key": "numVirtualCpu", "hpa-attribute-value": "6", "operator": "=", "unit": ""},
       {"hpa-attribute-key": "virtualMemSize", "hpa-attribute-value":"6", "operator": "=", "unit": "GB"}
    ]
}

{
    "hpa-feature" : "ovsDpdk",
    "mandatory" : "False",
    "score" : "5",
    "architecture": "INTEL-64",
    "hpa-version": "v1",
    "hpa-feature-attributes": [
      {"hpa-attribute-key":"dataProcessingAccelerationLibrary", "hpa-attribute-value":"ovsDpdk_version", "operator": "=", "unit":""}
     ]
}

{
   "hpa-feature" : "cpuPinning",
   "mandatory" : "False",
   "score" : "5",
   "architecture": "generic",
   "hpa-version": "v1",
   "hpa-feature-attributes": [
     {"hpa-attribute-key":"logicalCpuThreadPinningPolicy", "hpa-attribute-value":"<CPUTHREADPOLICY>", "operator": "=", "unit":""},
     {"hpa-attribute-key":"logicalCpuPinningPolicy", "hpa-attribute-value": "<CPUPOLICY>","operator": "=", "unit":""},
    ]
}

CPUTHREADPOLICY = prefer, isolate, require

CPUPOLICY = shared, dedicated

{
    "hpa-feature" : "numa",
    "mandatory" : "False",
    "score" : "5",
    "architecture": "generic",
    "hpa-version": "v1",
    "hpa-feature-attributes": [
       {"hpa-attribute-key": "numaNodes", "hpa-attribute-value": "2", "operator": "=", "unit": ""},
       {"hpa-attribute-key": "numaCpu-0", "hpa-attribute-value":"2", "operator": "=", "unit": ""},
       {"hpa-attribute-key": "numaMem-0", "hpa-attribute-value": "2048", "operator": "=", "unit": "MB"},
       {"hpa-attribute-key": "numaCpu-1", "hpa-attribute-value":"4", "operator": "=", "unit": ""},
       {"hpa-attribute-key": "numaMem-1", "hpa-attribute-value": "4096", "operator": "=", "unit": "MB"}
    ]
}

{
   "hpa-feature" : "cpuTopology",
   "mandatory" : "False",
   "score" : "5",
   "architecture": "generic",
   "hpa-version": "v1",
   "hpa-feature-attributes": [
      {"hpa-attribute-key":"numCpuSockets", "hpa-attribute-value": "2","operator": ">=", "unit": ""},
      {"hpa-attribute-key":"numCpuSockets", "hpa-attribute-value": "4","operator": "<=", "unit": ""},
      {"hpa-attribute-key":"numCpuCores", "hpa-attribute-value": "2", "operator":">=", "unit": ""},
      {"hpa-attribute-key":"numCpuCores", "hpa-attribute-value": "4", "operator":"<=", "unit": ""},
      {"hpa-attribute-key":"numCpuThreads", "hpa-attribute-value": "4", "operator":">=", "unit": ""},
      {"hpa-attribute-key":"numCpuThreads", "hpa-attribute-value": "8", "operator":"<=", "unit": ""}
   ]
}

{
    "service": "affinityPolicy",
    "policyName": "oofBeijing.affinityPolicy_vcpe",
    "description": "Affinity policy for vCPE",
    "templateVersion": "1702.03",
    "version": "oofBeijing",
    "priority": "5",
    "riskType": "test",
    "riskLevel": "2",
    "guard": "False",
    "content": {
        "identity": "affinity_vCPE",
        "policyScope": ["vCPE", "US", "INTERNATIONAL", "ip", "vGMuxInfra"],
        "affinityProperties": {
            "qualifier": "different",
            "category": "complex"
        },
        "policyType": "affinityPolicy",
        "resources": ["vGMuxInfra", "vG"],
        "applicableResources": "all"
    }
}

{
    "service": "capacityPolicy",
    "policyName": "oofBeijing.capacityPolicy_vGMuxInfra",
    "description": "Capacity policy for vGMuxInfra",
    "templateVersion": "1702.03",
    "version": "oofBeijing",
    "priority": "5",
    "riskType": "test",
    "riskLevel": "2",
    "guard": "False",
    "content": {
        "identity": "capacity_vGMuxInfra",
        "policyScope": ["vCPE", "US", "INTERNATIONAL", "ip", "vGMuxInfra"],
		"controller": "multicloud",
        "capacityProperties": {
            "cpu": {"value": 2, "operator": ">"},
            "memory": {"value": 4, "operator": ">", "unit": "GB"}
			"storage": {"value": 80, "operator": ">", "unit": "GB"}
        },
        "policyType": "vim_fit",
        "resources": ["vGMuxInfra"],
        "applicableResources": "any"
    }
}

{
    "service": "minGuaranteePolicy",
    "policyName": "oofBeijing.minGuaranee_vGMuxInfra",
    "description": "Min guarantee policy for vGMuxInfra",
    "templateVersion": "1702.03",
    "version": "oofBeijing",
    "priority": "5",
    "riskType": "test",
    "riskLevel": "2",
    "guard": "False",
    "content": {
        "identity": "minGuarantee_vGMuxInfra",
        "policyScope": ["vCPE", "US", "INTERNATIONAL", "ip", "vGMuxInfra"],
        "minGuaranteeProperty": {
            "cpu": "true",
            "memory": "false",
        },
        "type": "minGuaranteePolicy",
        "resources": ["vGMuxInfra"],
		"applicableResources": "any"
    }
}

{
    "service": "PlacementOptimizationPolicy",
    "policyName": "oofBeijing.PlacementOptimizationPolicy_vGMuxInfra",
    "description": "Placement Optimization Policy for vGMuxInfra",
    "templateVersion": "1702.03",
    "version": "oofBeijing",
    "priority": "5",
    "riskType": "test",
    "riskLevel": "3",
    "guard": "False",
    "content": {
        "objectiveParameter": {
            "parameterAttributes": [
                {
                    "resources": ["vGMuxInfra"],
                    "customerLocationInfo": "customer_loc",
                    "parameter": "distance",
                    "weight": "1",
                    "operator": "product"=
                },
                {
                    "resources": ["vG"],
                    "customerLocationInfo": "customer_loc",
                    "parameter": "distance",
                    "weight": "1",
                    "operator": "product"
                }
            ],
            "operator": "sum"
        },
        "identity": "optimization",
        "policyScope": ["vCPE", "US", "INTERNATIONAL", "ip", "vGMuxInfra"],
        "policyType": "placementOptimization",
        "objective": "minimize"
    }
}

{
    "hpa-feature" : "pcie",
    "mandatory" : "False",
    "score" : "5",
    "architecture": "generic",
    "hpa-version": "v1",
    "hpa-feature-attributes": [
      {"hpa-attribute-key": "pciCount", "hpa-attribute-value": "2", "operator": "=", "unit": ""},
      {"hpa-attribute-key": "pciVendorId", "hpa-attribute-value":"8086", "operator": "=", "unit": ""},
	  {"hpa-attribute-key": "pciDeviceId", "hpa-attribute-value": "2", "operator": "=", "unit": ""} 
      {"hpa-attribute-key": "functionType", "hpa-attribute-value": "<PCIETYPEVALUE>","operator": "=", "unit": ""} 
     ]
}

{
    "hpa-feature" : "localStorage",
    "mandatory" : "False",
    "score" : "5",
    "architecture": "generic",
    "hpa-version": "v1",
    "hpa-feature-attributes": [
       {"hpa-attribute-key": "diskSize", "hpa-attribute-value": "2", "operator": "=", "unit": "GB"},   
       {"hpa-attribute-key": "ephemeralDiskSize", "hpa-attribute-value": "2", "operator": "=", "unit": "GB"},
	   {"hpa-attribute-key": "swapMemSize", "hpa-attribute-value":"16", "operator": "=", "unit": "MB"},
     ]
}

{
    "hpa-feature" : "cpuInstructionSetExtensions",
    "mandatory" : "False",
    "score" : "5",
    "architecture": "INTEL-64",
    "hpa-version": "v1",
    "hpa-feature-attributes": [
      {"hpa-attribute-key":"instructionSetExtensions", "hpa-attribute-value":["<CPUINST>", "<CPUINST>"] "operator": "ALL", "unit":""}
     ]
}

instructionSetExtensions attribute has a list of all instruction set extensions required. 

CPUINST = aes, avx, sha_ni, mpx, adcx, mpx, pclmulqdq, rdrand,sse, etc

{
    "hpa-feature" : "hugePages",
    "mandatory" : "False",
    "score" : "5",
    "architecture": "generic",
    "hpa-version": "v1",
    "hpa-feature-attributes": [
      {"hpa-attribute-key": "memoryPageSize", "hpa-attribute-value": "<MEMORYPAGESIZE>", "operator": "=", "unit": ""}
    ]
}

{
    "service": "vnfPolicy",
    "policyName": "oofBeijing.vnfPolicy_vGMuxInfra",
    "description": "vnfPolicy",
    "templateVersion": "1702.03",
    "version": "oofBeijing",
    "priority": "6",
    "riskType": "test",
    "riskLevel": "3",
    "guard": "False",
    "content": {
        "identity": "vnf_vGMuxInfra",
        "policyScope": ["vCPE", "INTERNATIONAL", "ip", "vGMuxInfra"],
        "policyType": "vnf_policy",
        "resources": ["vGMuxInfra"],
        "applicableResources": "any",
        "vnfProperties": [
            {
                "inventoryProvider": "aai",
                "serviceType": "",
                "inventoryType": "cloudRegionId",
                "customerId": ""
            },
            {
                "inventoryProvider": "multicloud",
                "serviceType": "HNGATEWAY",
                "inventoryType": "serviceInstanceId",
                "customerId": "21014aa2-526b-11e6-beb8-9e71128cae77"
            }
        ]
    }
}

{
 "service": "SubscriberPolicy",
 "policyName": "oofBeijing.SubscriberPolicy_v1",
 "description": "Subscriber Policy",
 "templateVersion": "0.0.1",
 "version": "oofBeijing",
 "priority": "1",
 "riskType": "test",
 "riskLevel": "3",
 "guard": "False",
 "content": {
        "identity": "subscriber",
        "policyScope": ["vCPE", "subscriber_x", "subscriber_y"],
        "properties": {
                "subscriberName": ["subscriber_x", "subscriber_y"],
                "subscriberRole": ["Test"],
                "provStatus": ["CAPPED"]
        },
        "policyType": "SubscriberPolicy"
 }
}

Anchor
OOF-CMSO Policies OOF-CMSO Policies

OOF-CMSO Policies

TBD

Modes for Fetching Policies

OOF can fetch optimzation policies using the getConfig API of the policy system. The policies can be searched and filtered in two different modes; by-name and by-scope from the policy system.

By-name: OOF can send an explicite policy name or a regular expression matching a set of policy names as a part of the getConfig API payload. In return, OOF expects to receive a specific policy or a set of policies with name matching to the regular expression.

By-scope: A scope is the domain to which a policy is applicable. Scope information can be captured as a set of attribute-value pairs, which can be sent as a part of the getConfig API payload. In response, the policy system is expected to return a set of policies with the matching attribute-value pairs. A policy can only be included in the response if all the matching attribute-value pairs exist.

OOF can requerst prioritization by enabling a prioritization flag in the getConfig API call to the policy system, and expects to receive a single policy with the highest priority policy among the set of policies meeting the search criteria.

TOSCA Policy Models

The following TOSCA policy models need to be uploaded as a dictionary during the deployment-time of an optimization application. Currently, the model uploading porcess is manual since the policy system does not offer an interface to upload models programatically. Once the models are uploaded, policy templates are created in the policy portal/GUI using which optimization policies can be created. Alternatively, the policy system offers CRUD REST APIs using which the policies can be managed by the application.

• HPA Policy
• Affinity Policy
• Distance Policy
• Capacity Policy
• VNF Policy
• Optimization Policy
• Query Policy
• Subscriber Policy

HAS Policies for Testing