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