...
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.
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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA Hyper-Threading Policy ExampleTemplate for the HPA policies |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"service": "hpaHyperThreadingPolicy{the model name of a policy}",
"policyName": "oofBeijing.hyperThreadingPolicy_vGMuxInfra{policy scope folder}.{policy name; must be unique}",
"description": "Hyper threading{description of a policy}",
for vGMuxInfra", "templateVersion": "0.0.1{policy model version}",
"version": "oofBeijing{policy version}",
"priority": "3",{priority in 1-10; larger the number higher the priority is}",
"riskType": "test{the type of risk}",
"riskLevel": "2{the level of risk}",
"guard": "False",
"content": {{True/False flag to indicate whether guard is applicable or not}",
"hyperThreadingPropertiescontent": {
"cpuCores": { "valueresource": 4, "operator": "="}{resource name}",
"cpuThreadsidentity": "{policy "value": 2identity}",
"operator": "="},
"cpuThreadsPolicypolicyScope": ["{a "value": "dedicated", "operator": "="}tag representing policy scope}"],
"cpuSocketspolicyType": "{policy "value": 2, "operator": "="}type}",
"flavorFeatures": [
}, "identity": "hyperThreading_vGMuxInfra", {
"policyScope": { "serviceTypeflavorLabel": ["vCPE"]"{VM/VFC id}",
"geoRegionflavorProperties": ["US", "INTERNATIONAL"],[
{
"networkType": ["ip"], "resourceInstanceTypehpa-feature" : ["vGMuxInfra"]"{HPA feature type}",
}, "typemandatory" : "hpaHyperThreadingPolicy{mandatoriness of the feature}",
"resourceInstanceType" "score" : ["vGMuxInfra"]{priority of this }
} |
|
Column |
---|
| 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Distance Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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": {feature if the feature is not mandatory for VM}"
"architecture": "{supported architecuture}",
"hpa-version": "{version for hpa capability}",
"hpa-feature-attributes": [
"locationInfo": { "value": "customer_location", "operator": "="}, {
"distance": { "value": "500", "operator": "<", "unit": "km" }, "resourceInstanceType": { "valuehpa-attribute-key": "vGMuxInfra{attribute name}",
"operator": "="}, }, "identity "hpa-attribute-value": "distance-vGMuxInfra{attribute value}",
"policyScope": { "serviceTypeoperator": ["vCPE{comparison operator}"],
"geoRegion": ["US", "INTERNATIONAL"], "networkTypeunit": ["ip"],"{the unit of an attribute}"}
"resourceInstanceType": ["vGMuxInfra"] }, ]
"type": "distancePolicy" }
} }
]
}
]
}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: Distance HPA CPU Topology 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 | Template for the HPA policies. |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA AES Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"service": "hpaAesPolicyhpaPolicy",
"policyName": "oofBeijing.aesPolicyhpaPolicy_vGMuxInfra",
"description": "AESHPA policy for vGMuxInfra",
"templateVersion": "0.0.1",
"version": "oofBeijing1.0",
"priority": "3",
"riskType": "test",
"riskLevel": "2",
"guard": "False",
"content": {
"aesPropertiesresources": {
"vGMuxInfra",
"versionidentity": { "values": 1.0hpaPolicy_vGMuxInfra",
"operator": "="}, "hwArchpolicyScope": {["vCPE", "valuesUS":, "intel_64INTERNATIONAL", "operatorip":, "=vGMuxInfra"}],
"aesFeature": {"valuespolicyType": "truehpaPolicy","operator
"flavorFeatures": "="} [
{
}, "identityflavorLabel": "aes_vGMuxInfraflavor_label_vm_01",
"policyScopeflavorProperties":[
{
"serviceType": ["vCPE"], "geoRegionhpa-feature" : ["UScpuTopology",
"INTERNATIONAL"], "networkTypemandatory" : ["ipTrue"],
"resourceInstanceTypearchitecture": ["vGMuxInfrageneric"]
,
}, "typehpa-version": "hpaAesPolicyv1",
"resourceInstanceType "hpa-feature-attributes": ["vGMuxInfra"]
} } |
|
Column |
---|
| 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA OCS_DPDK Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| { {"servicehpa-attribute-key": "hpaOvsDpdkPolicynumCpuSockets", "hpa-attribute-value": "2","operator": ">=", "policyNameunit": "oofBeijing.hpaOvsDpdkPolicy_vGMuxInfra"},
"description": "HPA OVS DPDK policy for vGMuxInfra", {"templateVersionhpa-attribute-key": "0.0.1numCpuSockets",
"version"hpa-attribute-value": "oofBeijing4",
"priorityoperator": "3<=",
"riskTypeunit": "test"},
"riskLevel": "2", "guard {"hpa-attribute-key": "FalsenumCpuCores",
"contenthpa-attribute-value": {
"ovsDpdkProperties": {
"version": { "values": 1.0, "operator"2", "operator":">=", "unit": "="},
"hwArch": { "values {"hpa-attribute-key":"numCpuCores", "hpa-attribute-value": "*4", "operator": "<="},
"OvsDpdkunit": {"values": "true"},
"operator": "="} }, "identity{"hpa-attribute-key":"numCpuThreads", "hpa-attribute-value": "ovsDpdk_vGMuxInfra4",
"policyScopeoperator": {
"serviceType">=", "unit": ["vCPE"]},
{"geoRegionhpa-attribute-key": ["USnumCpuThreads", "INTERNATIONAL"],hpa-attribute-value": "8", "operator":"<=", "unit": ""}
"networkType": ["ip"]]
},
"resourceInstanceType": ["vGMuxInfra"]{
"hpa-feature" : "basicCapabilities",
},
"typemandatory" : "hpaOvsDpdkPolicyTrue",
"resourceInstanceTypearchitecture": ["vGMuxInfrageneric"],
} } |
|
Column |
---|
| 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA CPU_Pinning Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| { "service "hpa-version": "hpaCpuPinningPolicyv1",
"policyName": "oofBeijing.hpaCpuPinningPolicy_vGMuxInfra", "descriptionhpa-feature-attributes": "CPU[
Pinning policy for vGMuxInfra", "templateVersion": "0.0.1", {"versionhpa-attribute-key": "oofBeijingnumVirtualCpu", "priority"hpa-attribute-value": "36", "riskTypeoperator": "test=",
"riskLevelunit": "2"},
"guard": "False", "content": { "cpuPinningProperties{"hpa-attribute-key": {
"pinning": { "values"virtualMemSize", "hpa-attribute-value":"6", "operator": "prefer=", "operatorunit": "=GB"}
}, ]
"identity": "cpuPinning_vGMuxInfra", "policyScope": {},
{
"serviceType": ["vCPE"], "geoRegionhpa-feature" : ["USovsDpdk",
"INTERNATIONAL"], "networkTypemandatory" : ["ipFalse"],
"resourceInstanceTypescore" : ["vGMuxInfra"]3",
},"architecture": "generic",
"type "hpa-version": "hpaCpuPinningv1",
"resourceInstanceType "hpa-feature-attributes": ["vGMuxInfra"]
}
} |
|
Column |
---|
| 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA NUMA Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"service": "hpaNumaPolicy",
"policyName": "oofBeijing.hpaNumaPolicy_vGMuxInfra",
"description": "Hyper NUMA policy for vGMuxInfra",
"templateVersion": "0.0.1",
"version": "oofBeijing",
"priority": "3",]
"riskType": "test",
"riskLevel": "2",
"guard": "False {"hpa-attribute-key":"dataProcessingAccelerationLibrary", "hpa-attribute-value":"ovsDpdk_version", "operator": "=", "unit":""}
]
},
{
"hpa-feature" : "cpuInstructionSetExtensions",
"content": { "numaPropertiesmandatory" : {
"True",
"version": { "values": 1.0, "operatorarchitecture": "=INTEL-64"},
"hwArch": { "valueshpa-version": "*v1", "operator": "="},
"numaNodes": { "values": 2, "operator": "="},
"complexAttributes
"hpa-feature-attributes": [
{
"numaCpu": { "values": [0, 1], "operator": "="},
"numaMem": { "values": 2, {"hpa-attribute-key":"instructionSetExtensions", "hpa-attribute-value":["<CPUINST>", "<CPUINST>"] "operator": "=ALL", "unit": "GB"},
}, { "numaCpu": { "values": [2, 3, 4, 5], "operator": "="},
"numaMem": { "values": 4, "operator": "=", "unit": "GB"}, ]
}
]
} ]},
{
}, "identityflavorLabel": "numa_vGMuxInfraflavor_label_vm_02",
"policyScopeflavorProperties":[
{ {
"serviceType": ["vCPE"], "geoRegionhpa-feature" : ["UScpuPinningy",
"INTERNATIONAL"], "networkTypemandatory" : ["ipTrue"],
"resourceInstanceTypearchitecture": ["vGMuxInfrageneric"]
,
}, "typehpa-version": "hpaNumaPolicyv1",
"resourceInstanceType "hpa-feature-attributes": ["vGMuxInfra"]
}
} |
|
Column |
---|
| 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA SGX Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"service": "hpaSgxPolicy",
"policyName": "oofBeijing.hpaSgxPolicy_vGMuxInfra" {"hpa-attribute-key":"logicalCpuThreadPinningPolicy", "hpa-attribute-value":"<CPUTHREADPOLICY>", "operator": "=", "unit":""},
"description": "SGX policy for vGMuxInfra", {"templateVersionhpa-attribute-key": "0.0.1logicalCpuPinningPolicy", "version"hpa-attribute-value": "oofBeijing<CPUPOLICY>",
"priorityoperator": "3=", "riskTypeunit": "test"},
"riskLevel": "2", "guard": "False", ]
"content": { "sgxProperties": {
},
"version": { "values": 1.0, "operator": "="}, "hwArch": { "values": "intel_64", "operator": "="},
"sgxMemSize": { "values": "128", "operator": "=", "unit": "MB"}
"hpa-feature" : "basicCapabilities",
"sgxPubkeyHash": { "valuesmandatory" : "octect_stringTrue", "operator":
"="} }, "identity""architecture": "sgx_vGMuxInfrageneric",
"policyScope": { "hpa-version": "v1",
"serviceTypehpa-feature-attributes": ["vCPE"],
{"geoRegionhpa-attribute-key": ["USnumVirtualCpu", "INTERNATIONAL"],
"networkType": ["ip"]hpa-attribute-value": "6", "operator": "=", "unit": ""},
"resourceInstanceType": ["vGMuxInfra"] {"hpa-attribute-key": "virtualMemSize", "hpa-attribute-value":"6", "operator": "=", "unit": "GB"}
]
},
"type": "hpaSgxPolicy",{
"resourceInstanceTypehpa-feature" : ["vGMuxInfralocalStorage"],
}
} |
|
Column |
---|
| 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. |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Affinity Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| { "servicemandatory" : "affinityPolicyFalse",
"policyName": "oofBeijing.affinityPolicy_vcpe", "descriptionscore" : "Affinity policy for vCPE5",
"templateVersion": "1702.03",
"version": "oofBeijing", "priorityarchitecture": "5generic",
"riskType": "test", "riskLevel": "2",
"guardhpa-version": "Falsev1",
"content": { "identityhpa-feature-attributes": "affinity_vCPE", [
"policyScope": { "serviceType{"hpa-attribute-key": "diskSize", "hpa-attribute-value": ["vCPE2"],
"geoRegion"operator": ["US=", "INTERNATIONAL"],unit": "GB"},
"networkType {"hpa-attribute-key": ["ipephemeralDiskSize"],
"resourceInstanceTypehpa-attribute-value": ["vGMuxInfra2", "vGoperator"]: "=", "unit": "GB"},
{"affinityPropertyhpa-attribute-key": {
"qualifier": {"value"swapMemSize", "hpa-attribute-value":"16", "operator": "different=", "operatorunit": "=MB"},
"category": {"value": "complex", "operator": "="}]
},
"type": "affinityPolicy", {
"resourceInstanceType" "hpa-feature" : ["vGMuxInfrapcie",
"vG"] "mandatory" : "True",
}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: Affinity 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Capacity Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| { "architecture": "generic",
"servicehpa-version": "capacityPolicyv1",
"policyName": "oofBeijing.capacityPolicy_vGMuxInfra", "descriptionhpa-feature-attributes": [
"Capacity policy for vGMuxInfra", "templateVersion": "1702.03", {"versionhpa-attribute-key": "oofBeijingpciCount",
"priorityhpa-attribute-value": "52",
"riskTypeoperator": "test=",
"riskLevelunit": "2"},
"guard": "False", "content": { {"hpa-attribute-key": "pciVendorId", "identity"hpa-attribute-value": "capacity_vGMuxInfra8086",
"policyScopeoperator": {
"serviceType"=", "unit": ["VCPE"]},
{"geoRegionhpa-attribute-key": ["USpciDeviceId", "INTERNATIONAL"],
"networkTypehpa-attribute-value": "2", "operator": ["ip="], "resourceInstanceType"unit": ["vGMuxInfra"]}
}, {"capacityPropertyhpa-attribute-key": {
"cpu"functionType", "hpa-attribute-value": "<PCITYPEVALUE>","operator": {"value=": 2, "operatorunit": ">"},
]
"memory": {"value": 4, "operator": ">", "unit": "Gb"}
},]
"type": "capacityPolicy", },
{
"resourceInstanceType": ["vGMuxInfra"] } } |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: Capacity 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Min Guarantee Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"service"flavorLabel": "minGuaranteePolicyflavor_label_vm_03",
"policyName": "oofBeijing.minGuaranee_vGMuxInfra", "descriptionflavorProperties":[
"Min guarantee policy for vGMuxInfra", "templateVersion": "1702.03", {
"version": "oofBeijing", "priority": "5", "riskTypehpa-feature" : "testnuma",
"riskLevel": "2", "guardmandatory" : "False",
"content": { "identityscore" : "minGuarantee_vGMuxInfra5",
"policyScope": { "serviceType""architecture": ["vCPEgeneric"],
"geoRegionhpa-version": ["USv1",
"INTERNATIONAL"], "networkTypehpa-feature-attributes": ["ip"],
{"resourceInstanceTypehpa-attribute-key": ["vGMuxInfranumaNodes"]
},
, "hpa-attribute-value": "2", "operator": "=", "unit": ""},
"minGuaranteeProperty": { "cpu{"hpa-attribute-key": {""numaCpu-0", "hpa-attribute-value": "true2", "operator": "=", "unit": ""},
"memory {"hpa-attribute-key": {""numaMem-0", "hpa-attribute-value": "false2048", "operator": "=", "unit": "MB"}
}, "type{"hpa-attribute-key": "minGuaraneePolicynumaCpu-1",
"resourceInstanceTypehpa-attribute-value":"4", ["vGMuxInfraoperator"]
: "=", "unit": ""},
{"hpa-attribute-key": "numaMem-1", "value": "4096", "operator": "=", "unit": "MB"}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: Min Guarantee 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-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": ""}
]
}
]
}
]
}
}
|
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA CPU Topology 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.
CPUTHREADPOLICY = prefer, isolate, require CPUPOLICY = shared, dedicated PCIETYPEVALUE: SRIOV, PCI-PASSTHROUGH CPUINST = aes, avx, sha_ni, mpx, adcx, mpx, pclmulqdq, rdrand,sse, etc MEMORYPAGESIZE = 4KB (unit=KB), 2MB (unit=MB), 1GB(unit=GB), ANY, Other explicit Page size |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Distance Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"
}
} |
|
Column |
---|
| 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA Basic Capabilities Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"}
]
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA Basic Capabilities 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA OVS DPDK Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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":""}
]
} |
|
Column |
---|
| 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. For this policy others architectures are also applicable. |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA CPU Pinning Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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":""},
]
} |
|
Column |
---|
| 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.
CPUTHREADPOLICY = prefer, isolate, require CPUPOLICY = shared, dedicated
|
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA NUMA Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"}
]
} |
|
Column |
---|
| 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA CPU Topology Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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": ""}
]
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA CPU Topology 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Affinity Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"
}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: Affinity 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Capacity Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"
}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: Capacity 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Min Guarantee Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"
}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: Min Guarantee 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. A min-guarantee policy can be specified using the HPA policy model. |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Optimization Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"
}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: Optimization 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA PCIe Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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": ""}
]
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA PCIe Policy Example |
---|
| PCIETYPEVALUE: SRIOV, PCI-PASSTHROUGH |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA Local Storage Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"},
]
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA Generic Attributes 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 |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA CPU Instruction Set Extensions Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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":""}
]
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA CPU Instruction Set Extensions Policy Example |
---|
| instructionSetExtensions attribute has a list of all instruction set extensions required. CPUINST = aes, avx, sha_ni, mpx, adcx, mpx, pclmulqdq, rdrand,sse, etc |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | HPA Huge Pages Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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": ""}
]
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA Huge Pages Policy Example |
---|
| MEMORYPAGESIZE = 4KB (unit=KB), 2MB (unit=MB), 1GB(unit GB), ANY, Other explicit Page size |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | VNF Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"
}
]
}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA Huge Pages Policy Example |
---|
| VNF policy captures the location of inventories and customer information. |
|
|
Section |
---|
|
Column |
---|
| Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | Subscriber Role Policy Example |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"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"
}
} |
|
Column |
---|
| Expand |
---|
title | Comments and Notes: HPA Huge Pages Policy Example |
---|
| Subscriber role policy to capture the role of a subscriber and related provisioning states. |
|
|
Anchor |
---|
| OOF-CMSO Policies |
---|
| OOF-CMSO Policies |
---|
|
OOF-CMSO PoliciesTBD
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.
HAS Policies for Testing
View file |
---|
name | Affinity_vCPE_1.json |
---|
height | 250 |
---|
|
View file |
---|
name | Capacity_vG_1.json |
---|
height | 250 |
---|
|
View file |
---|
name | Capacity_vGMuxInfra.json |
---|
height | 250 |
---|
|
View file |
---|
name | Distance_vG_1.json |
---|
height | 250 |
---|
|
View file |
---|
name | Distance_vGMuxInfra_1.json |
---|
height | 250 |
---|
|
View file |
---|
name | hpa_policy_vG_1.json |
---|
height | 250 |
---|
|
View file |
---|
name | hpa_policy_vGMuxInfra_1.json |
---|
height | 250 |
---|
|
View file |
---|
name | Placement_Optimization_1.json |
---|
height | 250 |
---|
|
View file |
---|
name | QueryPolicy_vCPE.json |
---|
height | 250 |
---|
|
View file |
---|
name | subscriber_policy.json |
---|
height | 250 |
---|
|
View file |
---|
name | vnfPolicy_vG.json |
---|
height | 250 |
---|
|
View file |
---|
name | vnfPolicy_vGMuxInfra.json |
---|
height | 250 |
---|
|