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 Testsuite
  80 ---------
  81
  82 The testsuite repository and its sub repositories deal exclusively with tests.
  83
  84 The testsuite repository includes all the robotframework scripts.
  85 The robot pod that can be installed as part of the ONAP cluster is built from
  86 this repository.
  87
  88 Several tooling repositories are associated with the robot tests (heatbridge,
  89 robot-python-testing-utils).
  90
  91 .. attention::
  92    For Guilin, 3 new sub repositories have been created:
  93
  94    - testsuite/cds
  95    - pythonsdk-test
  96    - robot-utils
  97
  98 .. csv-table:: Testsuite Repositories
  99     :file: ./files/csv/repo-testsuite.csv
 100     :widths: 30,50,20
 101     :delim: ;
 102     :header-rows: 1
 103
 104 Demo
 105 ----
 106
 107 In this repository you will find any artifacts needed for demo, PoC and use cases
 108 if they do not have their own repository (mainly old use cases).
 109
 110 .. csv-table:: Demo Repository
 111     :file: ./files/csv/repo-demo.csv
 112     :widths: 30,50,20
 113     :delim: ;
 114     :header-rows: 1
 115
 116 Oparent
 117 -------
 118
 119 .. csv-table:: Oparent Repository
 120     :file: ./files/csv/repo-oparent.csv
 121     :widths: 30,50,20
 122     :delim: ;
 123     :header-rows: 1
 124
 125
 126 External repositories
 127 ---------------------
 128
 129 Additionally, the Integration team also deals with external gitlab.com
 130 repositories.
 131
 132 .. csv-table:: Integration external repositories table
 133     :file: ./files/csv/repo-integration-external.csv
 134     :widths: 30,50,20
 135     :delim: ;
 136     :header-rows: 1
 137
 138 The python-onapsdk has been developed outside of ONAP as gitlab provided more
 139 enhanced built-in features for this kind of development.
 140
 141 The xtesting-onap repository is also hosted in gitlab.com as the CD part of
 142 Integration work is based on public gitlab-ci chains.