src/main/resources/clds/json-schema/operational_policies/operational_policy.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
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
361
362

{
    "schema": {
        "uniqueItems": "true",
        "format": "tabs",
        "type": "array",
        "minItems": 1,
        "maxItems": 1,
        "title": "Operational policies",
        "items": {
            "type": "object",
            "title": "Operational Policy Item",
            "id": "operational_policy_item",
            "headerTemplate": "{{self.name}}",
            "required": [
                "name",
                "configurationsJson"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Operational policy name",
                    "readOnly": "True"
                },
                "configurationsJson": {
                    "type": "object",
                    "title": "Configuration",
                    "required": [
                        "operational_policy",
                        "guard_policies"
                    ],
                    "properties": {
                        "operational_policy": {
                            "type": "object",
                            "title": "Related Parameters",
                            "required": [
                                "controlLoop",
                                "policies"
                            ],
                            "properties": {
                                "controlLoop": {
                                    "type": "object",
                                    "title": "Control Loop details",
                                    "required": [
                                        "timeout",
                                        "abatement",
                                        "trigger_policy",
                                        "controlLoopName"
                                    ],
                                    "properties": {
                                        "timeout": {
                                            "type": "string",
                                            "title": "Overall Time Limit",
                                            "default": "0",
                                            "format": "number"
                                        },
                                        "abatement": {
                                            "type": "string",
                                            "title": "Abatement",
                                            "enum": [
                                                "True",
                                                "False"
                                            ]
                                        },
                                        "trigger_policy": {
                                            "type": "string",
                                            "title": "Policy Decision Entry"
                                        },
                                        "controlLoopName": {
                                            "type": "string",
                                            "title": "Control loop name",
                                            "readOnly": "True"
                                        }
                                    }
                                },
                                "policies": {
                                    "uniqueItems": "true",
                                    "id": "policies_array",
                                    "type": "array",
                                    "title": "Policy Decision Tree",
                                    "format": "tabs-top",
                                    "items": {
                                        "title": "Policy Decision",
                                        "type": "object",
                                        "id": "policy_item",
                                        "headerTemplate": "{{self.id}} - {{self.recipe}}",
                                        "format": "categories",
                                        "basicCategoryTitle": "recipe",
                                        "required": [
                                            "id",
                                            "recipe",
                                            "retry",
                                            "timeout",
                                            "actor",
                                            "success",
                                            "failure",
                                            "failure_timeout",
                                            "failure_retries",
                                            "failure_exception",
                                            "failure_guard",
                                            "target"
                                        ],
                                        "properties": {
                                            "id": {
                                                "default": "Policy 1",
                                                "title": "Policy ID",
                                                "type": "string"
                                            },
                                            "recipe": {
                                                "title": "Recipe",
                                                "type": "string",
                                                "enum": [
                                                    "Restart",
                                                    "Rebuild",
                                                    "Migrate",
                                                    "Health-Check",
                                                    "ModifyConfig",
                                                    "VF Module Create",
                                                    "VF Module Delete",
                                                    "Reroute"
                                                ]
                                            },
                                            "retry": {
                                                "default": "0",
                                                "title": "Number of Retry",
                                                "type": "string",
                                                "format": "number"
                                            },
                                            "timeout": {
                                                "default": "0",
                                                "title": "Timeout",
                                                "type": "string",
                                                "format": "number"
                                            },
                                            "actor": {
                                                "title": "Actor",
                                                "type": "string",
                                                "enum": [
                                                    "APPC",
                                                    "SO",
                                                    "VFC",
                                                    "SDNC",
                                                    "SDNR"
                                                ]
                                            },
                                            "payload": {
                                                "title": "Payload (YAML)",
                                                "type": "string",
                                                "format": "textarea"
                                            },
                                            "success": {
                                                "default": "final_success",
                                                "title": "When Success",
                                                "type": "string"
                                            },
                                            "failure": {
                                                "default": "final_failure",
                                                "title": "When Failure",
                                                "type": "string"
                                            },
                                            "failure_timeout": {
                                                "default": "final_failure_timeout",
                                                "title": "When Failure Timeout",
                                                "type": "string"
                                            },
                                            "failure_retries": {
                                                "default": "final_failure_retries",
                                                "title": "When Failure Retries",
                                                "type": "string"
                                            },
                                            "failure_exception": {
                                                "default": "final_failure_exception",
                                                "title": "When Failure Exception",
                                                "type": "string"
                                            },
                                            "failure_guard": {
                                                "default": "final_failure_guard",
                                                "title": "When Failure Guard",
                                                "type": "string"
                                            },
                                            "target": {
                                                "type": "object",
                                                "required": [
                                                    "type",
                                                    "resourceID"
                                                ],
                                                "anyOf": [
                                                    {
                                                        "title": "User Defined",
                                                        "additionalProperties":"True",
                                                        "properties": {
                                                            "type": {
                                                                "title": "Target type",
                                                                "type": "string",
                                                                "default": "",
                                                                "enum": [
                                                                    "VNF",
                                                                    "VFMODULE",
                                                                    "VM"
                                                                ]
                                                            },
                                                            "resourceID": {
                                                                "title": "Target type",
                                                                "type": "string",
                                                                "default": ""
                                                            }
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "guard_policies": {
                            "type": "array",
                            "format": "tabs-top",
                            "title": "Associated Guard policies",
                            "items": {
                                "headerTemplate": "{{self.policy-id}} - {{self.content.recipe}}",
                                "anyOf": [
                                    {
                                        "title": "Guard MinMax",
                                        "type": "object",
                                        "properties": {
                                            "policy-id": {
                                                "type": "string",
                                                "default": "guard.minmax.new",
                                                "pattern": "^(guard.minmax\\..*)$"
                                            },
                                            "content": {
                                                "properties": {
                                                    "actor": {
                                                        "type": "string",
                                                        "enum": [
                                                            "APPC",
                                                            "SO",
                                                            "VFC",
                                                            "SDNC",
                                                            "SDNR"
                                                        ]
                                                    },
                                                    "recipe": {
                                                        "type": "string",
                                                        "enum": [
                                                            "Restart",
                                                            "Rebuild",
                                                            "Migrate",
                                                            "Health-Check",
                                                            "ModifyConfig",
                                                            "VF Module Create",
                                                            "VF Module Delete",
                                                            "Reroute"
                                                        ]
                                                    },
                                                    "targets": {
                                                        "type": "string",
                                                        "default": ".*"
                                                    },
                                                    "clname": {
                                                        "type": "string",
                                                        "template": "{{loopName}}",
                                                        "watch": {
                                                            "loopName": "operational_policy_item.configurationsJson.operational_policy.controlLoop.controlLoopName"
                                                        }
                                                    },
                                                    "guardActiveStart": {
                                                        "type": "string",
                                                        "default": "00:00:00Z"
                                                    },
                                                    "guardActiveEnd": {
                                                        "type": "string",
                                                        "default": "10:00:00Z"
                                                    },
                                                    "min": {
                                                        "type": "string",
                                                        "default": "0"
                                                    },
                                                    "max": {
                                                        "type": "string",
                                                        "default": "1"
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    {
                                        "title": "Guard Frequency",
                                        "type": "object",
                                        "properties": {
                                            "policy-id": {
                                                "type": "string",
                                                "default": "guard.frequency.new",
                                                "pattern": "^(guard.frequency\\..*)$"
                                            },
                                            "content": {
                                                "properties": {
                                                    "actor": {
                                                        "type": "string",
                                                        "enum": [
                                                            "APPC",
                                                            "SO",
                                                            "VFC",
                                                            "SDNC",
                                                            "SDNR"
                                                        ]
                                                    },
                                                    "recipe": {
                                                        "type": "string",
                                                        "enum": [
                                                            "Restart",
                                                            "Rebuild",
                                                            "Migrate",
                                                            "Health-Check",
                                                            "ModifyConfig",
                                                            "VF Module Create",
                                                            "VF Module Delete",
                                                            "Reroute"
                                                        ]
                                                    },
                                                    "targets": {
                                                        "type": "string",
                                                        "default": ".*"
                                                    },
                                                    "clname": {
                                                        "type": "string",
                                                        "template": "{{loopName}}",
                                                        "watch": {
                                                            "loopName": "operational_policy_item.configurationsJson.operational_policy.controlLoop.controlLoopName"
                                                        }
                                                    },
                                                    "guardActiveStart": {
                                                        "type": "string",
                                                        "default": "00:00:00Z"
                                                    },
                                                    "guardActiveEnd": {
                                                        "type": "string",
                                                        "default": "10:00:00Z"
                                                    },
                                                    "limit": {
                                                        "type": "string"
                                                    },
                                                    "timeWindow": {
                                                        "type": "string"
                                                    },
                                                    "timeUnits": {
                                                        "type": "string",
                                                        "enum":["minute","hour","day","week","month","year"]
                                                    }
                                                }
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}