Release docker images for policy/models: 2.6.4
[policy/models.git] / models-examples / src / main / resources / policytypes / onap.policies.controlloop.operational.Common.yaml
1 tosca_definitions_version: tosca_simple_yaml_1_1_0
2 policy_types:
3     onap.policies.controlloop.operational.Common:
4         derived_from: tosca.policies.Root
5         version: 1.0.0
6         name: onap.policies.controlloop.operational.Common
7         description: |
8             Operational Policy for Control Loop execution. Originated in Frankfurt to support TOSCA Compliant
9             Policy Types. This does NOT support the legacy Policy YAML policy type.
10         properties:
11             id:
12                 type: string
13                 description: The unique control loop id.
14                 required: true
15             timeout:
16                 type: integer
17                 description: |
18                     Overall timeout for executing all the operations. This timeout should equal or exceed the total
19                     timeout for each operation listed.
20                 required: true
21             abatement:
22                 type: boolean
23                 description: Whether an abatement event message will be expected for the control loop from DCAE.
24                 required: true
25                 default: false
26             trigger:
27                 type: string
28                 description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
29                 required: true
30             operations:
31                 type: list
32                 description: List of operations to be performed when Control Loop is triggered.
33                 required: true
34                 entry_schema:
35                     type: onap.datatype.controlloop.Operation
36
37 data_types:
38     onap.datatype.controlloop.Target:
39         derived_from: tosca.datatypes.Root
40         description: Definition for a entity in A&AI to perform a control loop operation on
41         properties:
42             targetType:
43                 type: string
44                 description: Category for the target type
45                 required: true
46                 constraints:
47                 - valid_values: [VNF, VM, VFMODULE, PNF]
48             entityIds:
49                 type: map
50                 description: |
51                     Map of values that identify the resource. If none are provided, it is assumed that the
52                     entity that generated the ONSET event will be the target.
53                 required: false
54                 metadata:
55                     clamp_possible_values: ClampExecution:CSAR_RESOURCES
56                 entry_schema:
57                     type: string
58
59     onap.datatype.controlloop.Actor:
60         derived_from: tosca.datatypes.Root
61         description: An actor/operation/target definition
62         properties:
63             actor:
64                 type: string
65                 description: The actor performing the operation.
66                 required: true
67                 metadata:
68                     clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor
69             operation:
70                 type: string
71                 description: The operation the actor is performing.
72                 metadata:
73                     clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation
74                 required: true
75             target:
76                 type: onap.datatype.controlloop.Target
77                 description: The resource the operation should be performed on.
78                 required: true
79             payload:
80                 type: map
81                 description: Name/value pairs of payload information passed by Policy to the actor
82                 required: false
83                 metadata:
84                     clamp_possible_values: ClampExecution:CDS/payload
85                 entry_schema:
86                     type: string
87
88     onap.datatype.controlloop.Operation:
89         derived_from: tosca.datatypes.Root
90         description: An operation supported by an actor
91         properties:
92             id:
93                 type: string
94                 description: Unique identifier for the operation
95                 required: true
96             description:
97                 type: string
98                 description: A user-friendly description of the intent for the operation
99                 required: false
100             operation:
101                 type: onap.datatype.controlloop.Actor
102                 description: The definition of the operation to be performed.
103                 required: true
104             timeout:
105                 type: integer
106                 description: The amount of time for the actor to perform the operation.
107                 required: true
108             retries:
109                 type: integer
110                 description: The number of retries the actor should attempt to perform the operation.
111                 required: true
112                 default: 0
113             success:
114                 type: string
115                 description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
116                 required: false
117                 default: final_success
118             failure:
119                 type: string
120                 description: Points to the operation to invoke on Actor operation failure.
121                 required: false
122                 default: final_failure
123             failure_timeout:
124                 type: string
125                 description: Points to the operation to invoke when the time out for the operation occurs.
126                 required: false
127                 default: final_failure_timeout
128             failure_retries:
129                 type: string
130                 description: Points to the operation to invoke when the current operation has exceeded its max retries.
131                 required: false
132                 default: final_failure_retries
133             failure_exception:
134                 type: string
135                 description: Points to the operation to invoke when the current operation causes an exception.
136                 required: false
137                 default: final_failure_exception
138             failure_guard:
139                 type: string
140                 description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.
141                 required: false
142                 default: final_failure_guard