Add tooling page to integration project
[integration.git] / docs / integration-resources.rst
1 .. This work is licensed under a
2    Creative Commons Attribution 4.0 International License.
3 .. _integration-resources:
4
5 .. integration_main-doc:
6
7 Integration resources
8 =====================
9
10 .. important::
11    The Integration project maintains several community resources:
12
13       - Public Portal: http://testresults.opnfv.org/onap-integration/
14       - Test Database & API: http://testresults.opnfv.org/onap/api/v1/projects
15       - CI/CD logs & artifacts: https://logs.onap.org/onap-integration
16       - VNF demo artifacts:https://nexus.onap.org/content/repositories/releases/org/onap/demo/vnf/
17       - Simulators
18       - Test frameworks (e.g. python-onapsdk)
19
20 Integration portal
21 ------------------
22
23 A portal is built to report the status of the different labs collaborating in
24 Integration, see http://testresults.opnfv.org/onap-integration/
25
26 .. figure:: files/CI/ONAP_CI_3.png
27    :align: center
28    :width: 6.5in
29
30 The code of this web site is shared on a public gitlab project.
31
32 Integration Test database
33 -------------------------
34
35 The integration team shares a Test Result Database with the OPNFV project. All
36 the test results of the CD are automatically pushed to this database.
37 It is possible to retrieve the results through the Test API associated with this
38 test Database.
39
40 The following information are available:
41
42 - List of pods allowed to push results: http://testresults.opnfv.org/onap/api/v1/pods
43 - List of projects that declared test cases for CI/CD: http://testresults.opnfv.org/onap/api/v1/projects
44 - List of test cases per projects:
45   http://testresults.opnfv.org/onap/api/v1/projects/integration/cases
46   http://testresults.opnfv.org/onap/api/v1/projects/security/cases
47 - Results with lots of possible filter combinations: http://testresults.opnfv.org/onap/api/v1/results?last=3
48
49 It is possible to get results according to several criteria (version, case name,
50 lab, period, last, CI id,..)
51 See the `OPNFV test API documentation <https://wiki.opnfv.org/pages/viewpage.action?pageId=2926452>`_.
52
53 Any company running ONAP Integration tests can be referenced to push their results
54 to this database.
55 This Database is hosted on a LF OPNFV server. Results are backuped daily.
56 Integration committers can have access to this server.
57
58 VNF demo Artifacts
59 ------------------
60
61 VNF demo artifacts are hosted in the demo repositories and published in
62 https://nexus.onap.org/content/repositories/releases/org/onap/demo/vnf/.
63
64 Simulators
65 ----------
66
67 There is a list of `available simulators <https://wiki.onap.org/pages/viewpage.action?pageId=81399210>`_.
68 Please consider any of them (they are open source and can be modified,
69 updated...) before creating a new one.
70
71 Communication channels
72 ----------------------
73
74 The main communication channel for real time support is the rocket chat channel
75 http://team.onap.eu.
76 You can also send a mail to onap-discuss AT lists.onap.org
77 with [ONAP] [Integration] prefix in the title.
78
79 All the different links are reachable from the Integration portal.