Update doc CLAMP Automation Composition Smoke Tests
[policy/parent.git] / docs / development / devtools / smoke / tosca / smoke-test-participants.yaml
1 tosca_definitions_version: tosca_simple_yaml_1_3
2 data_types:
3   onap.datatypes.ToscaConceptIdentifier:
4     derived_from: tosca.datatypes.Root
5     properties:
6       name:
7         type: string
8         required: true
9       version:
10         type: string
11         required: true
12   org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest:
13     version: 1.0.0
14     derived_from: tosca.datatypes.Root
15     properties:
16       restRequestId:
17         type:  onap.datatypes.ToscaConceptIdentifier
18         type_version: 0.0.0
19         required: true
20         description: The name and version of a REST request to be sent to a REST endpoint
21       httpMethod:
22         type: string
23         required: true
24         constraints:
25           - valid_values: [POST, PUT, GET, DELETE]
26         description: The REST method to use
27       path:
28         type: string
29         required: true
30         description: The path of the REST request relative to the base URL
31       body:
32         type: string
33         required: false
34         description: The body of the REST request for PUT and POST requests
35       expectedResponse:
36         type: integer
37         required: true
38         constraints:
39           - in_range: [100, 599]
40         description: THe expected HTTP status code for the REST request
41   org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity:
42     version: 1.0.0
43     derived_from: tosca.datatypes.Root
44     properties:
45       configurationEntityId:
46         type:  onap.datatypes.ToscaConceptIdentifier
47         type_version: 0.0.0
48         required: true
49         description: The name and version of a Configuration Entity to be handled by the HTTP Automation Composition Element
50       restSequence:
51         type: list
52         entry_schema:
53           type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest
54           type_version: 1.0.0
55         description: A sequence of REST commands to send to the REST endpoint
56 node_types:
57   org.onap.policy.clamp.acm.Participant:
58     version: 1.0.1
59     derived_from: tosca.nodetypes.Root
60     properties:
61       provider:
62         type: string
63         required: false
64   org.onap.policy.clamp.acm.AutomationCompositionElement:
65     version: 1.0.1
66     derived_from: tosca.nodetypes.Root
67     properties:
68       provider:
69         type: string
70         requred: false
71       startPhase:
72         type: integer
73         required: false
74         constraints:
75           - greater_or_equal: 0
76         metadata:
77           common: true
78         description: A value indicating the start phase in which this ACM element will be started, the
79           first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
80           in reverse start phase order. Automation Composition Elements with the same start phase are started and
81           stopped simultaneously
82       uninitializedToPassiveTimeout:
83         type: integer
84         required: false
85         constraints:
86           - greater_or_equal: 0
87         default: 60
88         metadata:
89           common: true
90         description: The maximum time in seconds to wait for a state chage from uninitialized to passive
91       passiveToRunningTimeout:
92         type: integer
93         required: false
94         constraints:
95           - greater_or_equal: 0
96         default: 60
97         metadata:
98           common: true
99         description: The maximum time in seconds to wait for a state chage from passive to running
100       runningToPassiveTimeout:
101         type: integer
102         required: false
103         constraints:
104           - greater_or_equal: 0
105         default: 60
106         metadata:
107           common: true
108         description: The maximum time in seconds to wait for a state chage from running to passive
109       passiveToUninitializedTimeout:
110         type: integer
111         required: false
112         constraints:
113           - greater_or_equal: 0
114         default: 60
115         metadata:
116           common: true
117         description: The maximum time in seconds to wait for a state chage from passive to uninitialized
118   org.onap.policy.clamp.acm.AutomationComposition:
119     version: 1.0.1
120     derived_from: tosca.nodetypes.Root
121     properties:
122       provider:
123         type: string
124         requred: false
125       elements:
126         type: list
127         required: true
128         entry_schema:
129           type: onap.datatypes.ToscaConceptIdentifier
130   org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement:
131     version: 1.0.0
132     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
133     properties:
134       chart:
135         type: string
136         required: true
137       configs:
138         type: list
139         required: false
140       requirements:
141         type: string
142         requred: false
143       templates:
144         type: list
145         required: false
146         entry_schema:
147       values:
148         type: string
149         required: true
150   org.onap.policy.clamp.acm.HttpAutomationCompositionElement:
151     version: 1.0.0
152     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
153     properties:
154       baseUrl:
155         type: string
156         required: true
157         description: The base URL to be prepended to each path, identifies the host for the REST endpoints.
158       httpHeaders:
159         type: map
160         required: false
161         entry_schema:
162           type: string
163         description: HTTP headers to send on REST requests
164       configurationEntities:
165         type: map
166         required: true
167         entry_schema:
168           type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity
169           type_version: 1.0.0
170         description: The connfiguration entities the Automation Composition Element is managing and their associated REST requests
171 topology_template:
172   node_templates:
173     org.onap.policy.clamp.acm.KubernetesParticipant:
174       version: 2.3.4
175       type: org.onap.policy.clamp.acm.Participant
176       type_version: 1.0.1
177       description: Participant for K8S
178       properties:
179         provider: ONAP
180     org.onap.policy.clamp.Local_K8SMicroserviceAutomationCompositionElement:
181       # Chart installation without passing repository info
182       version: 1.2.3
183       type: org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement
184       type_version: 1.0.0
185       description: Automation Composition element for the K8S microservice for local chart
186       properties:
187         provider: ONAP
188     org.onap.policy.clamp.acm.HttpParticipant:
189       version: 2.3.4
190       type: org.onap.policy.clamp.acm.Participant
191       type_version: 1.0.1
192       description: Participant for Http requests
193       properties:
194         provider: ONAP
195
196     org.onap.policy.clamp.Http_AutomationCompositionElement:
197       version: 1.2.3
198       type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement
199       type_version: 1.0.0
200       description: Automation composition element for the http requests of PMSH microservice
201       properties:
202         provider: ONAP
203         uninitializedToPassiveTimeout: 180
204         startPhase: 1
205
206     org.onap.domain.sample.GenericK8s_AutomationCompositionDefinition:
207       version: 1.2.3
208       type: org.onap.policy.clamp.acm.AutomationComposition
209       type_version: 1.0.1
210       description: Automation compostion for smoke testing participants
211       properties:
212         provider: ONAP
213         elements:
214         - name: org.onap.policy.clamp.Local_K8SMicroserviceAutomationCompositionElement
215           version: 1.2.3
216         - name: org.onap.policy.clamp.Http_AutomationCompositionElement
217           version: 1.2.3