aboutsummaryrefslogtreecommitdiffstats
path: root/src/test/resources/http-cache/example/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Apex/versions/1.0.0/.file
blob: 14ae7acd89133af18158c716c5a085784dd1862a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
tosca_definitions_version: tosca_simple_yaml_1_1_0
policy_types:
    onap.policies.controlloop.operational.Common:
        properties:
            abatement:
                name: abatement
                type: boolean
                typeVersion: 0.0.0
                description: Whether an abatement event message will be expected for
                    the control loop from DCAE.
                default: 'false'
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            operations:
                name: operations
                type: list
                typeVersion: 0.0.0
                description: List of operations to be performed when Control Loop
                    is triggered.
                required: true
                constraints: [
                    ]
                entry_schema:
                    type: onap.datatype.controlloop.Operation
                    typeVersion: 0.0.0
                    constraints: [
                        ]
                metadata: {
                    }
            trigger:
                name: trigger
                type: string
                typeVersion: 0.0.0
                description: Initial operation to execute upon receiving an Onset
                    event message for the Control Loop.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            timeout:
                name: timeout
                type: integer
                typeVersion: 0.0.0
                description: |
                    Overall timeout for executing all the operations. This timeout should equal or exceed the total
                    timeout for each operation listed.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            id:
                name: id
                type: string
                typeVersion: 0.0.0
                description: The unique control loop id.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
        name: onap.policies.controlloop.operational.Common
        version: 1.0.0
        derived_from: tosca.policies.Root
        metadata: {
            }
        description: |
            Operational Policy for Control Loop execution. Originated in Frankfurt to support TOSCA Compliant
            Policy Types. This does NOT support the legacy Policy YAML policy type.
    onap.policies.controlloop.operational.common.Apex:
        properties:
            engineServiceParameters:
                name: engineServiceParameters
                type: string
                typeVersion: 0.0.0
                description: The engine parameters like name, instanceCount, policy
                    implementation, parameters etc.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            eventOutputParameters:
                name: eventOutputParameters
                type: string
                typeVersion: 0.0.0
                description: The event output parameters.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            javaProperties:
                name: javaProperties
                type: string
                typeVersion: 0.0.0
                description: Name/value pairs of properties to be set for APEX if
                    needed.
                required: false
                constraints: [
                    ]
                metadata: {
                    }
            eventInputParameters:
                name: eventInputParameters
                type: string
                typeVersion: 0.0.0
                description: The event input parameters.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
        name: onap.policies.controlloop.operational.common.Apex
        version: 1.0.0
        derived_from: onap.policies.controlloop.operational.Common
        metadata: {
            }
        description: Operational policies for Apex PDP
data_types:
    onap.datatype.controlloop.Actor:
        constraints: [
            ]
        properties:
            payload:
                name: payload
                type: map
                typeVersion: 0.0.0
                description: Name/value pairs of payload information passed by Policy
                    to the actor
                required: false
                constraints: [
                    ]
                entry_schema:
                    type: string
                    typeVersion: 0.0.0
                    constraints: [
                        ]
                metadata:
                    clamp_possible_values: ClampExecution:CDS/payload
            target:
                name: target
                type: onap.datatype.controlloop.Target
                typeVersion: 0.0.0
                description: The resource the operation should be performed on.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            actor:
                name: actor
                type: string
                typeVersion: 0.0.0
                description: The actor performing the operation.
                required: true
                constraints: [
                    ]
                metadata:
                    clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor
            operation:
                name: operation
                type: string
                typeVersion: 0.0.0
                description: The operation the actor is performing.
                required: true
                constraints: [
                    ]
                metadata:
                    clamp_possible_values: Dictionary:DefaultOperations, ClampExecution:CDS/operation
        name: onap.datatype.controlloop.Actor
        version: 0.0.0
        derived_from: tosca.datatypes.Root
        metadata: {
            }
        description: An actor/operation/target definition
    onap.datatype.controlloop.Operation:
        constraints: [
            ]
        properties:
            failure_retries:
                name: failure_retries
                type: string
                typeVersion: 0.0.0
                description: Points to the operation to invoke when the current operation
                    has exceeded its max retries.
                default: final_failure_retries
                required: false
                constraints: [
                    ]
                metadata: {
                    }
            id:
                name: id
                type: string
                typeVersion: 0.0.0
                description: Unique identifier for the operation
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            failure_timeout:
                name: failure_timeout
                type: string
                typeVersion: 0.0.0
                description: Points to the operation to invoke when the time out for
                    the operation occurs.
                default: final_failure_timeout
                required: false
                constraints: [
                    ]
                metadata: {
                    }
            failure:
                name: failure
                type: string
                typeVersion: 0.0.0
                description: Points to the operation to invoke on Actor operation
                    failure.
                default: final_failure
                required: false
                constraints: [
                    ]
                metadata: {
                    }
            operation:
                name: operation
                type: onap.datatype.controlloop.Actor
                typeVersion: 0.0.0
                description: The definition of the operation to be performed.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            failure_guard:
                name: failure_guard
                type: string
                typeVersion: 0.0.0
                description: Points to the operation to invoke when the current operation
                    is blocked due to guard policy enforcement.
                default: final_failure_guard
                required: false
                constraints: [
                    ]
                metadata: {
                    }
            retries:
                name: retries
                type: integer
                typeVersion: 0.0.0
                description: The number of retries the actor should attempt to perform
                    the operation.
                default: '0'
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            timeout:
                name: timeout
                type: integer
                typeVersion: 0.0.0
                description: The amount of time for the actor to perform the operation.
                required: true
                constraints: [
                    ]
                metadata: {
                    }
            failure_exception:
                name: failure_exception
                type: string
                typeVersion: 0.0.0
                description: Points to the operation to invoke when the current operation
                    causes an exception.
                default: final_failure_exception
                required: false
                constraints: [
                    ]
                metadata: {
                    }
            description:
                name: description
                type: string
                typeVersion: 0.0.0
                description: A user-friendly description of the intent for the operation
                required: false
                constraints: [
                    ]
                metadata: {
                    }
            success:
                name: success
                type: string
                typeVersion: 0.0.0
                description: Points to the operation to invoke on success. A value
                    of "final_success" indicates and end to the operation.
                default: final_success
                required: false
                constraints: [
                    ]
                metadata: {
                    }
        name: onap.datatype.controlloop.Operation
        version: 0.0.0
        derived_from: tosca.datatypes.Root
        metadata: {
            }
        description: An operation supported by an actor
    onap.datatype.controlloop.Target:
        constraints: [
            ]
        properties:
            entityIds:
                name: entityIds
                type: map
                typeVersion: 0.0.0
                description: |
                    Map of values that identify the resource. If none are provided, it is assumed that the
                    entity that generated the ONSET event will be the target.
                required: false
                constraints: [
                    ]
                entry_schema:
                    type: string
                    typeVersion: 0.0.0
                    constraints: [
                        ]
                metadata:
                    clamp_possible_values: ClampExecution:CSAR_RESOURCES
            targetType:
                name: targetType
                type: string
                typeVersion: 0.0.0
                description: Category for the target type
                required: true
                constraints:
                -   valid_values:
                    - VNF
                    - VM
                    - VFMODULE
                    - PNF
                metadata: {
                    }
        name: onap.datatype.controlloop.Target
        version: 0.0.0
        derived_from: tosca.datatypes.Root
        metadata: {
            }
        description: Definition for a entity in A&AI to perform a control loop operation
            on
name: ToscaServiceTemplateSimple
version: 1.0.0
metadata: {
    }