Update documentation for ONOS w/sidecar logger
Change-Id: Ic23c910c0c286ea45df876882a01387d26d8c652
diff --git a/charts/onos.md b/charts/onos.md
index 5162e83..447380a 100644
--- a/charts/onos.md
+++ b/charts/onos.md
@@ -1,13 +1,17 @@
# Deploy ONOS
-The same chart can be used to deploy different flavors of ONOS, depending on the configuration applied (configurations available in the configs folder).
+## Configurations
-* **onos-fabric**: a specific version of ONOS used to control the Trellis fabric
-* **onos-voltha**: a specific version of ONOS used to control VOLTHA
-* **onos-vtn**: a speciic version of ONOS used to control VTN
-* **no configuration applied**: if no configurations are applied, a generic ONOS instance will be installed
+The same chart can be used to deploy different flavors of ONOS, depending on
+the configuration applied. These configurations can be found in the
+`helm-charts/configs` directory.
-## ONOS (manages fabric + voltha)
+* **onos**: ONOS configured for the CORD scenarios with Trellis (Fabric), VOLTHA,
+ and VTN
+* **no configuration applied**: if no configurations are applied, a generic
+ ONOS instance will be installed
+
+## ONOS with CORD configuration
```shell
helm install -n onos -f configs/onos.yaml onos
@@ -20,30 +24,41 @@
* REST/UI: 30120
* Karaf debugger: 30555
-## onos-cord (onos-vtn)
-
-```shell
-helm install -n onos-cord -f configs/onos-cord.yaml onos
-```
-
-**Nodeports exposed**
-
-* SSH: 32101
-* REST/UI: 32181
-
## Generic ONOS
```shell
helm install -n onos onos
```
-**Nodeports exposed**
+**Nodeports exposed**: None
-No ports are exposed
+## ONOS logging
-## Modify default debug level
+### `onos-log-agent` Sidecar container
-An option can be added either to the default ONOS *values.yaml* file, or overritten through an external configuration file. Here is an example:
+By default, the onos helm chart will run a sidecar container to ship logs using
+[Filebeat](https://www.elastic.co/guide/en/beats/filebeat/current/index.html)
+to [Kafka](kafka.md) for aggregation of logs with the rest of the CORD
+platform.
+
+This container is named `onos-log-agent`, and because 2 containers are running
+in the pod when you run `kubectl` you may need to use the `-c` option to
+specify which container you want to interact with. For example, to view the
+ONOS logs via kubectl, you would use:
+
+ kubectl logs onos-7bbc9555bf-2754p -c onos
+
+and to view the filebeat logs:
+
+ kubectl logs onos-7bbc9555bf-2754p -c onos-log-agent
+
+If this the sidecar isn't required, it can be disabled when installing the
+chart by passing `--set log_agent.enabled=false` or by using a values file.
+
+### Modifying ONOS logging levels
+
+An option can be added either to the default ONOS *values.yaml* file, or
+overritten through an external configuration file. Here is an example:
```yaml
application_logs: |
diff --git a/developer/configuration_rcord.md b/developer/configuration_rcord.md
index d8066af..ceb4200 100644
--- a/developer/configuration_rcord.md
+++ b/developer/configuration_rcord.md
@@ -13,7 +13,7 @@
## Prerequisites
- All the components needed for the R-CORD profile are up and running
- on your POD (xos-core, rcord-lite, voltha, onos-voltha).
+ on your POD (xos-core, rcord-lite, voltha, onos).
- Configure `OLT/PONPORT/ONU` devices using the sample
TOSCA config given below:
diff --git a/prereqs/openstack-helm.md b/prereqs/openstack-helm.md
index 7627a45..aefa6f1 100644
--- a/prereqs/openstack-helm.md
+++ b/prereqs/openstack-helm.md
@@ -121,7 +121,7 @@
ml2_type_vxlan:
vni_ranges: 1001:2000
onos:
- url_path: http://onos-cord-ui.default.svc.cluster.local:8181/onos/cordvtn
+ url_path: http://onos-ui.default.svc.cluster.local:8181/onos/cordvtn
username: onos
password: rocks
EOF