Add documentation for Kserve participant
[policy/parent.git] / docs / clamp / acm / design-impl / participants / tosca / tosca-kserve-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   org.onap.datatypes.policy.clamp.acm.kserveAutomationCompositionElement.KserveInferenceEntity:
13     version: 1.0.0
14     derived_from: tosca.datatypes.Root
15     properties:
16       kserveEntityId:
17         type: onap.datatypes.ToscaConceptIdentifier
18         type_version: 1.0.0
19         required: true
20         description: The name and version of a Configuration Entity to be handled by the Kserve Automation Composition Element
21       name:
22         type: string
23         required: true
24         description: Inference service name to be created
25       payload:
26         type: string
27         required: true
28         description: Inference Service payload
29
30 node_types:
31   org.onap.policy.clamp.acm.Participant:
32     version: 1.0.1
33     derived_from: tosca.nodetypes.Root
34     properties:
35       provider:
36         type: string
37         required: false
38   org.onap.policy.clamp.acm.AutomationCompositionElement:
39     version: 1.0.1
40     derived_from: tosca.nodetypes.Root
41     properties:
42       provider:
43         type: string
44         required: false
45       participantType:
46         type: onap.datatypes.ToscaConceptIdentifier
47         required: true
48       startPhase:
49         type: integer
50         required: false
51         constraints:
52         - greater-or-equal: 0
53         metadata:
54             common: true
55         description: A value indicating the start phase in which this automation composition element will be started, the
56                      first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
57                      in reverse start phase order. Automation Composition Elements with the same start phase are started and
58                      stopped simultaneously
59   org.onap.policy.clamp.acm.AutomationComposition:
60     version: 1.0.1
61     derived_from: tosca.nodetypes.Root
62     properties:
63       provider:
64         type: string
65         required: false
66       elements:
67         type: list
68         required: true
69         entry_schema:
70           type: onap.datatypes.ToscaConceptIdentifier
71   org.onap.policy.clamp.acm.KserveAutomationCompositionElement:
72     version: 1.0.1
73     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
74     properties:
75       kserveInferenceEntities:
76         type: list
77         required: true
78         entry_schema:
79           type: org.onap.datatypes.policy.clamp.acm.kserveAutomationCompositionElement.KserveInferenceEntityId
80           type_version: 1.0.0
81         description: The configuration entities of Kserve inference service
82 topology_template:
83   node_templates:
84     org.onap.policy.clamp.acm.KserveParticipant:
85       version: 2.3.4
86       type: org.onap.policy.clamp.acm.Participant
87       type_version: 1.0.1
88       description: Participant for Kserve requests
89       properties:
90         provider: ONAP
91
92     onap.policy.clamp.ac.element.KserveAutomationCompositionElement:
93       version: 1.2.3
94       type: org.onap.policy.clamp.acm.KserveAutomationCompositionElement
95       type_version: 1.0.1
96       description: Automation composition element for the Kserve Requests
97       properties:
98         provider: ONAP
99         participantType:
100           name: org.onap.policy.clamp.acm.KserveParticipant
101           version: 2.3.4
102         uninitializedToPassiveTimeout: 60
103         statusCheckInterval: 30
104
105     onap.policy.clamp.ac.element.AutomationCompositionDefinition:
106       version: 1.2.3
107       type: org.onap.policy.clamp.acm.AutomationComposition
108       type_version: 1.0.0
109       description: Automation composition for Kserve request
110       properties:
111         provider: ONAP
112         elements:
113           - name: onap.policy.clamp.ac.element.KserveAutomationCompositionElement
114             version: 1.2.3