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