src/test/resources/http-cache/example/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Apex/versions/1.0.0?connectionTimeToLive=5000/.file

   1 tosca_definitions_version: tosca_simple_yaml_1_1_0
   2 policy_types:
   3     onap.policies.controlloop.operational.common.Apex:
   4         derived_from: onap.policies.controlloop.operational.Common
   5         type_version: 1.0.0
   6         version: 1.0.0
   7         description: Operational policies for Apex PDP
   8         properties:
   9             engineServiceParameters:
  10                 type: string
  11                 description: The engine parameters like name, instanceCount, policy implementation, parameters etc.
  12                 required: true
  13             eventInputParameters:
  14                 type: string
  15                 description: The event input parameters.
  16                 required: true
  17             eventOutputParameters:
  18                 type: string
  19                 description: The event output parameters.
  20                 required: true
  21             javaProperties:
  22                 type: string
  23                 description: Name/value pairs of properties to be set for APEX if needed.
  24                 required: false
  25     onap.policies.controlloop.operational.Common:
  26         derived_from: tosca.policies.Root
  27         version: 1.0.0
  28         description: |
  29             Operational Policy for Control Loop execution. Originated in Frankfurt to support TOSCA Compliant
  30             Policy Types. This does NOT support the legacy Policy YAML policy type.
  31         properties:
  32             id:
  33                 type: string
  34                 description: The unique control loop id.
  35                 required: true
  36             timeout:
  37                 type: integer
  38                 description: |
  39                     Overall timeout for executing all the operations. This timeout should equal or exceed the total
  40                     timeout for each operation listed.
  41                 required: true
  42             abatement:
  43                 type: boolean
  44                 description: Whether an abatement event message will be expected for the control loop from DCAE.
  45                 required: true
  46                 default: false
  47             trigger:
  48                 type: string
  49                 description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
  50                 required: true
  51             operations:
  52                 type: list
  53                 description: List of operations to be performed when Control Loop is triggered.
  54                 required: true
  55                 entry_schema:
  56                     type: onap.datatype.controlloop.Operation
  57 data_types:
  58     onap.datatype.controlloop.Target:
  59         derived_from: tosca.datatypes.Root
  60         description: Definition for a entity in A&AI to perform a control loop operation on
  61         properties:
  62             targetType:
  63                 type: string
  64                 description: Category for the target type
  65                 required: true
  66                 constraints:
  67                 - valid_values: [VNF, VM, VFMODULE, PNF]
  68             entityIds:
  69                 type: map
  70                 description: |
  71                     Map of values that identify the resource. If none are provided, it is assumed that the
  72                     entity that generated the ONSET event will be the target.
  73                 required: false
  74                 entry_schema:
  75                     type: string
  76
  77     onap.datatype.controlloop.Actor:
  78         derived_from: tosca.datatypes.Root
  79         description: An actor/operation/target definition
  80         properties:
  81             actor:
  82                 type: string
  83                 description: The actor performing the operation.
  84                 required: true
  85             operation:
  86                 type: string
  87                 description: The operation the actor is performing.
  88                 required: true
  89             target:
  90                 type: onap.datatype.controlloop.Target
  91                 description: The resource the operation should be performed on.
  92                 required: true
  93                 metadata:
  94                     clamp_possible_values: <string:see clamp project for syntax>
  95             payload:
  96                 type: map
  97                 description: Name/value pairs of payload information passed by Policy to the actor
  98                 required: false
  99                 entry_schema:
 100                     type: string
 101
 102     onap.datatype.controlloop.Operation:
 103         derived_from: tosca.datatypes.Root
 104         description: An operation supported by an actor
 105         properties:
 106             id:
 107                 type: string
 108                 description: Unique identifier for the operation
 109                 required: true
 110             description:
 111                 type: string
 112                 description: A user-friendly description of the intent for the operation
 113                 required: false
 114             operation:
 115                 type: onap.datatype.controlloop.Actor
 116                 description: The definition of the operation to be performed.
 117                 required: true
 118                 metadata:
 119                     clamp_possible_values: <string:see clamp project for syntax>
 120             timeout:
 121                 type: integer
 122                 description: The amount of time for the actor to perform the operation.
 123                 required: true
 124             retries:
 125                 type: integer
 126                 description: The number of retries the actor should attempt to perform the operation.
 127                 required: true
 128                 default: 0
 129             success:
 130                 type: string
 131                 description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
 132                 required: false
 133                 default: final_success
 134             failure:
 135                 type: string
 136                 description: Points to the operation to invoke on Actor operation failure.
 137                 required: false
 138                 default: final_failure
 139             failure_timeout:
 140                 type: string
 141                 description: Points to the operation to invoke when the time out for the operation occurs.
 142                 required: false
 143                 default: final_failure_timeout
 144             failure_retries:
 145                 type: string
 146                 description: Points to the operation to invoke when the current operation has exceeded its max retries.
 147                 required: false
 148                 default: final_failure_retries
 149             failure_exception:
 150                 type: string
 151                 description: Points to the operation to invoke when the current operation causes an exception.
 152                 required: false
 153                 default: final_failure_exception
 154             failure_guard:
 155                 type: string
 156                 description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.
 157                 required: false
 158                 default: final_failure_guard