From 52870422a4722451d0bc71c58bf6c33e49604381 Mon Sep 17 00:00:00 2001 From: morganrol Date: Wed, 31 Mar 2021 18:06:47 +0200 Subject: [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 Change-Id: If4510001bc1bb754a4bdaf3963175873edb3601c --- docs/files/csv/repo-integration.csv | 4 --- docs/files/csv/repo-simulators.csv | 5 ++++ docs/files/csv/simulators.csv | 3 ++ docs/index.rst | 1 + docs/integration-repositories.rst | 7 +++++ docs/integration-resources.rst | 7 ----- docs/integration-simulators.rst | 59 +++++++++++++++++++++++++++++++++++++ docs/simulators/ns_simulator.rst | 28 ++++++++++++++++++ 8 files changed, 103 insertions(+), 11 deletions(-) create mode 100644 docs/files/csv/repo-simulators.csv create mode 100644 docs/files/csv/simulators.csv create mode 100644 docs/integration-simulators.rst create mode 100644 docs/simulators/ns_simulator.rst (limited to 'docs') diff --git a/docs/files/csv/repo-integration.csv b/docs/files/csv/repo-integration.csv index e96ab325d..51edf36ea 100644 --- a/docs/files/csv/repo-integration.csv +++ b/docs/files/csv/repo-integration.csv @@ -4,10 +4,6 @@ integration/csit;Repository hosting some tooling to start component functional t integration/docker/onap-java11;Java11 baseline image conformed to SECCOM recommendations;`link `__ integration/docker/onap-python;Python baseline image conformed to SECCOM recommendations;`link `__ integration/seccom;Repory hosting seccom recommended versions and security test waivers;`link `__ -**integration/simulators/5G-core-nf-simulator**;**5G core nf simulator**;`link `__ -integration/simulators/dc-simulator;Data Center simulator;`link `__ -integration/simulators/pnf-simulator;PNF Simulator;`link `__ -integration/simulators/ran-simulator;RAN simulator;`link `__ **integration/terraform**;**Terraform based alternative infrastructure installation**;`link `__ **integration/terragrunt**;**Compagnon repository of terraform**;`link `__ integration/usecases/bbs;BBS use case introduced in Dublin and extracted from global repository in frankfurt;`link `__ diff --git a/docs/files/csv/repo-simulators.csv b/docs/files/csv/repo-simulators.csv new file mode 100644 index 000000000..09327ab76 --- /dev/null +++ b/docs/files/csv/repo-simulators.csv @@ -0,0 +1,5 @@ +Repository;Description;Link +**integration/simulators/5G-core-nf-simulator**;**5G core nf simulator**;`link `__ +integration/simulators/dc-simulator;Data Center simulator;`link `__ +integration/simulators/pnf-simulator;PNF Simulator;`link `__ +integration/simulators/ran-simulator;RAN simulator;`link `__ diff --git a/docs/files/csv/simulators.csv b/docs/files/csv/simulators.csv new file mode 100644 index 000000000..c743bd26a --- /dev/null +++ b/docs/files/csv/simulators.csv @@ -0,0 +1,3 @@ +Name;Description;Link;Contacts +NS Simulator;Evolution of the pnf simulator, the Network service simulator.....;:ref:`official doc `;K.Kuzmicki +Another Simulator;yes another ;;John Doe diff --git a/docs/index.rst b/docs/index.rst index 7b4d296b7..9e2a89cbb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,4 +14,5 @@ INTEGRATION integration-labs.rst integration-CICD.rst integration-tests.rst + integration-simulators.rst integration-tooling.rst diff --git a/docs/integration-repositories.rst b/docs/integration-repositories.rst index 211f2d39e..ac40067be 100644 --- a/docs/integration-repositories.rst +++ b/docs/integration-repositories.rst @@ -76,6 +76,13 @@ rather than systematically re-inventing the wheel. :delim: ; :header-rows: 1 +.. csv-table:: Integration Simulators + :file: ./files/csv/repo-simulators.csv + :widths: 30,50,20 + :delim: ; + :header-rows: 1 + + Testsuite --------- diff --git a/docs/integration-resources.rst b/docs/integration-resources.rst index a782fc990..a8dc4b992 100644 --- a/docs/integration-resources.rst +++ b/docs/integration-resources.rst @@ -61,13 +61,6 @@ VNF demo Artifacts VNF demo artifacts are hosted in the demo repositories and published in https://nexus.onap.org/content/repositories/releases/org/onap/demo/vnf/. -Simulators ----------- - -There is a list of `available simulators `_. -Please consider any of them (they are open source and can be modified, -updated...) before creating a new one. - Communication channels ---------------------- 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 diff --git a/docs/simulators/ns_simulator.rst b/docs/simulators/ns_simulator.rst new file mode 100644 index 000000000..f9f724e6c --- /dev/null +++ b/docs/simulators/ns_simulator.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 + +.. _ns_simulator: + +:orphan: + +NS Simulator +============ + +Description +----------- + +TODO + + +Guides +====== + +User Guide +----------- + +TODO + +Developer Guide +--------------- + +TODO -- cgit 1.2.3-korg