docs/integration-repositories.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3 .. integration-repositories:
   4
   5 Integration repositories
   6 ========================
   7
   8 .. important::
   9    The Integration project deals with lots of code repositories.
  10
  11
  12 Most of the repositories are internal ONAP repositories.
  13
  14 .. code-block:: bash
  15
  16    ├── csit
  17    ├── demo
  18    ├── integration
  19    │   ├── docker
  20    │   │   ├── onap-java11
  21    │   │   └── onap-python
  22    │   ├── integration
  23    │   ├── seccom
  24    │   ├── simulators
  25    │   │   ├── 5G-core-nf-simulator
  26    │   │   ├── dc-simulator
  27    │   │   ├── pnf-simulator
  28    │   │   └── ran-simulator
  29    │   ├── terraform
  30    │   ├── terragrunt
  31    │   ├── usecases
  32    │   │   ├── bbs
  33    │   │   └── mdons
  34    │   └── xtesting
  35    ├── oparent
  36    └── testsuite
  37       ├── cds
  38       ├── heatbridge
  39       ├── oom
  40       ├── pythonsdk-tests
  41       ├── python-testing-utils
  42       ├── robot-utils
  43       └── testsuite
  44
  45 Please note that integration and teststuite are repositories AND groups hosting
  46 several sub-repositories.
  47
  48 Integration
  49 -----------
  50
  51 The integration repository is the historical repository.
  52 As a consequence it includes several elements in the same repository:
  53
  54 - Deployment scripts (deployment directory)
  55 - Tests: the first non robot tests (security, vCPE,..)
  56 - Simulators/emulators (test/mocks)
  57 - Integration and use cases documentation (docs)
  58 - Tools (bootstrap, S3Ptools)
  59
  60 Since Frankfurt version, we created more smaller repositories especially for the use
  61 cases and the simulators.
  62 It shall help improving the maintenance of the different elements.
  63 It shall also help identifying, leveraging and adopting existing simulators
  64 rather than systematically re-inventing the wheel.
  65
  66 .. attention::
  67    The **new integration sub-repositories** introduced for Guilin are:
  68
  69   - 5G-core-nf-simulator
  70   - terraform
  71   - terragrunt
  72
  73 .. csv-table:: Integration Repositories
  74     :file: ./files/csv/repo-integration.csv
  75     :widths: 30,50,20
  76     :delim: ;
  77     :header-rows: 1
  78
  79 .. csv-table:: Integration Simulators
  80     :file: ./files/csv/repo-simulators.csv
  81     :widths: 30,50,20
  82     :delim: ;
  83     :header-rows: 1
  84
  85
  86 Testsuite
  87 ---------
  88
  89 The testsuite repository and its sub repositories deal exclusively with tests.
  90
  91 The testsuite repository includes all the robotframework scripts.
  92 The robot pod that can be installed as part of the ONAP cluster is built from
  93 this repository.
  94
  95 Several tooling repositories are associated with the robot tests (heatbridge,
  96 robot-python-testing-utils).
  97
  98 .. attention::
  99    For Guilin, 3 new sub repositories have been created:
 100
 101    - testsuite/cds
 102    - pythonsdk-test
 103    - robot-utils
 104
 105 .. csv-table:: Testsuite Repositories
 106     :file: ./files/csv/repo-testsuite.csv
 107     :widths: 30,50,20
 108     :delim: ;
 109     :header-rows: 1
 110
 111 Demo
 112 ----
 113
 114 In this repository you will find any artifacts needed for demo, PoC and use cases
 115 if they do not have their own repository (mainly old use cases).
 116
 117 .. csv-table:: Demo Repository
 118     :file: ./files/csv/repo-demo.csv
 119     :widths: 30,50,20
 120     :delim: ;
 121     :header-rows: 1
 122
 123 Oparent
 124 -------
 125
 126 .. csv-table:: Oparent Repository
 127     :file: ./files/csv/repo-oparent.csv
 128     :widths: 30,50,20
 129     :delim: ;
 130     :header-rows: 1
 131
 132
 133 External repositories
 134 ---------------------
 135
 136 Additionally, the Integration team also deals with external gitlab.com
 137 repositories.
 138
 139 .. csv-table:: Integration external repositories table
 140     :file: ./files/csv/repo-integration-external.csv
 141     :widths: 30,50,20
 142     :delim: ;
 143     :header-rows: 1
 144
 145 The python-onapsdk has been developed outside of ONAP as gitlab provided more
 146 enhanced built-in features for this kind of development.
 147
 148 The xtesting-onap repository is also hosted in gitlab.com as the CD part of
 149 Integration work is based on public gitlab-ci chains.