This page contains a proposal for the design of the Control Loop Policy Types in order to address the problems not solved in the Dublin release.
Guard Policy Type
description Policy Types for control loops to take a baby step approach from Dublin to Frankfurt retaining a close resemblance to Dublin legacy policy types.
1. Guard Policy Type
1.1 The base schema is defined as below:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 policy_types: - onap.policies.controlloop.Guard: derived_from: tosca.policies.Root version: 1.0.0 description: Base definition description:of Guardguard Policies for Control Loop Operational Policies |
onap.policies.controlloop.guard.FrequencyLimiter Policy Type
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 policy_types: - onap.policies.controlloop.Guard: derived_from: tosca.policies.Root properties: actor: versiontype: 1.0.0string description: Guard Policies for Controldescription: LoopSpecifies Operationalthe PoliciesActor - onap.policies.controlloop.guard.FrequencyLimiter: derived_fromrequired: onap.policies.controlloop.Guard true version: 1.0.0 operation: description: Supports limiting the frequencytype: ofstring actions being taken by a Actor. description: Specified the properties:Recipe frequency_policy: required: true typecontrolLoopName: map descriptiontype: string entry_schemadescription: An optional specific control loop to apply type: onap.datatypes.guard.FrequencyLimiter data_types: - onap.datatypes.guard.FrequencyLimiter:this guard policy. derived_from: tosca.datatypes.Root properties:required: false actortarget: type: string description: Specifies the Actor An optional specific VNF to apply this guard to. required: truefalse recipetime_range: type: stringtosca.datatypes.TimeInterval description: SpecifiedAn theoptional Recipe required: true time_window: type: scalar-unit.time description: The time window to count the actions againstrange of time during the day the Min/Max limit is valid for. required: true limit: type: integerfalse |
1.2 onap.policies.controlloop.guard.FrequencyLimiter Policy Type
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 policy_types: onap.policies.controlloop.guard.FrequencyLimiter: derived_from: onap.policies.controlloop.Guard version: 1.0.0 description: TheSupports limit limiting the frequency of actions being taken by required: truea Actor. constraints: - greater_than: 0properties: time_rangewindow: type: tosca.datatypes.TimeIntervalscalar-unit.time description: An optional range ofThe time duringwindow theto daycount the frequency is valid foractions against. required: falsetrue controlLoopNamelimit: type: stringinteger description: An optional specific control loop to apply this guard to.The limit required: falsetrue target: type: stringconstraints: description: An optional specific VNF to apply this guard to. required: false - greater_than: 0 |
1.3 onap.policies.controlloop.guard.Blacklist Policy Type
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 policy_types: - onap.policies.controlloop.Guard: derived_from: tosca.policies.Root version: 1.0.0 description: Guard Policies for Control Loop Operational Policies - onap.policies.controlloop.guard.Blacklist: derived_from: onap.policies.controlloop.Guard version: 1.0.0 description: Supports blacklist of VNF's from performing control loop actions on. properties: blacklist_policy: type: maplist description: List of VNF's entryrequired: true entry_schema: type: string |
1.4 onap.policies.
...
controlloop.guard.MinMax Policy Type
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 policyBlacklist data_types: - onap.policies.datatypescontrolloop.guard.BlacklistMinMax: derived_from: toscaonap.policies.datatypescontrolloop.RootGuard properties:version: 1.0.0 actordescription: Supports Min/Max number of VF Modules type properties: string description: Specifies the Actormin_vf_module_instances: requiredtype: trueinteger recipe: typerequired: stringtrue description: SpecifiedThe theminimum Recipe instances of required: truethis VF-Module time_rangemax_vf_module_instances: type: tosca.datatypes.TimeIntervalinteger descriptionrequired: Anfalse optional range of time during the day the blacklist isdescription: validThe for. maximum instances of this VF-Module |
2.0 Operational Policy Type
2.1 Mapping of existing (through El Alto) Policy YAML Operational Definition
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 topology_template: policies: - required: false controlLoopNameoperational.scaleout: type: string onap.policies.controlloop.Operational descriptionversion: An optional specific control loop to apply this guard to. 1.0.0 metadata: requiredpolicy-id: falseoperational.scaleout blacklist properties: typecontrolLoopName: list ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3 description: List of VNF's triggerOperation: unique-policy-id-1-scale-up timeout: 1200 requiredabatement: true |
onap.policies.controlloop.guard.MinMax Policy Type
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
policy_typesfalse operations: - onap.policies.controlloop.Guard: derived_from: tosca.policies.Root - versionid: 1.0.0 unique-policy-id-1-scale-up description: Guard Policies for Control Loop Operational Policies - onap.policies.controlloop.guard.MinMax: name: Create a new VF Module derived_from: onap.policies.controlloop.Guard version: 1.0.0description: description: Supports Min/Max number of VF Modules propertiesactor: SO minmax_policy: typeoperation: map VF Module Create description: entry_schematarget: type: onap.datatypes.guard.MinMax data_types: - onap.datatypes.guard.MinMax: target: VNF derived_from: tosca.datatypes.Root properties: actorpayload: type: string description: Specifies the Actor required: true recipe:requestParameters: '{"usePreload":true,"userParams":[]}' type: string description: Specified the Recipe required: true time_range: type: tosca.datatypes.TimeInterval configurationParameters: '[{"ip-addr":"$.vf-module-topology.vf-module-parameters.param[9]","oam-ip-addr":"$.vf-module-topology.vf-module-parameters.param[16]","enabled":"$.vf-module-topology.vf-module-parameters.param[23]"}]' description: An optional range of time duringretry: the0 day the Min/Max limit is valid for. requiredtimeout: false1200 controlLoopName: typesuccess: stringfinal_success description: An optional specific control loop to apply this guard to.failure: final_failure required: false min_vf_module_instances: failure_timeout: final_failure_timeout type: integer requiredfailure_retries: truefinal_failure_retries description: The minimum instances of this VF-Module max_vf_module_instances: failure_exception: final_failure_exception type: integer requiredfailure_guard: false description: The maximum instances of this VF-Module |
...
final_failure_guard
|
2.2 Use of NodeTypes and CapabilityTypes to support Actor/Operation definition - Nested approach (Agreed not to use - will retain flat structure)
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 policy_types: onap.policies.controlloop.operational.OperationalCommon: derived_from: tosca.policies.Root version: 12.0.0 description: Operational Policy for Control Loops |
Coming soon!!!
Base Policy Type with Common Data Type
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 policy_typesLoop execution properties: - onap.policies.controlloop.Rootid: derived_from type: tosca.policies.RootString version: 1.0.0 description: The unique control loop id description: Root policy type for all Control Looprequired: Policiestrue propertiestimeout: commontype: Integer description: Overall timeout for type:executing map all the operations. required: true onset: description: Common Header description: The datatype of the expected ONSET Control Loop Event entry_schema: required: true type: onap.datatypes.controlloop.Common data_types: -entry_schema: onap.datatypes.controlloop.Common: derived_fromtype: toscaonap.datatype.datatypescontrolloop.RootEvent versionabatement: 1.0.0 descriptiontype: |Boolean Thisdescription: commonWhether dataan typeabatement captureswill commonbe dataexpected thatfor is the control loop. shared between allrequired: thetrue policies for a Control Loop propertiesdefault: false operation: controlLoopName: description: Initial operation to execute upon receiving an type:Onset string event for the Control Loop. required: true entry_schema: description: The unique ID identifying the control looptype: onap.datatype.controlloop.operation.Directive onap.policies.controlloop.operational.common.Apex: filters: derived_from: onap.policies.controlloop.operational.Common version: 1.0.0 description: Operational policies for Apex PDP properties: onap.policies.controlloop.operational.common.Drools: derived_from: onap.policies.controlloop.operational.Common version: 1.0.0 description: Operational policies for Drools PDP properties: controller: description: Drools controller properties required: true entry_schema: type: onap.datatype:controlloop.controller.Drools data_types: onap.datatype.controlloop.Event: derived_from: tosca.datatypes.Root version: 1.0.0 description: Definition of the target type for operations during control loops properties: event_type: type: String required: true default: "Legacy" constraints: - valid_values: ["Legacy", "VES"] event_version: type: String required: true default: "1.0.0" onap.datatype:controlloop.controller.Drools: derived_from: tosca.datatypes.Root version: 1.0.0 description: Definition of the target type for operations during control loops properties: # TBD onap.datatype.controlloop.TargetType: derived_from: tosca.datatypes.Root version: 1.0.0 description: Definition of the target type for operations during control loops properties: target: type: String description: The type target the operation is performed against. required: true constraints: valid_values: [VNF, VM, VNFC, VFMODULE, PNF] resources: type: String description: | The resource in which the operation is be performed against. By default, an onset event will contain resource identification which should be used for the operation (if applicable) if this field is missing. onap.datatype.controlloop.Operation: derived_from: tosca.datatypes.Root version: 1.0.0 description: An operation supported by an actor properties: id: type: String description: Unique identifier for the operation required: true targettype: description: The target type supported by the operation required: true entry_schema: type: onap.datatype.controlloop.TargetType parameters: type: Map description: Optional parameters required by the operation required: false payload: type: Map description: Optional payload that is passed from the policy to the actor for operation execution. onap.datatype.controlloop.operation.Directive: derived_from: tosca.datatypes.Root version: 1.0.0 description: Policy definitions for taking actions during a Control Loop event properties: id: type: String description: Unique ID for the operation required: true description: type: String description: A user-friendly description of the directive required: false actor: description: The actor that will perform the operation required: true entry_schema: type: onap.nodetype.controlloop.Actor operation: description: The operation the actor should perform on the target required: true entry_schema: type: onap.datatype.controlloop.operation target: description: The target this operation is performed against required: true entry_schema: type: onap.datatype.controlloop.targettype timeout: type: Integer description: The amount of time for the actor to perform the operation. required: true retries: type: Integer description: The number of retries the actor should attempt to perform the operation. required: true default: 0 success: description: Points to the operation to invoke on success. required: false default: final_success entry_schema: type: onap.datatype.controlloop.operation.directive failure: description: Points to the operation to invoke on Actor operation failure. required: false default: final_failure entry_schema: type: onap.datatype.controlloop.operation.directive failure_timeout: description: Points to the operation to invoke when the time out for the operation occurs. required: false default: final_failure_timeout entry_schema: type: onap.datatype.controlloop.operation.directive failure_retries: description: Points to the operation to invoke when the current operation has exceeded its max retries. required: false default: final_failure_retries entry_schema: type: onap.datatype.controlloop.operation.directive failure_exception: description: Points to the operation to invoke when the current operation causes an exception. required: false default: final_failure_exception entry_schema: type: onap.datatype.controlloop.operation.directive failure_guard: description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement. required: false default: final_failure_guard entry_schema: type: onap.datatype.controlloop.operation.directive node_types: onap.nodetype.controlloop.Actor: derived_from: tosca.nodes.Root version: 1.0.0 description: Actor involved in executing operations in a control loop properties: id: type: String description: Unique identifier for the actor required: true capabilities: operation: type: onap.controlloop.capability.Operation capabilities: type: List description: List of operations available for the actor required: true entry_schema: type: onap.datatype.controlloop.Operation capability_types: onap.controlloop.capability.appc.ModifyConfig: derived_from: tosca.nodes.Capabilities properties: topology_template: node_templates: onap.nodetype.controlloop.actor.Appc: type: onap.nodetype.controlloop.Actor id: APPC description: APPC control loop actor capabilities: ModifyConfig: type: onap.controlloop.capability.appc.ModifyConfig onap.nodetype.controlloop.actor.AppcLcm: type: onap.nodetype.controlloop.Actor id: APPCLCM description: APPC LCM control loop actor capabilities: Restart: type: onap.controlloop.capability.appclcm.Restart Rebuild: type: onap.controlloop.capability.appclcm.Rebuild Migrate: type: onap.controlloop.capability.appclcm.Migrate ConfigModify: type: onap.controlloop.capability.appclcm.ConfigModify onap.nodetype.controlloop.actor.Cds: type: onap.nodetype.controlloop.Actor id: CDS description: CDS control loop actor capabilities: ModifyConfig: type: onap.controlloop.capability.cds.ModifyConfig onap.nodetype.controlloop.actor.Sdnc: type: onap.nodetype.controlloop.Actor id: SDNC description: SDNC control loop actor capabilities: reroute: type: onap.controlloop.capability.sdnc.reroute BandwidthOnDemand: type: onap.controlloop.capability.sdnc.BandwidthOnDemand onap.nodetype.controlloop.actor.Sdnr: type: onap.nodetype.controlloop.Actor id: SDNR description: SDNR control loop actor capabilities: ModifyConfig: type: onap.controlloop.capability.sdnr.ModifyConfig onap.nodetype.controlloop.actor.So: type: onap.nodetype.controlloop.Actor id: SO description: SO control loop actor capabilities: VFModuleCreate: type: onap.controlloop.capability.so.VFModuleCreate VFModuleDelete: type: onap.controlloop.capability.so.VFModuleDelete onap.nodetype.controlloop.actor.Vfc: type: onap.nodetype.controlloop.Actor id: VFC description: VFC control loop actor capabilities: Restart: type: onap.controlloop.capability.vfc.Restart |
2.2 Mapping using TOSCA Triggers - WIP unable to replicate requirements that were met by previous YAML structure
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0
policy_types:
onap.policies.controlloop.operational.TriggerStylePolicyType:
derived_from: tosca.policies.Root
version: 1.0.0
description: Operational Policy for Control Loop execution using Triggers
metadata:
properties:
controlLoopName:
type: string
description: The unique control loop id
required: true
timeout:
type: integer
description: Overall timeout for executing all the operations in the policy.
required: true
targets: [] # optional must be Node Types or Group Types applied to
triggers: # ?
topology_template:
policies:
-
firewall_restart:
type: onap.policies.controlloop.operational.TriggerStylePolicyType
description: vFirewall use case - APPC restart
metadata:
properties:
controlLoopName: ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a
timeout: 1200s
targets: [] # optional must be Node Templates or Groups applied to
triggers:
-
on_onset:
description: When the ONSET event is received
event_type: ControlLoopEvent
schedule:
start_time: T06:00:00Z
end_time: T23:59:59Z
target_filter:
node:
requirement:
capability:
condition:
action: # scripts?
primary: # The optional implementation artifact (i.e., the primary script file within a TOSCA CSAR file).
dependencies: # The optional ordered list of one or more dependent or secondary implementation artifacts which are referenced by the primary implementation artifact
timeout: # timeout in seconds
operation_host: # node executed on
constraint: # seems the same as condition above
period: 300s
evaluations: 3 # is this retries? The optional number of evaluations that must be performed over the period to assert the condition exists.
method: # optional statistical method name to use to perform evaluation of condition
|
2.3 Flat Structure - v1
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0
policy_types:
onap.policies.controlloop.operational.Common:
derived_from: tosca.policies.Root
version: 2.0.0
description: Operational Policy for Control Loop execution
properties:
id:
type: String
description: The unique control loop id
required: true
timeout:
type: Integer
description: Overall timeout for executing all the operations.
required: true
abatement:
type: Boolean
description: Whether an abatement event message will be expected for the control loop.
required: true
default: false
operation:
description: List of operations to be performed when Control Loop is triggered.
required: true
entry_schema:
type: onap.datatype.controlloop.Operation
trigger:
type: String
description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
required: true
onap.policies.controlloop.operational.Apex:
derived_from: onap.policies.controlloop.operational.Common
version: 1.0.0
description: Operational policies for Apex PDP
properties:
onap.policies.controlloop.operational.Drools:
derived_from: onap.policies.controlloop.operational.Common
version: 1.0.0
description: Operational policies for Drools PDP
properties:
controller:
description: Drools controller properties
required: true
entry_schema:
type: onap.datatype:controlloop.controller.Drools
data_types:
onap.datatype.controlloop.controller.Drools:
derived_from: tosca.datatypes.Root
version: 1.0.0
description: Definition of the target type for operations during control loops
properties:
onap.datatype.controlloop.Operation:
derived_from: tosca.datatypes.Root
version: 1.0.0
description: An operation supported by an actor
properties:
id:
type: String
description: Unique identifier for the operation
required: true
description:
type: String
description: A user-friendly description of the intent for the operation
required: false
actor:
type: String
description: The actor that will perform the operation
required: true
operation:
type: String
description: The operation the actor should perform on the target
required: true
target:
type: String
description: The target the operation is to be performed on.
required: true
payload:
type: Map
description: Optional payload that is passed from the policy to the actor for operation execution.
required: false
timeout:
type: Integer
description: The amount of time for the actor to perform the operation.
required: true
retries:
type: Integer
description: The number of retries the actor should attempt to perform the operation.
required: true
default: 0
success:
type: String
description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
required: false
default: final_success
failure:
type: String
description: Points to the operation to invoke on Actor operation failure.
required: false
default: final_failure
failure_timeout:
description: Points to the operation to invoke when the time out for the operation occurs.
required: false
default: final_failure_timeout
failure_retries:
description: Points to the operation to invoke when the current operation has exceeded its max retries.
required: false
default: final_failure_retries
failure_exception:
description: Points to the operation to invoke when the current operation causes an exception.
required: false
default: final_failure_exception
failure_guard:
description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.
required: false
default: final_failure_guard
|
2.3 Flat Structure - v2
Flat Structure vs - use of metadata and actor as a datatype
| Code Block | ||||
|---|---|---|---|---|
| ||||
tosca_definitions_version: tosca_simple_yaml_1_0_0
policy_types:
onap.policies.controlloop.operational.Common:
derived_from: tosca.policies.Root
version: 1.0.0
description: Operational Policy for Control Loop execution
properties:
id:
type: String
description: The unique control loop id.
required: true
timeout:
type: Integer
description: |
Overall timeout for executing all the operations. This timeout should equal or exceed the total
timeout for each operation listed.
required: true
abatement:
type: Boolean
description: Whether an abatement event message will be expected for the control loop from DCAE.
required: true
default: false
trigger:
type: String
description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
required: true
operations:
description: List of operations to be performed when Control Loop is triggered.
required: true
entry_schema:
type: onap.datatype.controlloop.Operation
onap.policies.controlloop.operational.common.Apex:
derived_from: onap.policies.controlloop.operational.Common
type_version: 1.0.0
version: 1.0.0
description: Operational policies for Apex PDP
properties:
onap.policies.controlloop.operational.common.Drools:
derived_from: onap.policies.controlloop.operational.Common
type_version: 1.0.0
version: 1.0.0
description: Operational policies for Drools PDP
properties:
controller:
description: Drools controller properties
required: true
entry_schema:
type: onap.datatype.controlloop.controller.Drools
data_types:
onap.datatype.controlloop.controller.Drools:
derived_from: tosca.datatypes.Root
description: Definition of the target type for operations during control loops
properties:
controllerName:
type: String
description: The id of the Drools controller the policy should be loaded in.
required: false
onap.datatype.controlloop.operation.Failure:
derived_from: tosca.datatypes.Root
description: Captures information of an operational failure performed for control loop
properties:
messages:
type: String
description: error message
required: true
category:
type: String
description: |
The category the error occurred in. Whether this is a general error from the actor, or the operation
timed out, retries were exhausted in trying to execute the operation, a guard policy prevented the
operation from occuring, or an exception in the system caused the failure.
constraints:
- valid_values: [error, timeout, retries, guard, exception]
onap.datatype.controlloop.Target:
derived_from: tosca.datatypes.Root
description: Definition for a entity in A&AI to perform a control loop operation on
properties:
targetType:
type: String
description: Category for the target type
required: true
constraints:
- valid_values: [VNF, VM, VFMODULE, PNF]
entityIds:
type: Map
description: |
Map of values that identify the resource. If none are provided, it is assumed that the
entity that generated the ONSET event will be the target.
required: false
onap.datatype.controlloop.Actor:
derived_from: tosca.datatypes.Root
description: An actor/operation/target definition
properties:
actor:
type: String
description: The actor performing the operation.
required: true
operation:
type: String
description: The operation the actor is performing.
required: true
target:
type: String
description: The resource the operation should be performed on.
required: true
metadata:
clamp_csar_lookup: csar_plugin
payload:
type: Map
description: Name/value pairs of payload information passed by Policy to the actor
required: false
onap.datatype.controlloop.Operation:
derived_from: tosca.datatypes.Root
description: An operation supported by an actor
properties:
id:
type: String
description: Unique identifier for the operation
required: true
description:
type: String
description: A user-friendly description of the intent for the operation
required: false
operation:
description: The definition of the operation to be performed.
required: true
metadata:
clamp_catalog: get_operations
entry_schema:
type: onap.datatype.controlloop.Actor
timeout:
type: Integer
description: The amount of time for the actor to perform the operation.
required: true
retries:
type: Integer
description: The number of retries the actor should attempt to perform the operation.
required: true
default: 0
success:
type: String
description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
required: false
default: final_success
failure:
type: String
description: Points to the operation to invoke on Actor operation failure.
required: false
default: final_failure
failure_timeout:
description: Points to the operation to invoke when the time out for the operation occurs.
required: false
default: final_failure_timeout
failure_retries:
description: Points to the operation to invoke when the current operation has exceeded its max retries.
required: false
default: final_failure_retries
failure_exception:
description: Points to the operation to invoke when the current operation causes an exception.
required: false
default: final_failure_exception
failure_guard:
description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.
required: false
default: final_failure_guard
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0
topology_template:
policies:
- operational.modifyconfig:
type: onap.policies.controlloop.operational.common.Drools
type_version: 1.0.0
version: 1.0.0
metadata:
policy-id: operational.modifyconfig
properties:
id: ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a
timeout: 1200
abatement: false
trigger: unique-policy-id-1-modifyConfig
operations:
- id: unique-policy-id-1-modifyConfig
description: Modify the packet generator
operation:
actor: APPC
operation: ModifyConfig
target:
targetType: VNF
entityId:
resourceID: bbb3cefd-01c8-413c-9bdd-2b92f9ca3d38
timeout: 300
retries: 0
success: final_success
failure: final_failure
failure_timeout: final_failure_timeout
failure_retries: final_failure_retries
failure_exception: final_failure_exception
failure_guard: final_failure_guard
controllerName: usecases
- operational.restart:
type: onap.policies.controlloop.operational.common.Drools
type_version: 1.0.0
version: 1.0.0
metadata:
policy-id: operational.restart
properties:
id: ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e
timeout: 3600
abatement: true
trigger: unique-policy-id-1-restart
operations:
- id: unique-policy-id-1-restart
description: Restart the VM
operation:
actor: APPC
recipe: Restart
target:
type: VNF
timeout: 1200
retries: 3
success: final_success
failure: final_failure
failure_timeout: final_failure_timeout
failure_retries: final_failure_retries
failure_exception: final_failure_exception
failure_guard: final_failure_guard
controllerName: usecases
- operational.scaleout:
type: onap.policies.controlloop.operational.common.Drools
type_version: 1.0.0
version: 1.0.0
metadata:
policy-id: operational.scaleout
properties:
id: ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3
timeout: 1200
abatement: false
trigger: unique-policy-id-1-scale-up
operations:
- id: unique-policy-id-1-scale-up
description: Create a new VF Module
operation:
actor: SO
operation: VF Module Create
target:
type: VFMODULE
entityIds:
modelInvariantId: e6130d03-56f1-4b0a-9a1d-e1b2ebc30e0e
modelVersionId: 94b18b1d-cc91-4f43-911a-e6348665f292
modelName: VfwclVfwsnkBbefb8ce2bde..base_vfw..module-0
modelVersion: 1
modelCustomizationId: 47958575-138f-452a-8c8d-d89b595f8164
payload:
requestParameters: '{"usePreload":true,"userParams":[]}'
configurationParameters: '[{"ip-addr":"$.vf-module-topology.vf-module-parameters.param[9]","oam-ip-addr":"$.vf-module-topology.vf-module-parameters.param[16]","enabled":"$.vf-module-topology.vf-module-parameters.param[23]"}]'
timeout: 1200
retries: 0
success: final_success
failure: final_failure
failure_timeout: final_failure_timeout
failure_retries: final_failure_retries
failure_exception: final_failure_exception
failure_guard: final_failure_guard
controllerName: usecases
- operational.modifyconfig.cds:
type: onap.policies.controlloop.operational.common.Drools
type_version: 1.0.0
version: 1.0.0
metadata:
policy-id: operational.modifyconfig.cds
properties:
id: ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a
timeout: 1200
abatement: false
trigger: unique-policy-id-1-modifyConfig
operations:
- id: unique-policy-id-1-modifyConfig
description: Modify the packet generator
operation:
actor: APPC
operation: ModifyConfig
target:
targetType: VNF
entityId:
resourceID: bbb3cefd-01c8-413c-9bdd-2b92f9ca3d38
payload:
artifact_name: vfw-cds
artifact_version: 1.0.0
mode: async
data: '{"mapInfo":{"key":"val"},"arrayInfo":["one","two"],"paramInfo":"val"}'
timeout: 300
retries: 0
success: final_success
failure: final_failure
failure_timeout: final_failure_timeout
failure_retries: final_failure_retries
failure_exception: final_failure_exception
failure_guard: final_failure_guard
controllerName: usecases |
Issue: The "policies" property can be confusing with the TOSCA Topology Template value "policies".
- Pamela Dragosh - use "operations" instead since it really is a set of operations that are really being enforced.
Issue: How to ensure that CLAMP does not have to hard-code the meaning of properties. Specifically, success, failure, failure_timeout etc. - need to point to other actor/recipe's to be triggered/executed.
Issue: How to ensure that CLAMP does not have to hard-code where CSAR details need to be populated in the policy. Eg. Target Type
- Need to use defaults, descriptions, constraints, required fields
- Pam and Liam will work on Operational policies to look like Seb's JSON schema so Seb can test it out. Then identify next problem to solve.
Seb's JSON schema from El Alto:
Issue: TOSCA Constraints would be nice to have something with suggested values, so the policy isn't locked into a set of values. Example is "actors" - ONAP has a set of actors, but it would be nice to be able to extend to other internal actors companies support.
| Code Block |
|---|
# REST of policy ommitted for brevity
onap.datatype.controlloop.operationalpolicies:
derived_from: tosca.datatypes.Root
version: 1.0.0
description: Policy definitions for taking actions during a Control Loop event
properties:
# other properties ommitted for brevity
actor:
type: String
description: The actor that will perform the operation
required: true
constraints:
possible_values: [SO, SDNC, APPC, VFC, SNDR, CDS]
|
Issue: TOSCA does NOT have a way to relate properties together. For example, if the actor property is selected as APPC, then the contraints (eg possible values) for the operation property SHOULD be "restart", "reboot", "modifyConfig". How can that be specified?
Issue: Can/Should we consolidate onap.policies.Operational into a common policy type and then allow Drools and Apex (or be extendable to companies ingesting ONAP) to be derived_from that policy.
Question: Should the actor be a capability? If its a datatype, then you cannot pre-define them. A capability type would allow us to predefine actors as well as allow companies that ingest ONAP to create their own.
Question: How does CLAMP call CDS API for blueprint information? to be filled in
TODO: Pam add examples.
Question: If CSAR is prepopulated with datatypes and policytypes, how would one design a PNF control loop? Do we need a PNF service distributed to it to "kick off"?
- Possible to have re-usable Operations?
- Jorge Hernandez will investigate re-usable operations
- Issue: Flat structure vs Nested structure
- Jorge Hernandez will investigate flat policies (old way)
- Pamela Dragosh will investigate nested policies
- Issue: We should define the incoming event that triggers the Control Loop Pamela Dragosh will add this definition
- Current ControlLoopEvent structure
- Future possible VES Events
- Possible that status of a policy execution may need to be an event for reusable operations
- Issue: Should it be capability_type or relationship for the Actor operations??
- undefined undefined will investigate
- Liam Fallon and Ram Krishna Verma will look into Apex Operational Policy.
- Issue: Can we specify the guard policies into the operational policies? Do we make guard optional in policy operational directive executive? How to make it available to all PDP engines?
- Issue: Other policies needed such as is-closed-loop-disable=true and prov_status=in-maint:
Jira server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key POLICY-1071 - Issue: A&AI how to specify which VNF to take directive on. What about PNF?
- Could switch to where a selection of the operation constrains the actor.
- Instead of specify BOTH actor and operation, select an operation and then the actor supported by the operation.
Issue: Policies and Reusable Operations Action Item Follow up - Jorge Hernandez
A nested policy approach has the following issues:
- Number of hierarchical layers, which must be bounded. The CLAMP GUI driven by an open ended "recursive" schema would have to be bounded. One could argue that after N hierarchical layers, the information would be hard to be tracked by a human operator.
- Associated with the number of hierarchical layers, and the most important issue is the duplication of operations, as duplicated operations would be repeated at multiple levels, and branches.
- Associated with (2), there are issues of conciseness and human readability of policies.
- A smaller issue relates to the storage space in the policy repository as it would likely require more space due to dups operations across levels.
- A smaller issue relates to come up with canonical representation of policies and operations, policies will have to be flattened out and put in a canonical representation to support static analysis on the policy repo, for example for conflict detection.
The main benefits for nested operations over a flat structure are:
- Clearly drive the GUI display and the user input (may be more intuitive), and
- if the operations are fairly simple (policies mono-operational) which is the high runner case at this time (minimum duplication).
- Recommendation is to stay with the flat structure previously used vs nested. Not ideal but use description field as a way of instructing the user on what values to put in the fields.
- Determined that we need a catalog for actors/operations and what target they work on
Actor Catalog needs to capture this information:
| Code Block |
|---|
catalog: appc: ModifyConfig: [VNF] type: mapappclcm: ModifyConfig: [VNF] requiredRestart: false[VNF] Rebuild: [VNF] description: A map of service, vnf, pnf filters for the policyMigrate: [VNF] entry_schemaso: VF Module Create: [VFModule] VF Module type: onap.datatypes.controlloop.FilterDelete: [VFModule] -cds: onap.datatypes.controlloop.Filter:ModifyConfig: [VNF, PNF] sdnc: derived_fromreroute: tosca.datatypes.Root[VNF] versionBandwidthOnDemand: 1.0.0[VNF] sdnr: propertiesModifyConfig: [PNF] vfc: # TODO Restart: [VNF] |
Proposal is to use "metadata" field in order to instruct CLAMP on where to lookup actor information and how to apply logic around looking up information in the CSAR for actor/operation.