CORD-3064 Tweaks to M-CORD documentation
Change-Id: Ia446de9981d6d786884af2007f3260702407fefe
diff --git a/prereqs/openstack-helm.md b/prereqs/openstack-helm.md
index 5c80bb8..1d9f651 100644
--- a/prereqs/openstack-helm.md
+++ b/prereqs/openstack-helm.md
@@ -119,6 +119,18 @@
export OSH_EXTRA_HELM_ARGS_NEUTRON="-f /tmp/neutron-cord.yaml"
```
+It is also necessary to make a small change to `openstack-helm`'s
+[openvswitch](https://github.com/openstack/openstack-helm/tree/master/openvswitch) chart: the `/usr/sbin/ovsdb-server` must be executed with
+the `--remote=ptcp:6641` option to listen for the connection from VTN.
+After the `openstack-helm` repository is checked out during the
+[install process](#install-process-for-openstack-helm),
+run the following command:
+
+```bash
+cd openstack-helm/openvswitch/templates/bin
+sed -i 's/--remote=db:Open_vSwitch,Open_vSwitch,manager_options/--remote=db:Open_vSwitch,Open_vSwitch,manager_options --remote=ptcp:6641/' _openvswitch-db-server.sh.tpl
+```
+
## Install Process for openstack-helm
Please see the `openstack-helm` documentation for instructions on how to
diff --git a/profiles/mcord/install.md b/profiles/mcord/install.md
index 6a93a23..89bbb76 100644
--- a/profiles/mcord/install.md
+++ b/profiles/mcord/install.md
@@ -1,5 +1,22 @@
# M-CORD
+## Quick Start
+
+A convenience script is provided that will install M-CORD on a single
+node, suitable for evaluation or testing. Requirements:
+
+- An Ubuntu 16.04 node with at least 64GB of RAM and 32 virtual CPUs
+- User invoking the script has passwordless `sudo` capability
+- Hostname is resolvable in DNS, e.g., `dig +short $( hostname )` returns an IP address
+
+```bash
+git clone https://gerrit.opencord.org/automation-tools
+automation-tools/mcord/mcord-in-a-box.sh
+```
+
+This script takes about an hour to complete. If you run it, you can skip
+directly to [Validating the Installation](#validating-the-installation) below.
+
## Prerequisites
M-CORD requires OpenStack to run VNFs. The OpenStack installation