Add documentation for A1PMS participant
[policy/parent.git] / docs / clamp / acm / design-impl / participants / tosca / tosca-a1pms-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.a1PmsAutomationCompositionElement.A1PolicyServiceEntity:
13     version: 1.0.0
14     derived_from: tosca.datatypes.Root
15     properties:
16       a1PolicyServiceEntityId:
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 A1 PMS Automation Composition Element
21       clientId:
22         type: string
23         required: true
24         description: Client Id to be created
25       callbackUrl:
26         type: string
27         required: true
28         description: The callback URL to get registered
29       keepAliveIntervalSeconds:
30         type: integer
31         required: true
32         description: Keep alive interval time for the callback URL
33
34 node_types:
35   org.onap.policy.clamp.acm.Participant:
36     version: 1.0.1
37     derived_from: tosca.nodetypes.Root
38     properties:
39       provider:
40         type: string
41         required: false
42   org.onap.policy.clamp.acm.AutomationCompositionElement:
43     version: 1.0.1
44     derived_from: tosca.nodetypes.Root
45     properties:
46       provider:
47         type: string
48         required: false
49       participantType:
50         type: onap.datatypes.ToscaConceptIdentifier
51         required: true
52       startPhase:
53         type: integer
54         required: false
55         constraints:
56         - greater-or-equal: 0
57         metadata:
58             common: true
59         description: A value indicating the start phase in which this automation composition element will be started, the
60                      first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
61                      in reverse start phase order. Automation Composition Elements with the same start phase are started and
62                      stopped simultaneously
63   org.onap.policy.clamp.acm.AutomationComposition:
64     version: 1.0.1
65     derived_from: tosca.nodetypes.Root
66     properties:
67       provider:
68         type: string
69         required: false
70       elements:
71         type: list
72         required: true
73         entry_schema:
74           type: onap.datatypes.ToscaConceptIdentifier
75   org.onap.policy.clamp.acm.A1PMSAutomationCompositionElement:
76     version: 1.0.1
77     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
78     properties:
79       policyServiceEntities:
80         type: list
81         required: true
82         entry_schema:
83           type: org.onap.datatypes.policy.clamp.acm.a1pmsAutomationCompositionElement.A1PolicyServiceEntity
84           type_version: 1.0.0
85         description: The configuration entities of A1 policy services
86 topology_template:
87   node_templates:
88     org.onap.policy.clamp.acm.A1PMSAutomationCompositionParticipant:
89       version: 2.3.4
90       type: org.onap.policy.clamp.acm.Participant
91       type_version: 1.0.1
92       description: Participant for A1 PMS requests
93       properties:
94         provider: ONAP
95
96     onap.policy.clamp.ac.element.A1PMSAutomationCompositionElement:
97       version: 1.2.3
98       type: org.onap.policy.clamp.acm.A1PMSAutomationCompositionElement
99       type_version: 1.0.1
100       description: Automation composition element for the A1 PMS Requests
101       properties:
102         provider: ONAP
103
104     org.onap.domain.sample.A1PMSAutomationCompositionDefinition:
105       version: 1.2.3
106       type: org.onap.policy.clamp.acm.AutomationComposition
107       type_version: 1.0.0
108       description: Automation composition for A1PMS request
109       properties:
110         provider: ONAP
111         elements:
112           - name: onap.policy.clamp.ac.element.A1PMSAutomationCompositionElement
113             version: 1.2.3