blob: b8a23f36ab46843a3281b6f656e09bd07f5a03ac [file] [log] [blame]
Matteo Scandolo9f619492019-10-25 13:11:58 -07001.. BBSim documentation master file, created by
2 sphinx-quickstart on Fri Oct 25 12:03:42 2019.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
Zack Williamsd2907e62020-04-03 10:23:02 -07006BBSim, a Broadband Simulator
7============================
Matteo Scandolo9f619492019-10-25 13:11:58 -07008
9.. toctree::
Matteo Scandolof380a972020-09-11 12:09:40 -070010 :maxdepth: 1
11 :hidden:
Matteo Scandolo9f619492019-10-25 13:11:58 -070012 :caption: Contents:
13
Matteo Scandolof380a972020-09-11 12:09:40 -070014 bbsim_config.rst
15 sadis_config.rst
Matteo Scandoloe383d5d2019-10-25 14:47:27 -070016 operations.rst
Matteo Scandolof380a972020-09-11 12:09:40 -070017 development/internals.rst
18 Performances <bbr.rst>
Matteo Scandolo9f619492019-10-25 13:11:58 -070019
20
21Quickstart
22----------
23
Zack Williams4b0ef4d2019-12-18 14:25:20 -070024BBSim (a.k.a. BroadBand Simulator) is a tool designed to emulate an `Openolt
25<https://github.com/opencord/openolt>`_ compatible device.
Matteo Scandolo9f619492019-10-25 13:11:58 -070026
Matteo Scandolof380a972020-09-11 12:09:40 -070027BBSim emulates the OLT, PON Ports, ONUs, UNIs and RG.
28For more informations on how configure different Services on the RG refer to :ref:`ConfiguringServices`
29
Matteo Scandolo9f619492019-10-25 13:11:58 -070030In order to use BBSim you need to have:
31
32- a Kubernetes cluster
33- helm
34- a working installation of VOLTHA
35
Andrea Campanellac333ec92021-09-30 10:40:36 +020036To setup such an environment please look at the `voltha-helm-charts README <https://github.com/opencord/voltha-helm-charts/blob/master/README.md>`_.
Matteo Scandolo9f619492019-10-25 13:11:58 -070037
38Installation
39------------
40
41Once VOLTHA is up and running, you can deploy BBSim with this command:
42
43.. code:: bash
44
45 helm install -n bbsim cord/bbsim
46
Matteo Scandoloc1147092019-10-29 09:38:33 -070047If you need to specify a custom image for BBSim you can:
48
49.. code:: bash
50
51 helm install -n bbsim cord/bbsim --set images.bbsim.repository=bbsim --set images.bbsim.tag=candidate --set images.bbsim.pullPolicy=Never
52
Zack Williams4b0ef4d2019-12-18 14:25:20 -070053The BBSim installation can be customized to emulate multiple ONUs and multiple
54PON Ports:
Matteo Scandolo9f619492019-10-25 13:11:58 -070055
56.. code:: bash
57
58 helm install -n bbsim cord/bbsim --set onu=8 --set pon=2
59
Matteo Scandoloc1147092019-10-29 09:38:33 -070060BBSim can also be configured to automatically start Authentication or DHCP:
61
Matteo Scandolo9f619492019-10-25 13:11:58 -070062Once BBSim is installed you can verify that it's running with:
63
64.. code:: bash
65
66 kubectl logs -n voltha -f $(kubectl get pods -n voltha | grep bbsim | awk '{print $1}')
67
68Provision a BBSim OLT in VOLTHA
69-------------------------------
70
71Create the device:
72
73.. code:: bash
74
75 voltctl device create -t openolt -H $(kubectl get -n voltha service/bbsim -o go-template='{{.spec.clusterIP}}'):50060
76
77Enable the device:
78
79.. code:: bash
80
81 voltctl device enable $(voltctl device list --filter Type~openolt -q)