Update ACM documentation for Kohn release
[policy/parent.git] / docs / clamp / acm / design-impl / participants / participants.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 .. _clamp-acm-participants:
4
5 Automation Composition Participants
6 ###################################
7
8 A Participant is a component that acts as a bridge between the CLAMP Automation Composition Management runtime and components such as
9 the Policy Framework, DCAE, or a Kubernetes cluster that are taking part in automation composition management. It listens
10 to DMaaP to receive messages from the CLAMP runtime and performs operations towards components that
11 are taking part in acms. A participant has an Automation Composition Management Element for each automation composition in
12 which it is taking part.
13
14 The implementation of a participant may use a common
15 :ref:`Participant Intermediary library <clamp-acm-participant-intermediary>`, which carries out common
16 message and state handling for Automation Composition Elements in participants. The *ParticipantImpelementation* is the
17 component specific implementation of a participant, which is specifically developed for each component that
18 wishes to take part in automation composition management.
19
20 .. image:: ../../images/participants/participants.png
21
22 The figure above shows participants for various components that may take part in automation composition management.
23
24 .. note:: The figure above is for illustration. Not all the participants mentioned above
25           have realizations in ONAP. Some of the participants in the figure above represent
26           a type of participant. For example, a controller participant would be written for
27           a specific controller such as CDS and a participant for an existing system would be
28           written towards that existing system.
29
30 The detailed implementation of the CLAMP Participant ecosystem is described on the following pages:
31
32 .. toctree::
33    :maxdepth: 1
34
35    participant-intermediary
36    http-participant
37    k8s-participant
38    policy-framework-participant