Adding some documentation in preparation for VOLTHA-2.6 release
Change-Id: I13dc03a901946d7e4b7a481f738f7784494e56b0
diff --git a/README.md b/README.md
index 06f033e..445b86f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,49 @@
# BBSim Sadis Server
This project is designed to aggregate Sadis entries from multiple BBSim instances running on the same kubernetes cluster.
+
This tool assumes that:
- The sadis service is exposed on the default port `50074`
- BBSim(s) are deployed with the default label `app=bbsim`
+This component is part of the the VOLTHA project, more informations at:
+https://docs.voltha.org
+
## Deploy
```shell
-kubectl create configmap kube-config --from-file=kube_config=$KUBECONFIG
-kubectl apply -f deployments/bbsim-sadis-server.yaml
-```
\ No newline at end of file
+helm repo add onf https://charts.opencord.org
+helm install bbsim-sadis-server onf/bbsim-sadis-server
+```
+
+## Configure ONOS to use `bbsim-sadis-server`
+
+Assuming that `bbsim-sadis-server` was installed in the `default` namespace,
+you can use this configuration to point ONOS to it:
+
+```json
+{
+ "sadis" : {
+ "integration" : {
+ "url" : "http://bbsim-sadis-server.default.svc:58080/subscribers/%s",
+ "cache" : {
+ "enabled" : true,
+ "maxsize" : 50,
+ "ttl" : "PT1m"
+ }
+ }
+ },
+ "bandwidthprofile" : {
+ "integration" : {
+ "url" : "http://bbsim-sadis-server.default.svc:58080/profiles/%s",
+ "cache" : {
+ "enabled" : true,
+ "maxsize" : 50,
+ "ttl" : "PT1m"
+ }
+ }
+ }
+}
+```
+
+For more inforation about the `sadis` application you can refer to: https://github.com/opencord/sadis
\ No newline at end of file
diff --git a/VERSION b/VERSION
index 17e51c3..d917d3e 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.1.1
+0.1.2