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