Add documentation for ACM
[policy/parent.git] / docs / clamp / acm / files / acm-nodetypes.yaml
1 node_types:
2   org.onap.policy.clamp.acm.Participant:
3     version: 1.0.1
4     derived_from: tosca.nodetypes.Root
5     properties:
6       provider:
7         type: string
8         required: false
9   org.onap.policy.clamp.acm.AutomationCompositionElement:
10     version: 1.0.1
11     derived_from: tosca.nodetypes.Root
12     properties:
13       provider:
14         type: string
15         required: false
16         metadata:
17           common: true
18         description: Specifies the organization that provides the automation composition element
19       startPhase:
20         type: integer
21         required: false
22         constraints:
23           - greater_or_equal: 0
24         metadata:
25           common: true
26         description:
27           A value indicating the start phase in which this automation composition element will be started, the
28           first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
29           in reverse start phase order. Automation Composition Elements with the same start phase are started and
30           stopped simultaneously
31       uninitializedToPassiveTimeout:
32         type: integer
33         required: false
34         constraints:
35           - greater_or_equal: 0
36         default: 60
37         metadata:
38           common: true
39         description: The maximum time in seconds to wait for a state chage from uninitialized to passive
40       passiveToRunningTimeout:
41         type: integer
42         required: false
43         constraints:
44           - greater_or_equal: 0
45         default: 60
46         metadata:
47           common: true
48         description: The maximum time in seconds to wait for a state chage from passive to running
49       runningToPassiveTimeout:
50         type: integer
51         required: false
52         constraints:
53           - greater_or_equal: 0
54         default: 60
55         metadata:
56           common: true
57         description: The maximum time in seconds to wait for a state chage from running to passive
58       passiveToUninitializedTimeout:
59         type: integer
60         required: false
61         constraints:
62           - greater_or_equal: 0
63         default: 60
64         metadata:
65           common: true
66         description: The maximum time in seconds to wait for a state chage from passive to uninitialized
67   org.onap.policy.clamp.acm.AutomationComposition:
68     version: 1.0.1
69     derived_from: tosca.nodetypes.Root
70     properties:
71       provider:
72         type: string
73         required: false
74         metadata:
75           common: true
76         description: Specifies the organization that provides the automation composition element
77       elements:
78         type: list
79         required: true
80         metadata:
81           common: true
82         entry_schema:
83           type: onap.datatypes.ToscaConceptIdentifier
84         description: Specifies a list of automation composition element definitions that make up this automation composition definition
85   org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement:
86     version: 1.0.0
87     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
88     properties:
89       chart:
90         type: dictionary
91         required: true
92         description: This consumes the helm chart information in key value pairs.
93   org.onap.policy.clamp.acm.HttpAutomationCompositionElement:
94     version: 1.0.0
95     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
96     properties:
97       baseUrl:
98         type: string
99         required: true
100         description: The base URL to be prepended to each path, identifies the host for the REST endpoints.
101       httpHeaders:
102         type: map
103         required: false
104         entry_schema:
105           type: string
106         description: HTTP headers to send on REST requests
107       configurationEntities:
108         type: map
109         required: true
110         entry_schema:
111           type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity
112           type_version: 1.0.0
113         description: The connfiguration entities the Automation Composition Element is managing and their associated REST requests