blob: a32dbd5c950b1bbc4d57040985c42411cee8cdb6 [file] [log] [blame]
Andrea Campanellaafc46532022-05-05 23:14:36 +02001=================================
2Product Certification with VOLTHA
3=================================
4
5VOLTHA is part fo the `continuous certification program at ONF <https://opennetworking.org/continuous-certification-program/>`_.
6You can see the currently certified products in the `ONF marketplace <https://opennetworking.org/marketplace/?_product_project=voltha>`_.
7
8The following document describes the procedure to include and certify an OLT or an ONU with VOLTHA.
9The process of getting a product certified consists of several phases:
10
11- testing and validation with VOLTHA at the vendor premises
12- showcase of successful integration with VOLTHA to the TST
13- shipment and integration of the product (OLT/ONU) at a community lab (e.g. Berlin with DT)
14- Creation of automated CI jobs in Jenkins that start nightly automation tests.
15- Test maintenance. It's the Vendors and the VOLTHA community responsibility to maintain the created tests.
16
17Finally a brief Description of the device and a point of contact need to be sent to
18`Michelle Roth @ ONF <michelle@opennetworking.org>`_
19to be showcased in the `marketplace <https://opennetworking.org/marketplace/?_product_project=voltha>`_ after successful verification.
20
21Once all these steps are completed the product will be certified for the next release of VOLTHA.
22Let's describe each phase in detail.
23
24Vendor's premises Testing
25-------------------------
26The first step is for the vendor to guarantee that the OLT or the ONU are VOLTHA compatible is complying got ONF's
27automated sanity test.
28To do so we suggest setting up a HW test pod according as described in the `physical setup guide <https://docs.voltha.org/master/overview/lab_setup.html>`_.
29
30Once the setup is running the next step is running the Sanity tests, as described in the `testing documentation <https://docs.voltha.org/master/voltha-system-tests/README.html#running-tests-on-physical-pod>`_.
31If those pass the hardware is ready to be shown to the VOLTHA TST.
32
33Showcase to VOLTHA TST
34----------------------
35Once the OLT has passed tests in the Vendor lab it's ready to be showcased to the VOLTHA Technical Steering Team.
36The request needs to be performed to the Technical TST leader or to `Timon Sloane <timon@opennetworking.org>`_ who will
37forward the request appropriately.
38During a scheduled TST meeting (Tuesday 8 AM PST) the vendor will showcase the OLT/ONU to the TST by starting from a
39fresh VOLTHA instance, connecting the OLT and then performing the Sanity test.
40With the test passing the TST will give approval for shipment of the device (ONU/OLT) to an ONF community lab.
41
42ONF's community lab integration
43-------------------------------
44
45Once the TST has given approval for device integration in VOLTHA nighly tests the Vendor needs to ship the device to
46any one of the ONF community lab, including a wiring diagram (if needed) Currently there are two locations:
47
48- DT Office in Berlin, Germany. Address: Winterfeldtstraße 21, 10781 Berlin, Germany. Point of contact `Bjoern Nagel @ DT <NagelB@telekom.de>`_
Joey Armstrong053feec2022-12-01 11:57:43 -050049- Radisys Laboratory in Hillsboro, Oregon
Andrea Campanellaafc46532022-05-05 23:14:36 +020050
51Once the OLT arrives the technicians will rack it and wire it according to the diagram shared.
52For an OLT the NNI connection will be provided to the AGG switch and all the management will also be connected with
53management IP assigned according to the network of the pod.
54For an ONU it will be connected to one of the existing OLTs in the pod, according to space,
55technology and topology requirements.
56Once all the racking and wiring is complete the device will appear under the ONF network, accessible via VPN.
57
58Automated CI Jobs
59-----------------
60Once the device in included in one of the community pods it's the responsibility of the vendor to integrate
61it into the nightly VOLTHA tests. This process is done by submitting a series of patches to different repositories.
62The process is different for ONUs and OLTs.
63To create jenkins jobs see https://docs.voltha.org/master/testing/voltha_test_automation.html#hardware-or-physical-pod-jobs
64
65OLT
66+++
67A new OLT needs a full new configuration, job and data.
68The job can be created according to the desired workflow to be tested. Information can be found in the
69`system tests information <https://docs.voltha.org/master/testing/voltha_test_automation.html#hardware-or-physical-pod-jobs>`_
70The required patches are:
71
Joey Armstrongb5a5e8c2023-09-20 12:05:03 -040072- ci-management. Creates the job that will run in jenkins. Job Example ``https://github.com/opencord/ci-management/blob/master/jjb/voltha-test/voltha-certification.yaml``
Andrea Campanellaafc46532022-05-05 23:14:36 +020073- pod configs. Inserts information about the OLT and target ONUs data. `Data example <https://github.com/opencord/pod-configs/blob/master/deployment-configs/menlo-certification-pod-radisys-1600g-DT.yaml>`_
74 and `kubernetes example <https://github.com/opencord/pod-configs/blob/master/kubernetes-configs/menlo-certification-pod-radisys-1600g.conf>`_
75- voltha-system-tests. Adds the sadis configuration for the OLT and the ONU. `Sadis Example <https://github.com/opencord/voltha-system-tests/blob/master/tests/data/menlo-certification-pod-radisys-1600g-sadis-DT.json>`_
76
77Once these are created and merged the job will appear on jenkins and run accordingly.
78
79ONU
80+++
81A new ONU it's attached to an existing OLT, so just the information for that ONU needs to be added to the proper
82OLT files.
83
84The required patches are:
85
86- pod configs. Inserts information about the ONU into an existing pod. `Info and Target example <https://github.com/opencord/pod-configs/blob/master/deployment-configs/menlo-certification-pod-radisys-1600g-DT.yaml>`_
87- voltha-system-tests. Adds the sadis configuration for the ONU. Example `Sadis ONU example <https://github.com/opencord/voltha-system-tests/blob/master/tests/data/menlo-certification-pod-radisys-1600g-sadis-DT.json>`_
88
89Job maintenance
90---------------
91
92It's the responsibility of the Vendor, the VOLTHA TST and the community at large to mantain, manage and update the job
93to make sure the OLT gets certified for each of the following VOLTHA releases.
94
95
96
97ONF Contacts
98------------
99For any further information please contact:
Joey Armstrong053feec2022-12-01 11:57:43 -0500100
101- `Timon Sloane <timon@opennetworking.org>`_
102- `Michelle Roth <michelle@opennetworking.org>`_