Page History

tosca_definitions_version: tosca_simple_yaml_1_0_0
policy_types:
    onap.policies.controlloop.operational.Common:
        derived_from: tosca.policies.Root
        version: 21.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
            operationtrigger:
                descriptiontype: ListString
 of operations to be performed when Control Loop is triggered.
      description: Initial operation to execute upon receiving an Onset  required: trueevent message for the Control Loop.
                entry_schemarequired: true
            operations:
        type: onap.datatype.controlloop.Operation
       description: List of operations to trigger:
be performed when Control Loop is triggered.
          type: String
     required: true
          description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
 entry_schema:
                    requiredtype: trueonap.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
        versiondescription: 1.0.0
        description: Definition of the target type for operations during control loops
        properties:
        
    onap.datatype.controlloop.ActorcontrollerName:
        derived_from: tosca.datatypes.Root
        versiontype: 1.0.0String
        description: An actor/operation/target definition
     description: The id properties:
of the Drools controller the policy should be loaded in.
   actor:
             required: false

    type: Stringonap.datatype.controlloop.operation.Failure:
        derived_from: tosca.datatypes.Root
       required description: true
Captures information of an operational failure performed for control loop
    operation:
    properties:
            typemessages: String
                requiredtype: trueString
             target:   description: error message
                typerequired: Stringtrue
            category:
    description: The resource the operation should be performed on
    type: String
           required: true
    description: |
           metadata:
         The category the error occurred in. Whether this is a  clamp_csar_lookup: csar_plugin
     general error from the actor, or the operation
       payload:
             timed out, retries type:were Map
exhausted in trying to execute the operation, a guard policy prevented the
     description: Name/value pairs of payload information passed by Policy to the actor
    operation from occuring, or an exception in the system caused   required: falsethe failure.
    
            constraints:
                
    - valid_values: [error, timeout, retries, guard, exception]

    onap.datatype.controlloop.OperationTarget:
        derived_from: tosca.datatypes.Root
        versiondescription: 1.0.0
        description: An operation supported by an actorDefinition for a entity in A&AI to perform a control loop operation on
        properties:
            idtargetType:
                type: String
                description: UniqueCategory identifier for the target operationtype
                required: true
             description   constraints:
                type- valid_values: String
   [VNF, VM, VFMODULE, PNF]
             descriptionentityIds:
 A user-friendly description of the intent for the operation
       type: Map
        required: false
       description: |
    operation:
                description:Map Theof actorvalues that will performidentify the operation
resource. If none are provided, it is assumed that the
       required: true
            entity that generated the metadata:
ONSET event will be the target.
                clamp_catalogrequired: get_operationsfalse

    onap.datatype.controlloop.Actor:
            entry_schema:derived_from: tosca.datatypes.Root
        description: An actor/operation/target definition
         type: onap.datatype.controlloop.Actorproperties:
            timeoutactor:
                type: IntegerString
                description: The amount of time for the actor to performperforming the operation.
                required: true
            retriesoperation:
                type: IntegerString
                description: The numberoperation of retries the actor should attempt to perform the operationis performing.
                required: true
            target:
    default: 0
           type: success:String
                typedescription: String
The resource the operation should be performed on.
         description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
required: true
                metadata:
      required: false
                defaultclamp_csar_lookup: finalcsar_successplugin
            failurepayload:
                type: StringMap
                description: Points to the operation to invoke on Actor operation failure.Name/value pairs of payload information passed by Policy to the actor
                required: false

    onap.datatype.controlloop.Operation:
        derived_from: tosca.datatypes.Root
   default: final_failure
    description: An operation supported by an actor
  failure_timeout:
      properties:
          description: Points to the operation to invoke when the time out  id:
                type: String
                description: Unique identifier for the operation occurs.
                required: falsetrue
            description:
    default: final_failure_timeout
            failure_retries:type: String
                description: Points to A user-friendly description of the intent for the operation to invoke when the current operation has exceeded its max retries.
                required: false
            operation:
                requireddescription: false
     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