diff options
author | morganrol <morgan.richomme@orange.com> | 2021-03-31 18:06:47 +0200 |
---|---|---|
committer | morganrol <morgan.richomme@orange.com> | 2021-03-31 18:06:47 +0200 |
commit | 52870422a4722451d0bc71c58bf6c33e49604381 (patch) | |
tree | cce53ba24dbc78a5dc8f5bc53cebc3757f7f1c40 /docs/integration-simulators.rst | |
parent | 11b4934a1c264bddeec0b5d93f6f3fa64f55e376 (diff) |
[DOCUMENTATION] Add a simulator section in documentation
Create a simulator section in integration documentation
This section aims to highlight the existing simulators
and encourage people to reuse them
it is a first skeleton, other patches shall complete
the new sections
Issue-ID: INT-1888
Signed-off-by: morganrol <morgan.richomme@orange.com>
Change-Id: If4510001bc1bb754a4bdaf3963175873edb3601c
Diffstat (limited to 'docs/integration-simulators.rst')
-rw-r--r-- | docs/integration-simulators.rst | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/integration-simulators.rst b/docs/integration-simulators.rst new file mode 100644 index 000000000..2105d3fd0 --- /dev/null +++ b/docs/integration-simulators.rst @@ -0,0 +1,59 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. +.. integration-tooling: + +.. _integration-simulators: + +Simulators +========== + +Simulators are regularly created for use cases. The goal of this section is to: + +- Highlight the existing Simulators +- Provide recommendations when starting developing a new simulator + +.. important:: + Before developing a new simulator, check that it does not exist...and + refactor/contribute to existing simulators rather than recreating new ones. + + +Existing simulators +------------------- + +.. csv-table:: Simulators + :file: ./files/csv/simulators.csv + :widths: 10,50,20,20 + :delim: ; + :header-rows: 1 + + +Recommendations +--------------- + +The simulator code +.................. + +We recommend to create a dedicated repository (ask Integration team). + +.. csv-table:: Simulator repositories + :file: ./files/csv/repo-simulators.csv + :widths: 30,50,20 + :delim: ; + :header-rows: 1 + + +Dockerization +............. + +From this repository, create a jenkins job to automatically build the dockers. + +Helm Chart +.......... + +It is recommended to create a helm chart in order to run the simulators. + + +Start your simulator from pythonsdk +................................... + +TODO |