Merge "Add DCAE policy types"
[policy/models.git] / models-examples / src / main / resources / policytypes / onap.policies.monitoring.dcae-restconfcollector.yaml
1 tosca_definitions_version: tosca_simple_yaml_1_1_0
2 policy_types:
3    onap.policies.Monitoring:
4       derived_from: tosca.policies.Root
5       version: 1.0.0
6       name: onap.policies.Monitoring
7       description: a base policy type for all policies that govern monitoring provisioning
8    onap.policies.monitoring.dcae-restconfcollector:
9       derived_from: onap.policies.Monitoring
10       version: 1.0.0
11       properties:
12          rcc_policy:
13             type: list
14             description: RCC Policy JSON
15             entry_schema:
16                type: onap.datatypes.monitoring.rcc_policy
17 data_types:
18    onap.datatypes.monitoring.rcc_policy:
19       derived_from: tosca.datatypes.Root
20       properties:
21          controller_name:
22             type: string
23             description: Name of controller
24             required: true
25          controller_restapiUrl:
26             type: string
27             description: Controller's ip and port
28             required: true
29          controller_restapiUser:
30             type: string
31             description: Controller's username
32             required: true
33          controller_restapiPassword:
34             type: string
35             description: Controller's password
36             required: true
37          controller_accessTokenUrl:
38             type: string
39             description: URL to get access token
40             required: true
41          controller_accessTokenFile:
42             type: string
43             description: Access token file path
44             required: true
45          controller_accessTokenMethod:
46             type: string
47             description: Access token method POST/GET/PUT etc
48             required: true
49             constraints:
50             -  valid_values:
51                - post
52                - get
53                - put
54          controller_subsMethod:
55             type: string
56             description: Subscription method POST/GET/PUT etc
57             required: true
58             default: post
59             constraints:
60             -  valid_values:
61                - post
62                - get
63                - put
64          controller_subscriptionUrl:
65             type: string
66             description: URL to establish subscription
67             required: true
68          controller_disableSsl:
69             type: boolean
70             description: Option to disable ssl
71             required: true
72             default: true
73          event_details:
74             type: list
75             description: event details
76             required: true
77             entry_schema:
78                type: onap.datatypes.monitoring.rcc_event_details
79    onap.datatypes.monitoring.rcc_event_details:
80       derived_from: tosca.datatypes.Root
81       properties:
82          event_name:
83             type: string
84             description: event name
85             required: true
86          event_description:
87             type: string
88             description: description of event
89             required: false
90          event_sseventUrlEmbed:
91             type: boolean
92             description: Whether SSE url is embedded in subscription response
93             required: true
94             default: true
95          event_sseventsField:
96             type: string
97             description: Field name to access SSE url in subscription response
98             required: true
99          event_sseventsUrl:
100             type: string
101             description: Explicit SSE url
102             required: true
103          event_subscriptionTemplate:
104             type: string
105             description: Subscription template file path
106             required: true
107          event_unSubscriptionTemplate:
108             type: string
109             description: Unsubscription template file path
110             required: false
111          event_ruleId:
112             type: integer
113             description: Rule Id
114             required: false
115          modifyData:
116             type: boolean
117             description: Whether to modify the received SSE event
118             required: true
119             default: false
120          modifyMethod:
121             type: string
122             description: The java method name to modify data
123             required: false
124          userData:
125             type: string
126             description: The user specific data
127             required: false