Reference charts for SiaB
Change-Id: If8dc7e244077e8718e4cb56b462ee3f3585387a1
diff --git a/SUMMARY.md b/SUMMARY.md
index 20c4ea7..623990e 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -121,3 +121,6 @@
* [Logging and Monitoring](charts/logging-monitoring.md)
* [Persistent Storage](charts/storage.md)
* [BBSim](charts/bbsim.md)
+ * [PONNET](charts/ponnet.md)
+ * [PONSIM v2](charts/ponsimv2.md)
+ * [PONSIM Pod](charts/ponsim-pod.md)
diff --git a/charts/ponnet.md b/charts/ponnet.md
new file mode 100644
index 0000000..1c2831e
--- /dev/null
+++ b/charts/ponnet.md
@@ -0,0 +1,18 @@
+# PONNET Helm Chart
+
+The `ponnet` Helm chart installs and configures Kubernetes CNI plugins
+for [PONSIM](ponsimv2.md). Currently it creates two Linux bridges, `pon0`
+and `pon1`, that allow a L2 dataplane to be created between the PONSIM
+RG and components upstream of the PONSIM OLT. Note that the bridges
+are not actually created until [PONSIM](ponsimv2.md) is installed.
+
+You can install the chart using:
+
+```bash
+helm install -n ponnet ponnet
+```
+
+The chart modifies the underlying Kubernetes setup by installing the `bridge`
+CNI and adding configuration files to create the two bridges. Kubernetes must
+be configured with CNI enabled. Note that this chart does not seem to work
+on `minikube`.
diff --git a/charts/ponsim-pod.md b/charts/ponsim-pod.md
new file mode 100644
index 0000000..b84fea3
--- /dev/null
+++ b/charts/ponsim-pod.md
@@ -0,0 +1,10 @@
+# PONSIM Pod
+
+This chart just loads TOSCA for adding a PONSIM OLT and Mininet
+AGG Switch to XOS. It is used by [SiaB](../profiles/seba/siab.md).
+
+You can install it using:
+
+```bash
+helm install -n ponsim-pod xos-profiles/ponsim-pod/
+```
diff --git a/charts/ponsimv2.md b/charts/ponsimv2.md
new file mode 100644
index 0000000..a50c74d
--- /dev/null
+++ b/charts/ponsimv2.md
@@ -0,0 +1,31 @@
+# PONSIM v2 Helm Chart
+
+The `ponsimv2` chart deploys the PON Simulator (PONSIM) containers
+(a virtual OLT, ONU, and RG) in the context of VOLTHA.
+This chart is used by [SiaB](../profiles/seba/siab.md).
+More details about PONSIM can be found in
+[its README](https://github.com/opencord/voltha/blob/master/ponsim/v2/README.md).
+
+You must install the [PONNET](ponnet.md) chart before installing this one.
+At that point you can install PONSIM using:
+
+```bash
+helm install -n ponsimv2 ponsimv2
+```
+
+After a successful install you will see containers like these running in the
+VOLTHA namespace:
+
+```bash
+$ kubectl -n voltha get pod
+NAME READY STATUS RESTARTS AGE
+...
+olt-77468cfccd-7ltzr 1/1 Running 0 10m
+onu-6d7d5db8f-pk59s 1/1 Running 0 10m
+rg-5fbddf9bdf-b292r 1/1 Running 0 10m
+...
+```
+
+If any of the containers do not come up successfully, the issue is likely
+that the [PONNET](ponnet.md) chart is not loaded or was not able to create
+the two Linux bridges.