Implement serialization/deserialization for TOSCA concepts
[policy/models.git] / models-examples / src / main / resources / policytypes / onap.policy.monitoring.cdap.tca.hi.lo.app.yaml
1 tosca_definitions_version: tosca_simple_yaml_1_0_0
2 policy_types:
3   -
4     onap.policies.Monitoring:
5         derived_from: tosca.policies.Root
6         description: a base policy type for all policies that governs monitoring provisioning
7   -
8     onap.policy.monitoring.cdap.tca.hi.lo.app:
9         derived_from: onap.policies.Monitoring
10         version: 1.0.0
11         properties:
12             tca_policy:
13                 type: map
14                 description: TCA Policy JSON
15                 entry_schema:
16                     type: onap.datatypes.monitoring.tca_policy
17 data_types:
18   -
19     onap.datatypes.monitoring.metricsPerEventName:
20         derived_from: tosca.datatypes.Root
21         properties:
22             controlLoopSchemaType:
23                 type: string
24                 required: true
25                 description: Specifies Control Loop Schema Type for the event Name e.g. VNF, VM
26                 constraints:
27                   - valid_values:
28                       - VM
29                       - VNF
30             eventName:
31                 type: string
32                 required: true
33                 description: Event name to which thresholds need to be applied
34             policyName:
35                 type: string
36                 required: true
37                 description: TCA Policy Scope Name
38             policyScope:
39                 type: string
40                 required: true
41                 description: TCA Policy Scope
42             policyVersion:
43                 type: string
44                 required: true
45                 description: TCA Policy Scope Version
46             thresholds:
47                 type: list
48                 required: true
49                 description: Thresholds associated with eventName
50                 entry_schema:
51                     type: onap.datatypes.monitoring.thresholds
52   -
53     onap.datatypes.monitoring.tca_policy:
54         derived_from: tosca.datatypes.Root
55         properties:
56             domain:
57                 type: string
58                 required: true
59                 description: Domain name to which TCA needs to be applied
60                 default: measurementsForVfScaling
61                 constraints:
62                   - equal: measurementsForVfScaling
63             metricsPerEventName:
64                 type: list
65                 required: true
66                 description: Contains eventName and threshold details that need to be applied to given eventName
67                 entry_schema:
68                     type: onap.datatypes.monitoring.metricsPerEventName
69   -
70     onap.datatypes.monitoring.thresholds:
71         derived_from: tosca.datatypes.Root
72         properties:
73             closedLoopControlName:
74                 type: string
75                 required: true
76                 description: Closed Loop Control Name associated with the threshold
77             closedLoopEventStatus:
78                 type: string
79                 required: true
80                 description: Closed Loop Event Status of the threshold
81                 constraints:
82                   - valid_values:
83                       - ONSET
84                       - ABATED
85             direction:
86                 type: string
87                 required: true
88                 description: Direction of the threshold
89                 constraints:
90                   - valid_values:
91                       - LESS
92                       - LESS_OR_EQUAL
93                       - GREATER
94                       - GREATER_OR_EQUAL
95                       - EQUAL
96             fieldPath:
97                 type: string
98                 required: true
99                 description: Json field Path as per CEF message which needs to be analyzed for TCA
100                 constraints:
101                   - valid_values:
102                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsDelta
103                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedOctetsDelta
104                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedUnicastPacketsDelta
105                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedMulticastPacketsDelta
106                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsDelta
107                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsDelta
108                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedErrorPacketsDelta
109                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsAccumulated
110                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedOctetsAccumulated
111                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedUnicastPacketsAccumulated
112                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedMulticastPacketsAccumulated
113                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated
114                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsAccumulated
115                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedErrorPacketsAccumulated
116                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedTotalPacketsDelta
117                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedOctetsDelta
118                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedUnicastPacketsDelta
119                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedMulticastPacketsDelta
120                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedBroadcastPacketsDelta
121                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedDiscardedPacketsDelta
122                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedErrorPacketsDelta
123                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedTotalPacketsAccumulated
124                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedOctetsAccumulated
125                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedUnicastPacketsAccumulated
126                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedMulticastPacketsAccumulated
127                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedBroadcastPacketsAccumulated
128                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedDiscardedPacketsAccumulated
129                       - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedErrorPacketsAccumulated
130                       - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuIdle
131                       - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageInterrupt
132                       - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageNice
133                       - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSoftIrq
134                       - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSteal
135                       - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSystem
136                       - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuWait
137                       - $.event.measurementsForVfScalingFields.cpuUsageArray[*].percentUsage
138                       - $.event.measurementsForVfScalingFields.meanRequestLatency
139                       - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryBuffered
140                       - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryCached
141                       - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryConfigured
142                       - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryFree
143                       - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryUsed
144                       - $.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value
145             severity:
146                 type: string
147                 required: true
148                 description: Threshold Event Severity
149                 constraints:
150                   - valid_values:
151                       - CRITICAL
152                       - MAJOR
153                       - MINOR
154                       - WARNING
155                       - NORMAL
156             thresholdValue:
157                 type: integer
158                 required: true
159                 description: Threshold value for the field Path inside CEF message
160             version:
161                 type: string
162                 required: true
163                 description: Version number associated with the threshold