diff options
| author |   FrancescoFioraEst <francesco.fiora@est.tech> | 2024-04-26 09:53:55 +0100 |
|---|---|---|
| committer | Francesco Fiora <francesco.fiora@est.tech> | 2024-04-29 08:52:12 +0000 |
| commit | c78136bd23f96c2c79d66f8494f914a3405f2876 (patch) | |
| tree | 4ef8f9b55a4336472462216f952a01244271f986 /docs/clamp/acm/design-impl/participants/sim-participant.rst | |
| parent | 2816f402050037f1b525d5b37a2d057d90070057 (diff) | |
Update Participant Simulator docs
Issue-ID: POLICY-4971
Change-Id: I4bb4ff00414ec1de935ed2bed3b50b4f7a0212d3
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
Diffstat (limited to 'docs/clamp/acm/design-impl/participants/sim-participant.rst')
| -rw-r--r-- | docs/clamp/acm/design-impl/participants/sim-participant.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/clamp/acm/design-impl/participants/sim-participant.rst b/docs/clamp/acm/design-impl/participants/sim-participant.rst new file mode 100644 index 00000000..96683a6a --- /dev/null +++ b/docs/clamp/acm/design-impl/participants/sim-participant.rst @@ -0,0 +1,42 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-acm-sim-participant: + +Simulator Participant +##################### + +This can be used for simulation testing purpose when there are no actual frameworks or a full deployment. +Typically the Simulator Participant can be used with other Simulator participants with different supported element types. +Once the microservice is up, the Simulator participants can be used to test CLAMP runtime and intermediary library. +It supports the message Broker Kafka. + +.. image:: ../../images/participants/sim-participant.png + +Supported Element Types +----------------------- +Supported Element Types for Simulator participant will be used to define a whatever participant Element Definition Types in tosca template. +Participant Supported Element Types is defined in Simulator participant application.yaml. +The example below shows how to mock the HTTP participant: + +.. code-block:: YAML + + participantSupportedElementTypes: + - + typeName: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + typeVersion: 1.0.0 + +Supported participant Interactions: +----------------------------------- +The Simulator participant interacts with ACM Runtime on the northbound via Message Broker. It interacts with tester via Rest Api. + +The communication for the Automation Composition updates and state change requests are sent from the ACM Runtime to the participant via Message Broker. +The tester can invoke the appropriate endpoint of the participant to change the behavior of how the participant should replay to ACM runtime. + +Participant Simulator API +========================= + +This API allows a Participant Simulator to be started and run for test purposes. + +:download:`Download Policy Participant Simulator API Swagger <swagger/participant-sim.json>` + +.. swaggerv2doc:: swagger/participant-sim.json |