src/main/resources/clds/json-schema/operational_policies/operational_policy.json

   1 {
   2   "type": "object",
   3   "title": "Configuration",
   4   "required": [
   5     "operational_policy"
   6   ],
   7   "properties": {
   8     "operational_policy": {
   9       "type": "object",
  10       "title": "Related Parameters",
  11       "required": [
  12         "controlLoop",
  13         "policies"
  14       ],
  15       "properties": {
  16         "controlLoop": {
  17           "type": "object",
  18           "title": "Control Loop details",
  19           "required": [
  20             "timeout",
  21             "abatement",
  22             "trigger_policy",
  23             "controlLoopName"
  24           ],
  25           "properties": {
  26             "timeout": {
  27               "type": "string",
  28               "title": "Overall Time Limit",
  29               "default": "0",
  30               "format": "number"
  31             },
  32             "abatement": {
  33               "type": "string",
  34               "title": "Abatement",
  35               "enum": [
  36                 "True",
  37                 "False"
  38               ]
  39             },
  40             "trigger_policy": {
  41               "type": "string",
  42               "title": "Policy Decision Entry"
  43             },
  44             "controlLoopName": {
  45               "type": "string",
  46               "title": "Control loop name",
  47               "readOnly": "True"
  48             }
  49           }
  50         },
  51         "policies": {
  52           "uniqueItems": "true",
  53           "id": "policies_array",
  54           "type": "array",
  55           "title": "Policy Decision Tree",
  56           "format": "tabs-top",
  57           "items": {
  58             "title": "Policy Decision",
  59             "type": "object",
  60             "id": "policy_item",
  61             "headerTemplate": "{{self.id}} - {{self.recipe}}",
  62             "format": "categories",
  63             "basicCategoryTitle": "recipe",
  64             "required": [
  65               "id",
  66               "retry",
  67               "timeout",
  68               "actor",
  69               "success",
  70               "failure",
  71               "failure_timeout",
  72               "failure_retries",
  73               "failure_exception",
  74               "failure_guard",
  75               "target"
  76             ],
  77             "properties": {
  78               "id": {
  79                 "default": "Policy 1",
  80                 "title": "Policy ID",
  81                 "type": "string"
  82               },
  83               "retry": {
  84                 "default": "0",
  85                 "title": "Number of Retry",
  86                 "type": "string",
  87                 "format": "number"
  88               },
  89               "timeout": {
  90                 "default": "0",
  91                 "title": "Timeout",
  92                 "type": "string",
  93                 "format": "number"
  94               },
  95               "actor": {
  96                 "type": "object",
  97                 "title": "Actor",
  98                 "anyOf": [
  99                   {
 100                     "title": "APPC",
 101                     "type": "object",
 102                     "properties": {
 103                       "actor": {
 104                         "title": "actor",
 105                         "type": "string",
 106                         "default": "APPC",
 107                         "options": {
 108                           "hidden": true
 109                         }
 110                       },
 111                       "recipe": {
 112                         "title": "recipe",
 113                         "type": "string",
 114                         "default": "",
 115                         "enum": [
 116                           "Restart",
 117                           "Rebuild",
 118                           "Migrate",
 119                           "Health-Check",
 120                           "ModifyConfig"
 121                         ]
 122                       },
 123                       "payload": {
 124                         "title": "Payload (YAML)",
 125                         "type": "string",
 126                         "format": "textarea"
 127                       }
 128                     }
 129                   },
 130                   {
 131                     "title": "SO",
 132                     "type": "object",
 133                     "properties": {
 134                       "actor": {
 135                         "title": "actor",
 136                         "type": "string",
 137                         "default": "SO",
 138                         "options": {
 139                           "hidden": true
 140                         }
 141                       },
 142                       "recipe": {
 143                         "title": "recipe",
 144                         "type": "string",
 145                         "default": "",
 146                         "enum": [
 147                           "VF Module Create",
 148                           "VF Module Delete"
 149                         ]
 150                       },
 151                       "payload": {
 152                         "title": "Payload (YAML)",
 153                         "type": "string",
 154                         "format": "textarea"
 155                       }
 156                     }
 157                   },
 158                   {
 159                     "title": "SDNC",
 160                     "type": "object",
 161                     "properties": {
 162                       "actor": {
 163                         "title": "actor",
 164                         "type": "string",
 165                         "default": "SDNC",
 166                         "options": {
 167                           "hidden": true
 168                         }
 169                       },
 170                       "recipe": {
 171                         "title": "recipe",
 172                         "type": "string",
 173                         "default": "",
 174                         "enum": [
 175                           "Reroute",
 176                           "BandwidthOnDemand"
 177                         ]
 178                       },
 179                       "payload": {
 180                         "title": "Payload (YAML)",
 181                         "type": "string",
 182                         "format": "textarea"
 183                       }
 184                     }
 185                   },
 186                   {
 187                     "title": "VFC",
 188                     "type": "object",
 189                     "properties": {
 190                       "actor": {
 191                         "title": "actor",
 192                         "type": "string",
 193                         "default": "VFC",
 194                         "options": {
 195                           "hidden": true
 196                         }
 197                       },
 198                       "recipe": {
 199                         "title": "recipe",
 200                         "type": "string",
 201                         "default": "",
 202                         "enum": [
 203                           "ModifyConfig"
 204                         ]
 205                       },
 206                       "payload": {
 207                         "title": "Payload (YAML)",
 208                         "type": "string",
 209                         "format": "textarea"
 210                       }
 211                     }
 212                   },
 213                   {
 214                     "title": "CDS",
 215                     "type": "object",
 216                     "properties": {
 217                       "actor": {
 218                         "title": "actor",
 219                         "type": "string",
 220                         "default": "CDS",
 221                         "options": {
 222                           "hidden": true
 223                         }
 224                       },
 225                       "recipe": {
 226                         "title": "recipe",
 227                         "type": "object",
 228                         "anyOf": [
 229                           {
 230                             "title": "user-defined",
 231                             "type": "object",
 232                             "properties": {
 233                               "recipe": {
 234                                 "title": "recipe",
 235                                 "type": "string",
 236                                 "default": "user-defined",
 237                                 "format": "textarea"
 238                               },
 239                               "payload": {
 240                                 "title": "Payload (YAML)",
 241                                 "type": "string",
 242                                 "default": "",
 243                                 "format": "textarea"
 244                               }
 245                             }
 246                           }
 247                         ]
 248                       }
 249                     }
 250                   }
 251                 ]
 252               },
 253               "success": {
 254                 "default": "final_success",
 255                 "title": "When Success",
 256                 "type": "string"
 257               },
 258               "failure": {
 259                 "default": "final_failure",
 260                 "title": "When Failure",
 261                 "type": "string"
 262               },
 263               "failure_timeout": {
 264                 "default": "final_failure_timeout",
 265                 "title": "When Failure Timeout",
 266                 "type": "string"
 267               },
 268               "failure_retries": {
 269                 "default": "final_failure_retries",
 270                 "title": "When Failure Retries",
 271                 "type": "string"
 272               },
 273               "failure_exception": {
 274                 "default": "final_failure_exception",
 275                 "title": "When Failure Exception",
 276                 "type": "string"
 277               },
 278               "failure_guard": {
 279                 "default": "final_failure_guard",
 280                 "title": "When Failure Guard",
 281                 "type": "string"
 282               },
 283               "target": {
 284                 "type": "object",
 285                 "required": [
 286                   "type",
 287                   "resourceID"
 288                 ],
 289                 "anyOf": [
 290                   {
 291                     "title": "User Defined",
 292                     "additionalProperties": "True",
 293                     "properties": {
 294                       "type": {
 295                         "title": "Target type",
 296                         "type": "string",
 297                         "default": "",
 298                         "enum": [
 299                           "VNF",
 300                           "VFMODULE",
 301                           "VM"
 302                         ]
 303                       },
 304                       "resourceID": {
 305                         "title": "Target type",
 306                         "type": "string",
 307                         "default": ""
 308                       }
 309                     }
 310                   }
 311                 ]
 312               }
 313             }
 314           }
 315         }
 316       }
 317     }
 318   }
 319 }
 320