Update docs Kubernetes Participant
[policy/parent.git] / docs / clamp / acm / design-impl / participants / tosca / tosca-k8s-participant.yml
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
13 node_types:
14   org.onap.policy.clamp.acm.Participant:
15     version: 1.0.1
16     derived_from: tosca.nodetypes.Root
17     properties:
18       provider:
19         type: string
20         required: false
21   org.onap.policy.clamp.acm.AutomationCompositionElement:
22     version: 1.0.1
23     derived_from: tosca.nodetypes.Root
24     properties:
25       provider:
26         type: string
27         required: false
28         metadata:
29           common: true
30         description: Specifies the organization that provides the automation composition element
31       startPhase:
32         type: integer
33         required: false
34         constraints:
35           - greater_or_equal: 0
36         metadata:
37           common: true
38         description: A value indicating the start phase in which this automation composition element will be started, the
39           first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
40           in reverse start phase order. Automation Composition Elements with the same start phase are started and
41           stopped simultaneously
42       uninitializedToPassiveTimeout:
43         type: integer
44         required: false
45         constraints:
46           - greater_or_equal: 0
47         default: 60
48         metadata:
49           common: true
50         description: The maximum time in seconds to wait for a state chage from uninitialized to passive
51       passiveToRunningTimeout:
52         type: integer
53         required: false
54         constraints:
55           - greater_or_equal: 0
56         default: 60
57         metadata:
58           common: true
59         description: The maximum time in seconds to wait for a state chage from passive to running
60       runningToPassiveTimeout:
61         type: integer
62         required: false
63         constraints:
64           - greater_or_equal: 0
65         default: 60
66         metadata:
67           common: true
68         description: The maximum time in seconds to wait for a state chage from running to passive
69       passiveToUninitializedTimeout:
70         type: integer
71         required: false
72         constraints:
73           - greater_or_equal: 0
74         default: 60
75         metadata:
76           common: true
77         description: The maximum time in seconds to wait for a state chage from passive to uninitialized
78   org.onap.policy.clamp.acm.AutomationComposition:
79     version: 1.0.1
80     derived_from: tosca.nodetypes.Root
81     properties:
82       provider:
83         type: string
84         required: false
85         metadata:
86           common: true
87         description: Specifies the organization that provides the automation composition element
88       elements:
89         type: list
90         required: true
91         metadata:
92           common: true
93         entry_schema:
94           type: onap.datatypes.ToscaConceptIdentifier
95         description: Specifies a list of automation composition element definitions that make up this automation composition definition
96   org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement:
97     version: 1.0.0
98     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
99     properties:
100       chart:
101         type: string
102         required: true
103       configs:
104         type: list
105         required: false
106       requirements:
107         type: string
108         required: false
109       templates:
110         type: list
111         required: false
112         entry_schema:
113       values:
114         type: string
115         required: true
116
117 topology_template:
118   node_templates:
119     org.onap.k8s.acm.K8SAutomationCompositionParticipant:
120       version: 2.3.4
121       type: org.onap.policy.clamp.acm.Participant
122       type_version: 1.0.1
123       description: Participant for K8S
124       properties:
125         provider: ONAP
126     onap.policy.clamp.ac.element.K8S_StarterAutomationCompositionElement:
127       # Chart from any chart repository configured on helm client.
128       version: 1.2.3
129       type: org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement
130       type_version: 1.0.0
131       description: Automation composition element for the K8S microservice for AC Element Starter
132       properties:
133         provider: ONAP
134         startPhase: 0
135         uninitializedToPassiveTimeout: 300
136         podStatusCheckInterval: 30
137
138     onap.policy.clamp.ac.element.AutomationCompositionDefinition:
139       version: 1.2.3
140       type: org.onap.policy.clamp.acm.AutomationComposition
141       type_version: 1.0.1
142       description: Automation composition for Demo
143       properties:
144         provider: ONAP
145         elements:
146           - name: onap.policy.clamp.ac.element.K8S_StarterAutomationCompositionElement
147             version: 1.2.3