src/test/resources/tosca/base.yaml

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