From 9643b0c11bdafd26ea0ac5127325aa8cb09f0c03 Mon Sep 17 00:00:00 2001
From: mrichomme <morgan.richomme@orange.com>
Date: Sat, 14 Nov 2020 22:36:57 +0100
Subject: Refactor Integration official documentation

Issue-ID: INT-1736

Signed-off-by: mrichomme <morgan.richomme@orange.com>
Change-Id: Ia7b6425358eb9b07e293881dabd5345697af1c39
---
 docs/integration-repositories.rst | 142 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 142 insertions(+)
 create mode 100644 docs/integration-repositories.rst

(limited to 'docs/integration-repositories.rst')

diff --git a/docs/integration-repositories.rst b/docs/integration-repositories.rst
new file mode 100644
index 000000000..17b59710b
--- /dev/null
+++ b/docs/integration-repositories.rst
@@ -0,0 +1,142 @@
+.. This work is licensed under a
+   Creative Commons Attribution 4.0 International License.
+.. integration-repositories:
+
+Integration repositories
+========================
+
+.. important::
+   The Integration project deals with lots of code repositories.
+
+
+Most of the repositories are internal ONAP repositories.
+
+.. code-block:: bash
+
+   ├── csit
+   ├── demo
+   ├── integration
+   │   ├── docker
+   │   │   ├── onap-java11
+   │   │   └── onap-python
+   │   ├── integration
+   │   ├── seccom
+   │   ├── simulators
+   │   │   ├── 5G-core-nf-simulator
+   │   │   ├── dc-simulator
+   │   │   ├── pnf-simulator
+   │   │   └── ran-simulator
+   │   ├── terraform
+   │   ├── terragrunt
+   │   ├── usecases
+   │   │   ├── bbs
+   │   │   └── mdons
+   │   └── xtesting
+   ├── oparent
+   └── testsuite
+      ├── cds
+      ├── heatbridge
+      ├── oom
+      ├── pythonsdk-tests
+      ├── python-testing-utils
+      ├── robot-utils
+      └── testsuite
+
+Please note that integration and teststuite are repositories AND groups hosting
+several sub-repositories.
+
+Integration
+-----------
+
+The integration repository is the historical repository.
+As a consequence it includes several elements in the same reppository:
+
+- Deployment scripts (deployment directory)
+- Tests: the first non robot tests (security, vCPE,..)
+- Simulators/emulators (test/mocks)
+- Integration and use cases documentation (docs)
+- Tools (bootstrap, S3Ptools)
+
+Since Frankfurt version, we created more smaller repositories especially for the use
+cases and the simulators.
+It shall help improving the maintenance of the different elements.
+It shall also help identifying, leveraging and adopting existing simulators
+rather than systematically re-inventing the wheel.
+
+.. attention::
+   The **new integration sub-repositories** introduced for Guilin are:
+
+  - 5G-core-nf-simulator
+  - terraform
+  - terragrunt
+
+.. csv-table:: Integration Repositories
+    :file: ./files/csv/repo-integration.csv
+    :widths: 30,50,20
+    :delim: ;
+    :header-rows: 1
+
+Testsuite
+---------
+
+The testsuite repository and it sub repositories deal excelusively with tests.
+
+The testsuite repository includes all the robotframework scripts.
+The robot pod that can be installed as part of the ONAP cluster is build from
+this repository.
+
+Several tooling repositories are associated with the robot tests (heatbridge,
+robot-python-testing-utils).
+
+.. attention::
+   For Guilin, 3 new sub repositories have been created:
+
+   - testsuite/cds
+   - pythonsdk-test
+   - robot-utils
+
+.. csv-table:: Testsuite Repositories
+    :file: ./files/csv/repo-testsuite.csv
+    :widths: 30,50,20
+    :delim: ;
+    :header-rows: 1
+
+Demo
+----
+
+In this repository you will find any artifacts needed for demo, PoC and use cases
+if they do not have their own repository (mainly old use cases).
+
+.. csv-table:: Demo Repository
+    :file: ./files/csv/repo-demo.csv
+    :widths: 30,50,20
+    :delim: ;
+    :header-rows: 1
+
+Oparent
+-------
+
+.. csv-table:: Oparent Repository
+    :file: ./files/csv/repo-oparent.csv
+    :widths: 30,50,20
+    :delim: ;
+    :header-rows: 1
+
+
+External repositories
+---------------------
+
+Additionnaly, the Integration team also deals with external gitlab.com
+repositories.
+
+.. csv-table:: Integration external repositories table
+    :file: ./files/csv/repo-integration-external.csv
+    :widths: 30,50,20
+    :delim: ;
+    :header-rows: 1
+
+The python-onapsdk has been developped out of ONAP as gitlab provided more
+enhanced built-in features for this kind of developments.
+
+The xtesting-onap repository is also hosted in gitlab.com as the CD part of
+Integration work is based on public gitlab-ci chains.
-- 
cgit 1.2.3-korg