Refactor ONOS helm doc
Change-Id: Id89ef59542dfaa4fc15610d15d5d627771ff0b16
diff --git a/charts/onos.md b/charts/onos.md
index ad5f788..4b13e72 100644
--- a/charts/onos.md
+++ b/charts/onos.md
@@ -1,55 +1,50 @@
-# ONOS Helm chart
+# Deploy ONOS
-This chart can be used to deploy an ONOS container.
-Traditionally it is used to deploy three different ONOSes in the system,
-depending by what is required.
+The same chart can be used to deploy different flavors of ONOS, depending on the configuration applied (configurations available in the configs folder).
-## ONOS-Fabric
+* **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
-`helm install -n onos-fabric -f configs/onos-fabric.yaml onos`
+## onos-fabric
-Ports exposed:
+```shell
+helm install -n onos-fabric -f configs/onos-fabric.yaml onos
+```
-- ovsdb: 31640
-- OpenFlow: 31653
-- SSH: 31101
-- UI: 31181
+**Nodeports exposed**
-## ONOS-VOLHTA
+* ovsdb: 31640
+* OpenFlow: 31653
+* SSH: 31101
+* REST/UI: 31181
+
+## onos-voltha
> NOTE: This requires [VOLTHA](voltha.md) to be installed
-`helm install -n onos-voltha -f configs/onos-voltha.yaml onos`
-
-Ports exposed:
-
-- SSH: 30115
-- UI: 30120
-
-## ONOS-VTN
-
-`helm install -n onos-cord -f configs/onos-cord.yaml onos`
-
-## Overridable values
-
-This is a sample `values.yaml` that can be used to override values
-through the `-f` option:
-
-```yaml
-imagePullPolicy: Always
-onosImage: 'onosproject/onos:1.13.1'
-
-services:
- openflowServiceType: NodePort
- ovsdbServiceType: NodePort
- sshServiceType: NodePort
- uiServiceType: NodePort
- ovsdb:
- nodePort: 31640
- openflow:
- nodePort: 31653
- ssh:
- nodePort: 31101
- ui:
- nodePort: 31181
+```shell
+helm install -n onos-voltha -f configs/onos-voltha.yaml onos
```
+
+**Nodeports exposed**
+
+* SSH: 30115
+* REST/UI: 30120
+
+## onos-vtn
+
+```shell
+helm install -n onos-cord -f configs/onos-cord.yaml onos
+```
+
+The configuration doesn't expose any nodeport.
+
+## Generic ONOS
+
+```shell
+helm install -n onos onos
+```
+
+The configuration doesn't expose any nodeport.
diff --git a/mdl_relaxed.rb b/mdl_relaxed.rb
index 9448317..92e3fe8 100644
--- a/mdl_relaxed.rb
+++ b/mdl_relaxed.rb
@@ -46,3 +46,5 @@
# Exclude rule: Fenced code blocks should be surrounded by blank lines
exclude_rule 'MD031'
+# Exclude rule: Emphasis used instead of a header
+exclude_rule 'MD036'