Skip to content

Latest commit

 

History

History
163 lines (111 loc) · 4.74 KB

index.rst

File metadata and controls

163 lines (111 loc) · 4.74 KB
Raw

Welcome to BBSim's documentation!

operations.rst onu-state-machine.rst olt-state-machine.rst development-dependencies.rst bbr.rst bbsimctl.rst api.rst

Quickstart

BBSim (a.k.a. BroadBand Simulator) is a tool designed to emulate an Openolt compatible device.

In order to use BBSim you need to have:

  • a Kubernetes cluster
  • helm
  • a working installation of VOLTHA

We strongly recommend the utilization of kind-voltha to setup such environment.

Installation

Once VOLTHA is up and running, you can deploy BBSim with this command:

helm install -n bbsim cord/bbsim

If you need to specify a custom image for BBSim you can:

helm install -n bbsim cord/bbsim --set images.bbsim.repository=bbsim --set images.bbsim.tag=candidate --set images.bbsim.pullPolicy=Never

The BBSim installation can be customized to emulate multiple ONUs and multiple PON Ports:

helm install -n bbsim cord/bbsim --set onu=8 --set pon=2

BBSim can also be configured to automatically start Authentication or DHCP:

helm install -n bbsim cord/bbsim --set auth=true --set dhcp=true

Once BBSim is installed you can verify that it's running with:

kubectl logs -n voltha -f $(kubectl get pods -n voltha | grep bbsim | awk '{print $1}')

Provision a BBSim OLT in VOLTHA

Create the device:

voltctl device create -t openolt -H $(kubectl get -n voltha service/bbsim -o go-template='{{.spec.clusterIP}}'):50060

Enable the device:

voltctl device enable $(voltctl device list --filter Type~openolt -q)

BBSim startup options

BBSim supports a series of options that can be set at startup, you can see the list via ./bbsim --help

$ ./bbsim --help
Usage of ./bbsim:
  -auth
        Set this flag if you want authentication to start automatically
  -c_tag int
        C-Tag starting value, each ONU will get a sequential one (targeting 1024 ONUs per BBSim instance the range is big enough) (default 900)
  -cpuprofile string
        write cpu profile to file
  -delay int
        The delay between ONU DISCOVERY batches in milliseconds (1 ONU per each PON PORT at a time (default 200)
  -dhcp
        Set this flag if you want DHCP to start automatically
  -logCaller
        Whether to print the caller filename or not
  -logLevel string
        Set the log level (trace, debug, info, warn, error) (default "debug")
  -nni int
        Number of NNI ports per OLT device to be emulated (default 1)
  -olt_id int
        Number of OLT devices to be emulated
  -onu int
        Number of ONU devices per PON port to be emulated (default 1)
  -pon int
        Number of PON ports per OLT device to be emulated (default 1)
  -s_tag int
        S-Tag value (default 900)

BBSim also looks for a configuration file in configs/bbsim.yaml from which it reads a number of default settings. The command line options listed above override the corresponding configuration file settings. A sample configuration file is given below:

../../configs/bbsim.yaml

Using the BBSim Sadis server in ONOS

BBSim provides a simple server for testing with the ONOS Sadis app. The server listens on port 50074 by default and provides the endpoints subscribers/<id> and bandwidthprofiles/<id>.

To configure ONOS to use the BBSim Sadis server endpoints, the Sadis app must use be configured as follows (see examples/sadis-in-bbsim.json):

../../examples/sadis-in-bbsim.json

This base configuration may also be obtained directly from the BBSim Sadis server:

curl http://<BBSIM_IP>:50074/cfg -o examples/sadis.json

It can then be pushed to the Sadis app using the following command:

curl -sSL --user karaf:karaf \
    -X POST \
    -H Content-Type:application/json \
    http://localhost:8181/onos/v1/network/configuration/apps/org.opencord.sadis \
    --data @examples/sadis-in-bbsim.json

You can verify the current Sadis configuration:

curl --user karaf:karaf http://localhost:8181/onos/v1/network/configuration/apps/org.opencord.sadis

In ONOS subscriber information can be queried using sadis <id>.