docs/clamp/acm/design-impl/participants/sim-participant.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 .. _clamp-acm-sim-participant:
   4
   5 Simulator Participant
   6 #####################
   7
   8 This can be used for simulation testing purpose when there are no actual frameworks or a full deployment.
   9 Typically the Simulator Participant can be used with other Simulator participants with different supported element types.
  10 Once the microservice is up, the Simulator participants can be used to test CLAMP runtime and intermediary library.
  11 It supports the message Broker Kafka.
  12
  13 .. image:: ../../images/participants/sim-participant.png
  14
  15 Supported Element Types
  16 -----------------------
  17 Supported Element Types for Simulator participant will be used to define a whatever participant Element Definition Types in tosca template.
  18 Participant Supported Element Types is defined in Simulator participant application.yaml.
  19 The example below shows how to mock the HTTP participant:
  20
  21 .. code-block:: YAML
  22
  23     participantSupportedElementTypes:
  24       -
  25         typeName: org.onap.policy.clamp.acm.HttpAutomationCompositionElement
  26         typeVersion: 1.0.0
  27
  28 Supported participant Interactions:
  29 -----------------------------------
  30 The Simulator participant interacts with ACM Runtime on the northbound via Message Broker. It interacts with tester via Rest Api.
  31
  32 The communication for the Automation Composition updates and state change requests are sent from the ACM Runtime to the participant via Message Broker.
  33 The tester can invoke the appropriate endpoint of the participant to change the behavior of how the participant should replay to ACM runtime.
  34
  35 Participant Simulator API
  36 =========================
  37
  38 This API allows a Participant Simulator to be started and run for test purposes.
  39
  40 :download:`Download Policy Participant Simulator API Swagger  <swagger/participant-sim.json>`
  41
  42 .. swaggerv2doc:: swagger/participant-sim.json