Fixes to documentation
Change-Id: I0d12669b4e1a4c017878465aa5899f85c14c73e5
diff --git a/SUMMARY.md b/SUMMARY.md
index da0aec2..53c4b1c 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -103,19 +103,20 @@
* [OpenStack](openstack/openstack-service.md)
* [VTN](vtn-service/README.md)
* [Helm Reference](charts/helm.md)
- * [XOS-CORE](charts/xos-core.md)
- * [ONOS](charts/onos.md)
- * [VOLTHA](charts/voltha.md)
- * [Kafka](charts/kafka.md)
* [Base Kubernetes](charts/base-kubernetes.md)
* [Base OpenStack](charts/base-openstack.md)
* [OpenStack](prereqs/openstack-helm.md)
* [VTN Setup](prereqs/vtn-setup.md)
- * [M-CORD](charts/mcord.md)
- * [XOSSH](charts/xossh.md)
- * [Logging and Monitoring](charts/logging-monitoring.md)
- * [Persistent Storage](charts/storage.md)
* [BBSim](charts/bbsim.md)
+ * [Kafka](charts/kafka.md)
+ * [Logging and Monitoring](charts/logging-monitoring.md)
+ * [M-CORD](charts/mcord.md)
+ * [ONOS](charts/onos.md)
+ * [Persistent Storage](charts/storage.md)
* [PONNET](charts/ponnet.md)
* [PONSIM v2](charts/ponsimv2.md)
* [PONSIM Pod](charts/ponsim-pod.md)
+ * [SEBA services](charts/seba-services.md)
+ * [VOLTHA](charts/voltha.md)
+ * [XOS-CORE](charts/xos-core.md)
+ * [XOSSH](charts/xossh.md)
diff --git a/charts/kafka.md b/charts/kafka.md
index 5d9b35e..1095486 100644
--- a/charts/kafka.md
+++ b/charts/kafka.md
@@ -3,9 +3,8 @@
The *kafka* helm chart is not maintained by CORD, but it is available online
at: <https://github.com/kubernetes/charts/tree/master/incubator/kafka>
-To install kafka using the `cord-kafka` name, create a YAML values file to
-configure Kafka (for developers, this is in
-`helm-charts/example/kafka-single.yaml`):
+To install kafka using the *cord-kafka* name, create a YAML values file to
+configure Kafka (for developers, this is in *helm-charts/example/kafka-single.yaml*):
```yaml
---
@@ -38,10 +37,13 @@
> NOTE: Historically there were two kafka busses deployed (another one named
> `voltha-kafka`) but these have been consolidated.
-## Viewing events with kafkacat
+## Optional tool: viewing events with kafkacat
-As a debugging tool you can deploy a container containing `kafkacat` and use
-that to listen for events:
+Optionally, you can deploy a *kafkacat* container to to listen for Kafka events and debug:
+
+{% include "../partials/helm/add-cord-repo.md" %}
+
+Then, you can proceed with the kafkacat installation:
```shell
helm install -n kafkacat cord/kafkacat
diff --git a/charts/onos.md b/charts/onos.md
index 7d7c27c..f5e2abe 100644
--- a/charts/onos.md
+++ b/charts/onos.md
@@ -5,7 +5,7 @@
Then, to install ONOS run:
```shell
-helm install -n cord/onos
+helm install -n onos cord/onos
```
**Nodeports exposed**
diff --git a/platform.md b/platform.md
index 20efd40..d926b1c 100644
--- a/platform.md
+++ b/platform.md
@@ -13,14 +13,17 @@
helm install -n cord-platform cord/cord-platform --version=6.1.0
```
-## CORD Platform as Separate Components
+## Alternatively, install CORD Platform as Separate Components
Alternatively, you may want to install the individual components separately.
-The following are the individual components included in the `cord-platform` chart:
+The following are the individual components included in the *cord-platform* chart:
- [ONOS](./charts/onos.md#onos-manages-fabric--voltha)
- [XOS](./charts/xos-core.md)
- [Kafka](./charts/kafka.md)
+
+Optionally, you may also want to install logging and monitoring infrastructure components:
+
- [Logging-Monitoring](./charts/logging-monitoring.md)
## Verify your installation and next steps
diff --git a/profiles/seba/install.md b/profiles/seba/install.md
index c4318ed..9a6573c 100644
--- a/profiles/seba/install.md
+++ b/profiles/seba/install.md
@@ -8,11 +8,11 @@
In order to run SEBA you need to have the [CORD Platform](../../platform.md) installed.
-Specifically, wait for the EtcdCluster CustomResourceDefinitions to
+Specifically, wait for the three EtcdCluster CustomResourceDefinitions to
appear in Kubernetes:
```shell
-kubectl get crd | grep etcd
+kubectl get crd | grep etcd | wc -l
```
Once the CRDs are present, proceed with the `seba` chart installation.
@@ -27,7 +27,7 @@
helm install -n seba cord/seba --version=1.0.0
```
-### SEBA as separate components
+### Alternatively, install SEBA as separate components
The main reason to install the SEBA Profile by installing its standalone
components is if you're developing on it and you need granular control.