word-smithing the guide
Change-Id: I9e0affe35f561fdcee89cbec5184b9cd02ca2d57
diff --git a/README.md b/README.md
index 87b8637..268c88d 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,8 @@
* [M-CORD](./profiles/mcord/install.md)
If you are anxious to jump straight to a [Quick Start](quickstart.md)
-procedure that brings up the an emulated version of CORD running
+procedure that brings up an emulated version of CORD running
on your laptop (sorry, no subscriber data plane), then that's an option.
-Alternatively, if you want to get a broader layof-of-the-land, you
+Alternatively, if you want to get a broader lay-of-the-land, you
might step back and start with an [Overview](overview.md).
diff --git a/charts/helm.md b/charts/helm.md
index 63ce16f..8b1c2e3 100644
--- a/charts/helm.md
+++ b/charts/helm.md
@@ -34,7 +34,18 @@
is then possible to bring up the `mcord` profile, which corresponds
to ~10 other services. It is also possible to bring up an individual
service by executing its helm chart; for example
-`xos-services/exampleservice`.
+`xos-services/simpleexampleservice`.
+
+> **Note:** Sometimes we install Individual services by first
+> "wrapping" them in a profile. For example,
+> `SimpleExampleService` is deployed from the
+> `xos-profiles/demo-simpleexampleservice` profile, rather
+> than directly from `xos-services/simpleexampleservice`.
+> The latter is included by reference from the former.
+> This is not a fundamental limitation, but we do it when we
+> want to run the `tosca-loader` that loads a TOSCA workflow
+> into CORD. This feature is currently available at only
+> the profile level.
Similarly, the `base-kubernetes` profile brings up Kubernetes in
support of container-based VNFs. This corresponds to the
@@ -42,7 +53,7 @@
Kubernetes to deploy the CORD control plane. Once this profile is
running, it is possible to bring up an example VNF in a container
by executing its helm chart; for example
-`xos-services/simpleexampleservice`.
+`xos-profiles/demo-simpleexampleservice`.
> **Note:** The `base-kubernetes` configuration does not yet
> incorporate VTN. Doing so is work-in-progress.
diff --git a/charts/hippie-oss.md b/charts/hippie-oss.md
index 0d11701..7afdb4c 100644
--- a/charts/hippie-oss.md
+++ b/charts/hippie-oss.md
@@ -1,5 +1,8 @@
# Deploy Hippie OSS
+To insall a minimal (permissive) OSS container in support of subscriber
+provisioning for R-CORD, run the following:
+
```shell
helm install -n hippie-oss xos-services/hippie-oss
```
diff --git a/charts/xos-core.md b/charts/xos-core.md
index b0ecc55..54164c9 100644
--- a/charts/xos-core.md
+++ b/charts/xos-core.md
@@ -1,20 +1,22 @@
# Deploy XOS-CORE
+To deploy the XOS core and affiliated containers, run the following:
+
```shell
helm dep update xos-core
helm install -n xos-core xos-core
```
-> We highly suggest to override the default values of
-> `xosAdminUser` and `xosAdminPassword` with custom values
-
-You can do it using a [`values.yaml`](https://docs.helm.sh/chart_template_guide/#values-files) file or using this command:
+We highly suggest you override the default values of `xosAdminUser`
+and `xosAdminPassword` with custom values. You can do it using a
+[`values.yaml`](https://docs.helm.sh/chart_template_guide/#values-files)
+file, or using this command:
```shell
helm install -n xos-core xos-core --set xosAdminUser=MyUser --set xosAdminPassword=MySuperSecurePassword
```
-## Deploy kafka
+## Deploy Kafka
-Some flavors of XOS require kafka, to install it please
-follow refer to the [kafka](kafka.md) instructions.
+Some flavors of XOS require kafka. To install it, please
+refer to the [kafka](kafka.md) instructions.
diff --git a/charts/xossh.md b/charts/xossh.md
index 5a31d74..675a23e 100644
--- a/charts/xossh.md
+++ b/charts/xossh.md
@@ -1,5 +1,7 @@
# Deploy XOSSH
+To deploy the XOS-Shell, run the following:
+
```shell
helm install xos-tools/xossh -n xossh
```
diff --git a/fabric-setup.md b/fabric-setup.md
index 86c481c..475ea07 100644
--- a/fabric-setup.md
+++ b/fabric-setup.md
@@ -11,7 +11,8 @@
## Operating System
-All CORD-compatible switches use [Open Networking Linux (ONL)](https://opennetlinux.org/) as operating system.
+All CORD-compatible switches use
+[Open Networking Linux (ONL)](https://opennetlinux.org/) as the operating system.
The [latest compatible ONL image](https://github.com/opencord/OpenNetworkLinux/releases/download/2017-10-19.2200-1211610/ONL-2.0.0_ONL-OS_2017-10-19.2200-1211610_AMD64_INSTALLED_INSTALLER) can be downloaded from [here](https://github.com/opencord/OpenNetworkLinux/releases/download/2017-10-19.2200-1211610/ONL-2.0.0_ONL-OS_2017-10-19.2200-1211610_AMD64_INSTALLED_INSTALLER).
**Checksum**: *sha256:2db316ea83f5dc761b9b11cc8542f153f092f3b49d82ffc0a36a2c41290f5421*
@@ -26,7 +27,7 @@
## OFDPA Drivers
-Once ONL is installed OFDPA drivers will need to be installed as well.
+Once ONL is installed, OFDPA drivers will need to be installed as well.
Each switch model requires a specific version of OFDPA. All driver packages are distributed as DEB packages, which makes the installation process straightforward.
First, copy the package to the switch. For example
@@ -41,7 +42,7 @@
dpkg -i your-ofdpa.deb
```
-Two OFDPA drivers are available:
+Three OFDPA drivers are available:
* [EdgeCore 5712-54X / 5812-54X / 6712-32X](https://github.com/onfsdn/atrium-docs/blob/master/16A/ONOS/builds/ofdpa_3.0.5.5%2Baccton1.7-1_amd64.deb?raw=true) - *checksum: sha256:db228b6e79fb15f77497b59689235606b60abc157e72fc3356071bcc8dc4c01f*
* [QuantaMesh T3048-LY8](https://github.com/onfsdn/atrium-docs/blob/master/16A/ONOS/builds/ofdpa-ly8_0.3.0.5.0-EA5-qct-01.01_amd64.deb?raw=true) - *checksum: sha256:f8201530b1452145c1a0956ea1d3c0402c3568d090553d0d7b3c91a79137da9e*
diff --git a/navigate.md b/navigate.md
index 4e2aced..0a6db80 100644
--- a/navigate.md
+++ b/navigate.md
@@ -1,8 +1,8 @@
# Navigating CORD
-The relationship between installing, operating, and developing
-CORD—and the corresponding toolsets and specification files
-used by each stage—is helpful in navigating CORD.
+Understanding the relationship between installing, operating, and developing
+CORD—and the corresponding toolsets and specification files used by
+each stage—is helpful in navigating CORD.
* **Installation (Helm):** Installing CORD means installing a collection
of Docker containers in a Kubernetes cluster. We use Helm to carry out
@@ -42,11 +42,13 @@
TOSCA workflow into a newly deployed set of services. This is how a
service graph is typically instantiated.
-* Not all services run as Docker containers. Some services run in VMs
- managed by OpenStack (this is currently the case for M-CORD) and
- some services are implemented as ONOS applications that have been
- packaged using Maven. In such cases, the VM image and the Maven
- package are still specified in the TOSCA workflow.
+* While the CORD control plane is deployed as a set of Docker
+ containers, not all of the services themselves run in containers.
+ Some services run in VMs managed by OpenStack (this is currently
+ the case for M-CORD) and some services are implemented as ONOS
+ applications that have been packaged using Maven. In such cases,
+ the VM image and the Maven package are still specified in the TOSCA
+ workflow.
* Every service (whether implemented in Docker, OpenStack, or ONOS)
has a counter-part *synchronizer* container running as part of the CORD
diff --git a/partials/helm/description.md b/partials/helm/description.md
index 1c04574..a2f8538 100644
--- a/partials/helm/description.md
+++ b/partials/helm/description.md
@@ -1,3 +1,3 @@
Helm is the package manager for Kubernetes. It lets you define, install,
-and upgrade Kubernetes base application. For more information about Helm,
-please the visit the official website: <https://helm.sh>.
+and upgrade Kubernetes base applications. For more information about Helm,
+please the visit official website: <https://helm.sh>.
diff --git a/profiles/rcord/install.md b/profiles/rcord/install.md
index c08c1cf..2d1a717 100644
--- a/profiles/rcord/install.md
+++ b/profiles/rcord/install.md
@@ -1,21 +1,22 @@
# R-CORD Profile
The latest version of R-CORD differs from versions included in earlier
-releases in that it does not include the vSG service. In the code this
-configuration is called `rcord-lite`, but since it is the only version
-of Residential CORD currently supported, we usually simply call it
-the "R-CORD" profile.
+releases in that it does not include the vSG service. In the code,
+this new configuration is called `rcord-lite`, but since it is the
+only version of Residential CORD currently supported, we simply
+call it the *R-CORD profile.*
## Prerequisites
-- A Kubernetes cluster (you can follow one of this guide to install a [single
+- A Kubernetes cluster: Follow one of these guides to install a [single
node cluster](../../prereqs/k8s-single-node.md) or a [multi node
- cluster](../../prereqs/k8s-multi-node.md))
-- Helm, follow [this guide](../../prereqs/helm.md)
+ cluster](../../prereqs/k8s-multi-node.md).
+- Helm: Follow this [guide](../../prereqs/helm.md).
## CORD Components
-R-CORD has dependencies on this charts, so they need to be installed first:
+R-CORD has dependencies on the following charts,
+so they need to be installed first:
- [xos-core](../../charts/xos-core.md)
- [onos-fabric](../../charts/onos.md#onos-fabric)
@@ -28,8 +29,9 @@
helm install -n rcord-lite xos-profiles/rcord-lite
```
-Now that your R-CORD deployment is complete, please read this
-to understand how to configure it: [Configure R-CORD](configuration.md)
+Now that your R-CORD deployment is complete, please read the
+following guide to understand how to configure it:
+[Configure R-CORD](configuration.md)
## Customizing an R-CORD Install
@@ -62,4 +64,3 @@
```shell
helm install -n rcord-lite xos-profiles/rcord-lite -f my-rcord-values.yaml
```
-