docs/integration-simulators.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3 .. integration-tooling:
   4
   5 .. _integration-simulators:
   6
   7 Simulators
   8 ==========
   9
  10 Simulators are regularly created for use cases. The goal of this section is to:
  11
  12 - Highlight the existing Simulators
  13 - Provide recommendations when starting developing a new simulator
  14
  15 .. important::
  16     Before developing a new simulator, check that it does not exist...and
  17     refactor/contribute to existing simulators rather than recreating new ones.
  18
  19
  20 Existing simulators
  21 -------------------
  22
  23 .. csv-table:: Simulators
  24   :file: ./files/csv/simulators.csv
  25   :widths: 10,50,20,20
  26   :delim: ;
  27   :header-rows: 1
  28
  29
  30 Recommendations
  31 ---------------
  32
  33 The simulator code
  34 ..................
  35
  36 We recommend to create a dedicated repository (ask Integration team).
  37
  38 .. csv-table:: Simulator repositories
  39     :file: ./files/csv/repo-simulators.csv
  40     :widths: 30,50,20
  41     :delim: ;
  42     :header-rows: 1
  43
  44
  45 Dockerization
  46 .............
  47
  48 From this repository, create a jenkins job to automatically build the dockers.
  49
  50 Helm Chart
  51 ..........
  52
  53 It is recommended to create a helm chart in order to run the simulators.
  54
  55
  56 Start your simulator from pythonsdk
  57 ...................................
  58
  59 TODO