[SEBA-882] add Sadis server
Change-Id: I2c973a940ccf1398b1c122908769e806eaa1dd14
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3fb460f..4b0af7d 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -118,3 +118,37 @@
``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 coniguration file settings. A sample configuration file is given below:
.. literalinclude:: ../../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``):
+
+.. literalinclude:: ../../examples/sadis-in-bbsim.json
+
+This base configuration may also be obtained directly from the BBSim Sadis server:
+
+.. code:: bash
+
+ curl http://<BBSIM_IP>:50074/cfg -o examples/sadis.json
+
+It can then be pushed to the Sadis app using the following command:
+
+.. code:: bash
+
+ 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:
+
+.. code:: bash
+
+ 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>``.
+