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 Integration
  12 -----------
  13
  14 The integration repository is the historical repository.
  15 As a consequence it includes several elements in the same repository:
  16
  17 - Deployment scripts (deployment directory)
  18 - Tests: the first non robot tests (security, vCPE,..)
  19 - Simulators/emulators (test/mocks)
  20 - Integration and use cases documentation (docs)
  21 - Tools (bootstrap, S3Ptools)
  22
  23 Since Frankfurt version, we created more smaller repositories especially for the use
  24 cases and the simulators.
  25 It shall help improving the maintenance of the different elements.
  26 It shall also help identifying, leveraging and adopting existing simulators
  27 rather than systematically re-inventing the wheel.
  28
  29 .. note::
  30     There is a new section of repositories - pipelines. These repositories are migrated for Orange GitLab project.
  31     Code on these repositories is planned to be used to run ONAP tests GitLab CI/CD pipelines on `GitLab ONAP integration group <https://gitlab.com/onap/integration>`__
  32
  33 .. csv-table:: Integration Repositories
  34     :file: ./files/csv/repo-integration.csv
  35     :widths: 30,50,20
  36     :delim: ;
  37     :header-rows: 1
  38
  39 .. csv-table:: Integration Simulators
  40     :file: ./files/csv/repo-simulators.csv
  41     :widths: 30,50,20
  42     :delim: ;
  43     :header-rows: 1
  44
  45 .. csv-table:: Integration Pipelines
  46     :file: ./files/csv/repo-pipelines.csv
  47     :widths: 30,50,20
  48     :delim: ;
  49     :header-rows: 1
  50
  51 Testsuite
  52 ---------
  53
  54 The testsuite repository and its sub repositories deal exclusively with tests.
  55
  56 The testsuite repository includes all the robotframework scripts.
  57 The robot pod that can be installed as part of the ONAP cluster is built from
  58 this repository.
  59
  60 Several tooling repositories are associated with the robot tests (heatbridge,
  61 robot-python-testing-utils).
  62
  63 .. csv-table:: Testsuite Repositories
  64     :file: ./files/csv/repo-testsuite.csv
  65     :widths: 30,50,20
  66     :delim: ;
  67     :header-rows: 1
  68
  69 Demo
  70 ----
  71
  72 In this repository you will find any artifacts needed for demo, PoC and use cases
  73 if they do not have their own repository (mainly old use cases).
  74
  75 .. csv-table:: Demo Repository
  76     :file: ./files/csv/repo-demo.csv
  77     :widths: 30,50,20
  78     :delim: ;
  79     :header-rows: 1
  80
  81 Oparent
  82 -------
  83
  84 .. csv-table:: Oparent Repository
  85     :file: ./files/csv/repo-oparent.csv
  86     :widths: 30,50,20
  87     :delim: ;
  88     :header-rows: 1
  89
  90 Archived repositories
  91 ---------------------
  92
  93 Some repositories are archived and marked as "read-only" due to the lack of any activity in them.
  94
  95 .. csv-table:: Archived Repositories
  96     :file: ./files/csv/repo-archived.csv
  97     :widths: 30,50,20
  98     :delim: ;
  99     :header-rows: 1
 100
 101
 102 External repositories
 103 ---------------------
 104
 105 Additionally, the Integration team also deals with external gitlab.com
 106 repositories.
 107
 108 .. important::
 109     All of these repositories should be migrated into ONAP's Gerrit
 110
 111 .. csv-table:: Integration external repositories table
 112     :file: ./files/csv/repo-integration-external.csv
 113     :widths: 30,50,20
 114     :delim: ;
 115     :header-rows: 1