[VOL-2176] Adding -no-auth and -no-dhcp option in BBSim CLI
Change-Id: I3d0f7adb26c1df0d42f67b9b8fbc782754491c31
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 9acc4d5..585de35 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -41,12 +41,24 @@
helm install -n bbsim cord/bbsim
+If you need to specify a custom image for BBSim you can:
+
+.. code:: bash
+
+ 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:
.. code:: bash
helm install -n bbsim cord/bbsim --set onu=8 --set pon=2
+BBSim can also be configured to automatically start Authentication or DHCP:
+
+.. code:: bash
+
+ helm install -n bbsim cord/bbsim --set auth=true --set dhcp=true
+
Once BBSim is installed you can verify that it's running with:
.. code:: bash
@@ -67,3 +79,35 @@
.. code:: bash
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``
+
+.. code:: bash
+
+ $ ./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
+ -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)