tosca_definitions_version: tosca_simple_yaml_1_0_0
policy_types:
type: onap.policies.controlloop.Operationaloperational.Simple
version: 1.0.0
description: Operational Policy for Control Loop execution
properties:
controlLoopName:
type: stringString
description: The unique control loop id
required: true
timeout:
type: integerInteger
description: Overall timeout for executing all the operations in the policy.
required: true
abatement:
type: booleanBoolean
description: Whether an abatement will be expected for the control loop.
required: true
default: false
triggerOperationtriggerOperationId:
type: stringString
description: Id of the operation to be triggered when receiving an Onset event
required: true
operations:
type: list
description: List of operations executed upon receiving an Onset event for the Control Loop.
required: true
entry_schema:
type: onap.datatype.controlloop.operational policies.operation.directive
data_types:
onap.datatype.controlloop.targettypestargettype:
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.operationalpoliciesoperation:
derived_from: tosca.datatypes.Root
version: 1.0.0
description: PolicyAn definitionsoperation forsupported takingby actions during a Control Loop eventan actor
properties:
id:
type: String
description: IDUnique identifier for the policy.operation
Used by triggerPolicy and final_* events to indicate next policy to enforce.
required: true
requiredtargettype:
true
description: The target type supported by the operation
typerequired: Stringtrue
descriptionentry_schema:
A user-friendly description of the policy
requiredtype: falseonap.datatype.controlloop.targettype
actorparameters:
type: StringMap
description: TheOptional actorparameters thatrequired willby perform the operation
required: truefalse
operationpayload:
type: StringMap
description: The operation the actor should perform on the target Optional payload that is passed from the policy to the actor for operation execution.
onap.datatype.controlloop.actor:
requiredderived_from: truetosca.datatypes.Root
version: 1.0.0
target:
description: Actor involved in executing operations in a control loop
description: The target this operation is performed againstproperties:
required: trueid:
entry_schematype: String
typedescription: onap.datatype.controlloop.targettypes
payload:Unique identifier for the actor
typerequired: Maptrue
description:
requiredtype: falseString
entry_schemadescription:
Optional description of the actor
type required: Stringfalse
timeoutoperations:
type: IntegerList
description: The amount of time for the actor List of operations available for the actor
required: true
entry_schema:
type: onap.datatype.controlloop.operation
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: ID for the policy. Used by triggerPolicy and final_* events to indicate next policy to enforce.
required: true
description:
type: String
description: A user-friendly description of the policy
required: false
actor:
description: The actor that will perform the operation
required: true
entry_schema:
type: onap.datatype.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
success:
default: 0
typesuccess: String
description: Points to the operation to invoke on success.
required: false
default: final_success
success
entry_schema:
failure:
type: onap.datatype.controlloop.operation.directive
typefailure: String
description: Points to the operation to invoke on Actor operation failure.
required: false
default: final_failure
failure_timeout entry_schema:
type: String 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
failure_retries:
entry_schema:
type: onap.datatype.controlloop.operation.directive
typefailure_retries: String
description: Points to the operation to invoke when the current operation has exceeded its max retries.
required: false
default: final_failure_retries
failure_exception:
entry_schema:
type: onap.datatype.controlloop.operation.directive
failure_exception: String
description: Points to the operation to invoke when the current operation causes an exception.
required: false
default: final_failure_exception
failure_guard:
entry_schema:
type: onap.datatype.controlloop.operation.directive
typefailure_guard: String
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
| 