summaryrefslogtreecommitdiffstats
path: root/src/test/resources/tosca/new-converter/sampleOperationalPoliciesEXTENTED.yaml
blob: 780acadc29a41158e079081c93378600befcc65d (plain)
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
tosca_definitions_version: tosca_simple_yaml_1_0_0
policy_types:
  onap.policies.controlloop.operational.Common:
    derived_from: onap.datatype.controlloop.operation.Failure
    version: 1.0.0
    description: Operational Policy for Control Loop execution
    properties:
      id:
        type: String
        description: The unique control loop id.
        required: true
      timeout:
        type: Integer
        description: |
          Overall timeout for executing all the operations. This timeout should equal or exceed the total
          timeout for each operation listed.
        required: true
        constraints:
          - valid_values: [1, 2, 5]
          - equal: 5
          - greater_than: 7
          - greater_or_equal: 1
          - less_than: 7
          - less_or_equal: 1
      abatement:
        type: Boolean
        description: Whether an abatement event message will be expected for the control loop from DCAE.
        required: true
        default: false
      trigger:
        type: String
        description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
        required: true
      operations:
        type: List
        description: List of operations to be performed when Control Loop is triggered.
        required: true
        entry_schema:
          type: onap.datatype.controlloop.Operation
  onap.policies.controlloop.operational.common.Drools:
    derived_from: onap.policies.controlloop.operational.Common
    type_version: 1.0.0
    version: 1.0.0
    description: Operational policies for Drools PDP
    properties:
      controllerName:
        type: String
        description: Drools controller properties
        required: true
data_types:
  # TBD if this is needed
  onap.datatype.controlloop.operation.Failure:
    derived_from: onap.datatype.controlloop.Target
    description: Captures information of an operational failure performed for control loop
    properties:
      messages:
        type: String
        description: error message
        required: true
      category:
        type: String
        description: |
          The category the error occurred in. Whether this is a general error from the actor, or the operation
          timed out, retries were exhausted in trying to execute the operation, a guard policy prevented the
          operation from occuring, or an exception in the system caused the failure.
        constraints:
          - valid_values: [error, timeout, retries, guard, exception]
  onap.datatype.controlloop.Target:
    derived_from: tosca.datatypes.Root
    description: Definition for a entity in A&AI to perform a control loop operation on
    properties:
      targetType:
        type: String
        description: Category for the target type
        required: true
        constraints:
          - valid_values: [VNF, VM, VFMODULE, PNF]
      entityIds:
        type: Map
        description: |
          Map of values that identify the resource. If none are provided, it is assumed that the
          entity that generated the ONSET event will be the target.
        required: false
        entry_schema:
          type: String
  onap.datatype.controlloop.Actor:
    derived_from: tosca.datatypes.Root
    description: An actor/operation/target definition
    properties:
      actor:
        type: String
        description: The actor performing the operation.
        required: true
        default: [1,"String",5.5,true]
      operation:
        type: String
        description: The operation the actor is performing.
        required: true
      target:
        type: String
        description: The resource the operation should be performed on.
        required: true
        metadata:
          clamp_possible_values: <string:see clamp project for syntax>
      payload:
        type: Map
        description: Name/value pairs of payload information passed by Policy to the actor
        required: false
        entry_schema:
          type: String
  onap.datatype.controlloop.Operation:
    derived_from: tosca.datatypes.Root
    description: An operation supported by an actor
    properties:
      id:
        type: String
        description: Unique identifier for the operation
        required: true
      description:
        type: Array
        description: A user-friendly description of the intent for the operation
        required: false
        constraints:
          - min_length: 5
          - max_length: 7
          - length: 1
      operation:
        type: onap.datatype.controlloop.Actor
        description: The definition of the operation to be performed.
        required: true
        metadata:
          clamp_possible_values: <string:see clamp project for syntax>
      timeout:
        type: Integer
        description: The amount of time for the actor to perform the operation.
        required: true
        constraints:
          - valid_values: [3, 4, 5.5, 6, 10]
      retries:
        type: Integer
        description: The number of retries the actor should attempt to perform the operation.
        required: true
        default: 0
      success:
        type: String
        description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
        required: false
        default: final_success
      failure:
        type: String
        description: Points to the operation to invoke on Actor operation failure.
        required: false
        default: final_failure
      failure_timeout:
        type: String
        description: Points to the operation to invoke when the time out for the operation occurs.
        required: false
        default: final_failure_timeout
      failure_retries:
        type: String
        description: Points to the operation to invoke when the current operation has exceeded its max retries.
        required: false
        default: final_failure_retries
      failure_exception:
        type: String
        description: Points to the operation to invoke when the current operation causes an exception.
        required: false
        default: final_failure_exception
      failure_guard:
        type: String
        description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.
        required: false
        default: final_failure_guard