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