...
| 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 of guard Policies for Control Loop Operational Policies
properties:
actor:
type: string
description: Specifies the Actor
required: true
recipeoperation:
type: string
description: Specified the Recipe
required: true
controlLoopName:
type: string
description: An optional specific control loop to apply this guard policy.
required: false
target:
type: string
description: An optional specific VNF to apply this guard to.
required: false
time_range:
type: tosca.datatypes.TimeInterval
description: An optional range of time during the day the Min/Max limit is valid for.
required: false
|
...
2.1 Mapping of existing (through El Alto) Policy YAML Operational Definition
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 policytopology_typestemplate: typepolicies: onap.policies.controlloop.Operational version: 1.0.0 - description: Operational Policy for Control Loop execution operational.scaleout: properties: controlLoopName:type: onap.policies.controlloop.Operational typeversion: string1.0.0 descriptionmetadata: The unique control loop id policy-id: operational.scaleout required: true timeoutproperties: type: integer controlLoopName: ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3 descriptiontriggerOperation: Overall timeout for executing all the operations in the policy. unique-policy-id-1-scale-up timeout: 1200 required: true abatement: false type operations: boolean description: Whether an abatement- will be expected for the control loop. id: unique-policy-id-1-scale-up requiredname: true Create a new VF Module default: false triggerOperationdescription: type: string actor: SO description: Id of the operation to be triggered when receivingoperation: anVF OnsetModule eventCreate required: true operationstarget: type: list target: VNF description: List of operations executed upon receiving an Onset event for the Control Loop.payload: required: true requestParameters: '{"usePreload":true,"userParams":[]}' entry_schema: type: onap.datatype.controlloop.operational policies data_types: onap.datatype.controlloop.targettypes: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]"}]' derived_from: tosca.datatypes.Root versionretry: 1.0.0 description: Definition of the target type for operations during controltimeout: loops1200 properties: success: final_success target: typefailure: Stringfinal_failure descriptionfailure_timeout: The type target the operation is performed against. final_failure_timeout required: truefailure_retries: final_failure_retries constraints: valid_values: [VNF, VM, VNFC, VFMODULE] failure_exception: final_failure_exception resources: failure_guard: 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.Common: type: String descriptionderived_from: |tosca.policies.Root version: 2.0.0 description: Operational Policy Thefor resourceControl inLoop whichexecution the operation is be performed against. By default,properties: id: an onset event will contain resource identification which should be usedtype: String description: The unique control forloop theid operation (if applicable) if this field is missing. onap.datatype.controlloop.operationalpolicies: required: true derived_from: tosca.datatypes.Root version: 1.0.0timeout: description: Policy definitions for taking actions during a Control Loop eventtype: Integer properties: description: Overall timeout for id: executing all the operations. type required: Stringtrue onset: description: ID for the policy. Used by triggerPolicy and final_* events to indicate next policy to enforce. description: The datatype of the expected ONSET Control Loop Event required: true description: entry_schema: type: String type: onap.datatype.controlloop.Event description: A user-friendly description of the policyabatement: requiredtype: falseBoolean actor: description: Whether an abatement will be expected for the type: Stringcontrol loop. descriptionrequired: The actor that will perform the operationtrue requireddefault: truefalse operation: typedescription: String Initial operation to execute upon receiving an Onset event for the Control Loop. description: The operation the actor should perform on the target required: true required: true entry_schema: target: type: onap.datatype.controlloop.operation.Directive description: The target this operation is performed against onap.policies.controlloop.operational.common.Apex: derived_from: onap.policies.controlloop.operational.Common version: 1.0.0 required: true description: Operational policies for Apex PDP entry_schemaproperties: onap.policies.controlloop.operational.common.Drools: derived_from: onap.policies.controlloop.operational.Common typeversion: onap1.datatype0.controlloop.targettypes0 description: Operational policies for payload: Drools PDP properties: typecontroller: Map description: Drools controller properties required: falsetrue entry_schema: type: String onap.datatype:controlloop.controller.Drools timeout: type: Integer data_types: onap.datatype.controlloop.Event: description derived_from: The amount of time for the actor to perform the operation.tosca.datatypes.Root version: 1.0.0 description: Definition of the target type for operations during required:control trueloops successproperties: event_type: String descriptiontype: Points to the operation to invoke on success.String required: falsetrue default: final_success"Legacy" failure: constraints: type: String - valid_values: ["Legacy", "VES"] description: Points to the operation to invoke on Actor operation failure. event_version: requiredtype: falseString defaultrequired: final_failuretrue failure_timeout: default: "1.0.0" onap.datatype:controlloop.controller.Drools: typederived_from: Stringtosca.datatypes.Root version: 1.0.0 description: PointsDefinition toof the operationtarget totype invokefor whenoperations theduring timecontrol outloops for the operation occurs. properties: required:# falseTBD default: final_failure_timeoutonap.datatype.controlloop.TargetType: failure_retries:derived_from: tosca.datatypes.Root version: 1.0.0 typedescription: String Definition of the target type for operations during control loops descriptionproperties: Points to the operation to invoke when the current operation has exceeded its max retries. target: requiredtype: falseString defaultdescription: final_failure_retries The type target the operation is performed against. failure_exception: typerequired: Stringtrue descriptionconstraints: Points to the operation to invoke when the current operation causes an exception. valid_values: [VNF, VM, VNFC, required: falseVFMODULE, PNF] resources: default: final_failure_exception failure_guardtype: String typedescription: String| description: Points to the operationThe toresource invokein whenwhich the current operation is blockedbe dueperformed toagainst. guard policy enforcement.By default, required: false an onset event will contain resource identification which should be used default: final_failure_guard | ||||||||
| Code Block | ||||||||
| ||||||||
tosca_definitions_version: tosca_simple_yaml_1_0_0 topology_template: policies: for - the operation (if applicable) if this field is operationalmissing.scaleout: type: onap.policiesdatatype.controlloop.Operational Operation: derived_from: tosca.datatypes.Root version: 1.0.0 description: An operation metadata: supported by an actor policy-idproperties: operational.scaleout propertiesid: controlLoopName: ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3 type: String triggerOperation: unique-policy-id-1-scale-up description: Unique identifier for the operation timeout: 1200 abatementrequired: falsetrue operationstargettype: - iddescription: unique-policy-id-1-scale-up The target type supported by the operation name: Create a new VFrequired: Moduletrue descriptionentry_schema: actortype: SOonap.datatype.controlloop.TargetType parameters: operation type: VFMap Module Create description: Optional parameters target: required by the operation targetrequired: VNFfalse payload: payload: type: Map requestParameters: '{"usePreload":true,"userParams":[]}' description: Optional payload that is passed from the policy to the actor for operation execution. 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]"}]' onap.datatype.controlloop.operation.Directive: derived_from: tosca.datatypes.Root retryversion: 1.0.0 description: Policy definitions for taking actions during a Control timeout:Loop 1200event properties: success: final_success id: type: String description: Unique ID for failure: final_failurethe operation failure_timeoutrequired: final_failure_timeouttrue description: failure_retries: final_failure_retries type: String description: A failure_exception: final_failure_exceptionuser-friendly description of the directive failure_guardrequired: final_failure_guard |
Issue: The "policies" property can be confusing with the TOSCA Topology Template value "policies".
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:
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]
appclcm:
ModifyConfig: [VNF]
Restart: [VNF]
Rebuild: [VNF]
Migrate: [VNF]
so:
VF Module Create: [VFModule]
VF Module Delete: [VFModule]
cds:
ModifyConfig: [VNF, PNF]
sdnc:
reroute: [VNF]
BandwidthOnDemand: [VNF]
sdnr:
ModifyConfig: [PNF]
vfc:
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.https://gerrit.onap.org/r/gitweb?p=clamp.git;a=blob;f=src/main/resources/clds/json-schema/operational_policies/operational_policy.json;h=93738c80923be027781b9c2bf0fe72cfa82d7fec;hb=HEAD