| WeberLaurent | f0a648c | 2020-02-06 10:23:01 +0100 | [diff] [blame] | 1 |
|
| 2 | tosca_definitions_version: tosca_simple_yaml_1_0_0
|
| 3 | policy_types:
|
| 4 | onap.policies.controlloop.operational.Common:
|
| 5 | derived_from: onap.datatype.controlloop.operation.Failure
|
| 6 | version: 1.0.0
|
| 7 | description: Operational Policy for Control Loop execution
|
| 8 | properties:
|
| 9 | id:
|
| 10 | type: String
|
| 11 | description: The unique control loop id.
|
| 12 | required: true
|
| 13 | timeout:
|
| 14 | type: Integer
|
| 15 | description: |
|
| 16 | Overall timeout for executing all the operations. This timeout should equal or exceed the total
|
| 17 | timeout for each operation listed.
|
| 18 | required: true
|
| 19 | constraints:
|
| 20 | - valid_values: [1, 2, 5]
|
| 21 | - equal: 5
|
| 22 | - greater_than: 7
|
| 23 | - greater_or_equal: 1
|
| 24 | - less_than: 7
|
| 25 | - less_or_equal: 1
|
| 26 | abatement:
|
| 27 | type: Boolean
|
| 28 | description: Whether an abatement event message will be expected for the control loop from DCAE.
|
| 29 | required: true
|
| 30 | default: false
|
| 31 | trigger:
|
| 32 | type: String
|
| 33 | description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
|
| 34 | required: true
|
| 35 | operations:
|
| 36 | type: List
|
| 37 | description: List of operations to be performed when Control Loop is triggered.
|
| 38 | required: true
|
| 39 | entry_schema:
|
| 40 | type: onap.datatype.controlloop.Operation
|
| 41 | onap.policies.controlloop.operational.common.Drools:
|
| 42 | derived_from: onap.policies.controlloop.operational.Common
|
| 43 | type_version: 1.0.0
|
| 44 | version: 1.0.0
|
| 45 | description: Operational policies for Drools PDP
|
| 46 | properties:
|
| 47 | controllerName:
|
| 48 | type: String
|
| 49 | description: Drools controller properties
|
| 50 | required: true
|
| 51 | data_types:
|
| 52 | # TBD if this is needed
|
| 53 | onap.datatype.controlloop.operation.Failure:
|
| 54 | derived_from: onap.datatype.controlloop.Target
|
| 55 | description: Captures information of an operational failure performed for control loop
|
| 56 | properties:
|
| 57 | messages:
|
| 58 | type: String
|
| 59 | description: error message
|
| 60 | required: true
|
| 61 | category:
|
| 62 | type: String
|
| 63 | description: |
|
| 64 | The category the error occurred in. Whether this is a general error from the actor, or the operation
|
| 65 | timed out, retries were exhausted in trying to execute the operation, a guard policy prevented the
|
| 66 | operation from occuring, or an exception in the system caused the failure.
|
| 67 | constraints:
|
| 68 | - valid_values: [error, timeout, retries, guard, exception]
|
| 69 | onap.datatype.controlloop.Target:
|
| 70 | derived_from: tosca.datatypes.Root
|
| 71 | description: Definition for a entity in A&AI to perform a control loop operation on
|
| 72 | properties:
|
| 73 | targetType:
|
| 74 | type: String
|
| 75 | description: Category for the target type
|
| 76 | required: true
|
| 77 | constraints:
|
| 78 | - valid_values: [VNF, VM, VFMODULE, PNF]
|
| 79 | entityIds:
|
| 80 | type: Map
|
| 81 | description: |
|
| 82 | Map of values that identify the resource. If none are provided, it is assumed that the
|
| 83 | entity that generated the ONSET event will be the target.
|
| 84 | required: false
|
| 85 | entry_schema:
|
| 86 | type: String
|
| 87 | onap.datatype.controlloop.Actor:
|
| 88 | derived_from: tosca.datatypes.Root
|
| 89 | description: An actor/operation/target definition
|
| 90 | properties:
|
| 91 | actor:
|
| 92 | type: String
|
| 93 | description: The actor performing the operation.
|
| 94 | required: true
|
| 95 | default: [1,"String",5.5,true]
|
| 96 | operation:
|
| 97 | type: String
|
| 98 | description: The operation the actor is performing.
|
| 99 | required: true
|
| 100 | target:
|
| 101 | type: String
|
| 102 | description: The resource the operation should be performed on.
|
| 103 | required: true
|
| 104 | metadata:
|
| 105 | clamp_possible_values: <string:see clamp project for syntax>
|
| 106 | payload:
|
| 107 | type: Map
|
| 108 | description: Name/value pairs of payload information passed by Policy to the actor
|
| 109 | required: false
|
| 110 | entry_schema:
|
| 111 | type: String
|
| 112 | onap.datatype.controlloop.Operation:
|
| 113 | derived_from: tosca.datatypes.Root
|
| 114 | description: An operation supported by an actor
|
| 115 | properties:
|
| 116 | id:
|
| 117 | type: String
|
| 118 | description: Unique identifier for the operation
|
| 119 | required: true
|
| 120 | description:
|
| 121 | type: Array
|
| 122 | description: A user-friendly description of the intent for the operation
|
| 123 | required: false
|
| 124 | constraints:
|
| 125 | - min_length: 5
|
| 126 | - max_length: 7
|
| 127 | - length: 1
|
| 128 | operation:
|
| 129 | type: onap.datatype.controlloop.Actor
|
| 130 | description: The definition of the operation to be performed.
|
| 131 | required: true
|
| 132 | metadata:
|
| 133 | clamp_possible_values: <string:see clamp project for syntax>
|
| 134 | timeout:
|
| 135 | type: Integer
|
| 136 | description: The amount of time for the actor to perform the operation.
|
| 137 | required: true
|
| 138 | constraints:
|
| 139 | - valid_values: [3, 4, 5.5, 6, 10]
|
| 140 | retries:
|
| 141 | type: Integer
|
| 142 | description: The number of retries the actor should attempt to perform the operation.
|
| 143 | required: true
|
| 144 | default: 0
|
| 145 | success:
|
| 146 | type: String
|
| 147 | description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
|
| 148 | required: false
|
| 149 | default: final_success
|
| 150 | failure:
|
| 151 | type: String
|
| 152 | description: Points to the operation to invoke on Actor operation failure.
|
| 153 | required: false
|
| 154 | default: final_failure
|
| 155 | failure_timeout:
|
| 156 | type: String
|
| 157 | description: Points to the operation to invoke when the time out for the operation occurs.
|
| 158 | required: false
|
| 159 | default: final_failure_timeout
|
| 160 | failure_retries:
|
| 161 | type: String
|
| 162 | description: Points to the operation to invoke when the current operation has exceeded its max retries.
|
| 163 | required: false
|
| 164 | default: final_failure_retries
|
| 165 | failure_exception:
|
| 166 | type: String
|
| 167 | description: Points to the operation to invoke when the current operation causes an exception.
|
| 168 | required: false
|
| 169 | default: final_failure_exception
|
| 170 | failure_guard:
|
| 171 | type: String
|
| 172 | description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.
|
| 173 | required: false
|
| 174 | default: final_failure_guard
|