policy-domains/src/main/resources/schemas/onap.policies.controlloop.operational.common.Drools-1.0.0.schema.json


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

{
    "definitions": {},
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://www.onap.org/policy/models/schemas/onap.policies.controlloop.operational.common.Drools.schema.json",
    "type": "object",
    "title": "The Root Schema",
    "required": [
        "type",
        "type_version",
        "version",
        "metadata",
        "properties"
    ],
    "properties": {
        "type": {
            "$id": "#/properties/type",
            "type": "string",
            "title": "Policy Type",
            "default": "onap.policies.controlloop.operational.common.Drools",
            "examples": [
                "onap.policies.controlloop.operational.common.Drools"
            ],
            "pattern": "^(.+)$"
        },
        "type_version": {
            "$id": "#/properties/type_version",
            "type": "string",
            "title": "Policy Type Version",
            "default": "1.0.0",
            "examples": [
                "1.0.0"
            ],
            "pattern": "^(.+)$"
        },
        "name": {
            "$id": "#/properties/name",
            "type": "string",
            "title": "Policy Name",
            "default": "",
            "examples": [
                "example"
            ],
            "pattern": "^(.*)$"
        },
        "version": {
            "$id": "#/properties/version",
            "type": "string",
            "title": "Policy Version",
            "default": "1.0.0",
            "examples": [
                "1.0.0"
            ],
            "pattern": "^(.+)$"
        },
        "metadata": {
            "$id": "#/properties/metadata",
            "type": "object",
            "title": "Metadata",
            "required": [
                "policy-id"
            ],
            "properties": {
                "policy-id": {
                    "$id": "#/properties/metadata/properties/policy-id",
                    "type": "string",
                    "title": "Policy ID",
                    "examples": [
                        "operational.restart"
                    ],
                    "pattern": "^(.+)$"
                }
            }
        },
        "properties": {
            "$id": "#/properties/properties",
            "type": "object",
            "title": "Properties",
            "required": [
                "id",
                "timeout",
                "abatement",
                "trigger",
                "operations"
            ],
            "properties": {
                "id": {
                    "$id": "#/properties/properties/properties/id",
                    "type": "string",
                    "title": "Control Loop Name",
                    "examples": [
                        "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e"
                    ],
                    "pattern": "^(.+)$"
                },
                "timeout": {
                    "$id": "#/properties/properties/properties/timeout",
                    "type": "integer",
                    "title": "Timeout in seconds",
                    "minimum": 1,
                    "default": 30,
                    "examples": [
                        3600
                    ]
                },
                "abatement": {
                    "$id": "#/properties/properties/properties/abatement",
                    "type": "boolean",
                    "title": "Abatement",
                    "default": false,
                    "examples": [
                        true
                    ]
                },
                "trigger": {
                    "$id": "#/properties/properties/properties/trigger",
                    "type": "string",
                    "title": "Trigger Operation",
                    "examples": [
                        "unique-policy-id-1-restart"
                    ],
                    "pattern": "^(.+)$"
                },
                "operations": {
                    "$id": "#/properties/properties/properties/operations",
                    "type": "array",
                    "title": "Operations",
                    "items": {
                        "$id": "#/properties/properties/properties/operations/items",
                        "type": "object",
                        "title": "Items",
                        "uniqueItems": true,
                        "required": [
                            "id",
                            "operation",
                            "timeout",
                            "retries",
                            "success",
                            "failure"
                        ],
                        "properties": {
                            "id": {
                                "$id": "#/properties/properties/properties/operations/items/properties/id",
                                "type": "string",
                                "title": "Operation Identifier",
                                "examples": [
                                    "unique-policy-id-1-restart"
                                ],
                                "pattern": "^(.+)$"
                            },
                            "description": {
                                "$id": "#/properties/properties/properties/operations/items/properties/description",
                                "type": "string",
                                "title": "Description",
                                "examples": [
                                    "Restart the VM"
                                ]
                            },
                            "operation": {
                                "$id": "#/properties/properties/properties/operations/items/properties/operation",
                                "type": "object",
                                "title": "Operation",
                                "required": [
                                    "actor",
                                    "operation",
                                    "target"
                                ],
                                "properties": {
                                    "actor": {
                                        "$id": "#/properties/properties/properties/operations/items/properties/operation/properties/actor",
                                        "type": "string",
                                        "title": "Actor",
                                        "examples": [
                                            "APPC"
                                        ],
                                        "pattern": "^(.+)$"
                                    },
                                    "operation": {
                                        "$id": "#/properties/properties/properties/operations/items/properties/operation/properties/operation",
                                        "type": "string",
                                        "title": "Operation Name",
                                        "examples": [
                                            "Restart"
                                        ],
                                        "pattern": "^(.+)$"
                                    },
                                    "target": {
                                        "$id": "#/properties/properties/properties/operations/items/properties/operation/properties/target",
                                        "type": "object",
                                        "title": "Target",
                                        "required": [
                                            "targetType"
                                        ],
                                        "properties": {
                                            "targetType": {
                                                "$id": "#/properties/properties/properties/operations/items/properties/operation/properties/target/properties/targetType",
                                                "type": "string",
                                                "title": "Target Type",
                                                "examples": [
                                                    "VNF"
                                                ],
                                                "pattern": "^(.+)$"
                                            },
                                            "entityIds": {
                                                "$id": "#/properties/properties/properties/operations/items/properties/operation/properties/target/properties/entityIds",
                                                "type": "object",
                                                "title": "Arbitrary Resource Identities",
                                                "examples": [
                                                    "Eace933104d443b496b8.nodes.heat.vpg"
                                                ],
                                                "additionalProperties": {
                                                    "type": "string",
                                                    "pattern": "^(.+)$"
                                                }
                                            }
                                        }
                                    },
                                    "payload": {
                                        "$id": "#/properties/properties/properties/operations/items/properties/operation/properties/payload",
                                        "type": "object",
                                        "title": "Payload",
                                        "additionalProperties": {
                                            "type": "string",
                                            "pattern": "^(.+)$"
                                        }
                                    }
                                }
                            },
                            "timeout": {
                                "$id": "#/properties/properties/properties/operations/items/properties/timeout",
                                "type": "integer",
                                "title": "Operation Timeout in seconds",
                                "default": 10,
                                "minimum": 1,
                                "examples": [
                                    1200
                                ]
                            },
                            "retries": {
                                "$id": "#/properties/properties/properties/operations/items/properties/retries",
                                "type": "integer",
                                "title": "Number of Retries",
                                "default": 0,
                                "examples": [
                                    3
                                ]
                            },
                            "success": {
                                "$id": "#/properties/properties/properties/operations/items/properties/success",
                                "type": "string",
                                "title": "Success Treatment",
                                "default": "final_success",
                                "examples": [
                                    "final_success",
                                    "unique-policy-id-2"
                                ],
                                "pattern": "^(.+)$"
                            },
                            "failure": {
                                "$id": "#/properties/properties/properties/operations/items/properties/failure",
                                "type": "string",
                                "title": "Failure Treatment",
                                "default": "final_failure",
                                "examples": [
                                    "final_failure",
                                    "unique-policy-id-2"
                                ],
                                "pattern": "^(.+)$"
                            },
                            "failure_timeout": {
                                "$id": "#/properties/properties/properties/operations/items/properties/failure_timeout",
                                "type": "string",
                                "title": "Failure Timeout Treatment",
                                "default": "final_failure_timeout",
                                "examples": [
                                    "final_failure_timeout",
                                    "unique-policy-id-2"
                                ],
                                "pattern": "^(.+)$"
                            },
                            "failure_retries": {
                                "$id": "#/properties/properties/properties/operations/items/properties/failure_retries",
                                "type": "string",
                                "title": "Failure Retry Treatment",
                                "default": "final_failure_retries",
                                "examples": [
                                    "final_failure_retries",
                                    "unique-policy-id-2"
                                ],
                                "pattern": "^(.+)$"
                            },
                            "failure_exception": {
                                "$id": "#/properties/properties/properties/operations/items/properties/failure_exception",
                                "type": "string",
                                "title": "Failure Exception Treatment",
                                "default": "",
                                "examples": [
                                    "final_failure_exception",
                                    "unique-policy-id-2"
                                ],
                                "pattern": "^(.+)$"
                            },
                            "failure_guard": {
                                "$id": "#/properties/properties/properties/operations/items/properties/failure_guard",
                                "type": "string",
                                "title": "Failure Guard Treatment",
                                "default": "final_failure_guard",
                                "examples": [
                                    "final_failure_guard",
                                    "unique-policy-id-2"
                                ],
                                "pattern": "^(.+)$"
                            }
                        }
                    }
                },
                "controllerName": {
                    "$id": "#/properties/properties/properties/controllerName",
                    "type": "string",
                    "title": "Controller Name",
                    "default": "",
                    "examples": [
                        "usecases"
                    ],
                    "pattern": "^(.+)$"
                }
            }
        }
    }
}