Pass over docs
Change-Id: I5f7edc29f1e364cab0243fcc11daf40424fb7997
diff --git a/INSTALL_SINGLE_NODE.md b/INSTALL_SINGLE_NODE.md
index 0b6ce26..17a9718 100644
--- a/INSTALL_SINGLE_NODE.md
+++ b/INSTALL_SINGLE_NODE.md
@@ -1,5 +1,6 @@
# Installing a CORD POD on a Single Physical Host
-[*This description is for bringing up a CORD POD on virtual machines on a single physical host. The purpose of this solution is to enable those interested in understanding how CORD works to examine and interact with a running CORD environment.*]
+[*This description is for bringing up a CORD POD on virtual machines on a single physical host. The purpose
+of this solution is to enable those interested in understanding how CORD works to examine and interact with a running CORD environment.*]
This tutorial walks you through the steps to bring up a CORD "POD" on a single server using multiple virtual machines.
@@ -30,8 +31,8 @@
then you must apply for your own separate CloudLab project.*]
Once your account is approved, start an experiment using the `OnePC-Ubuntu14.04.4` profile
-on either the Wisconsin or Clemson cluster. This will provide you with a target server
-meeting the above requirements temporarily.
+on either the Wisconsin or Clemson cluster. This will provide you with a temporary target server
+meeting the above requirements.
Refer to the [CloudLab documentation](https://docs.cloudlab.us) for more information.
diff --git a/README.md b/README.md
index 43d4dc7..5bdf200 100644
--- a/README.md
+++ b/README.md
@@ -1,155 +1,9 @@
# platform-install
This repository contains [Ansible](http://docs.ansible.com) playbooks for
-installing and configuring an OpenStack Kilo cluster for use with XOS. This is
-how we build clusters for [OpenCloud](http://opencloud.us), and is the method
-of installing a [CORD](http://cord.onosproject.org) development POD as well.
+installing and configuring software components on a CORD POD: OpenStack, ONOS,
+and XOS. It is a sub-module of the [main CORD repository](https://github.com/opencord/cord).
-All of the OpenStack controller services are installed in VMs on a single "head
-node" and connected by an isolated private network.
-[Juju](http://www.ubuntu.com/cloud/tools/juju) is used to install and configure
-the OpenStack services.
+To install a single-node CORD POD, read [INSTALL_SINGLE_NODE.md](./INSTALL_SINGLE_NODE.md).
-## Prerequisites (OpenCloud and CORD)
-
-* *Set up control machine:* The install playbooks in this repository can either run on a
- separate control machine (e.g., a laptop) or on the cluster head node. Either way:
- * Install a recent version of Ansible (Ansible 1.9.x on Mac OS X or Ubuntu should work).
- * Be able to login to all of the cluster servers from the control machine using SSH.
-* *Set up servers:* One server in the cluster will be the "head" node, running the OpenStack
- services. The rest will be "compute" nodes.
- * Install Ubuntu 14.04 LTS on all servers.
- * The user account used to login from the control machine must have *sudo* access.
- * Each server should have a single active NIC (preferably eth0) with connectivity to the
- Internet.
-
-## How to install a CORD POD
-
-The CORD POD install procedure uses the "head node" of the cluster as the
-control machine for the install. As mentioned above, install Ansible on the
-head node and check out this repository.
-
-The playbooks assume that a bridge called *mgmtbr* on the head node is
-connected to the management network. Note that also there must be a DHCP
-server on the management network that:
-
- 1. hands out IP addresses to VMs connected to *mgmtbr*
- 2. resolves VM names to IP addresses
- 3. is configured as a resolver on the head and compute nodes
-
-If you need to set up `dnsmasq` to do this,
-take a look at [this example configuration](files/etc/dnsmasq.d/cord).
-Then follow these steps:
-
-* Run the `bootstrap.sh` script to install Ansible and set up keys for login
- via `localhost`
-* Edit *cord-hosts* with the DNS names of your compute nodes, and update the
- *ansible_ssh_user* variable appropriately. Before proceeding, these commands
- needs to work on the head node:
-
-```
-$ ansible -i cord-hosts head -m ping
-$ ansible -i cord-hosts compute -m ping
-```
-
-* Run the following command:
-
-```
-ansible-playbook -i cord-hosts cord-setup.yml
-```
-* Be patient! Some tasks in the above playbook can take a while to complete.
- For example, the "Add virtual machines to Juju's control" task will take
- about 10 minutes (or more, if you have a slow Internet connection).
-* After the playbook finishes, wait for the OpenStack services to come up. You
- can check on their progress using `juju status --format=tabular`. It should
- take about 30 minutes to install and configure all the OpenStack services.
-* Once the services are up, you can use the `admin-openrc.sh` credentials in
- the home directory to interact with OpenStack. You can SSH to any VM using
- `ssh ubuntu@<vm-name>`
-
-This will bring up various OpenStack services, including Neutron with the VTN
-plugin. It will also create two VMs called *xos* and *onos-cord* and prep
-them. Configuring and running XOS and ONOS in these VMs is beyond the scope of
-this README.
-
-*NOTE:* The install process only brings up a single nova-compute node. To
-bring up more nodes as compute nodes, perform these steps on the head node:
-
-```
-$ juju add-machine ssh:<user>@<compute-host>
-$ juju add-unit nova-compute --to <juju-machine-id>
-```
-
-Refer to the [Juju documentation](https://jujucharms.com/docs/stable/config-manual)
-for more information.
-
-### Caveats
-
-* The goal is to configure HA for the OpenStack services, but this is not yet implemented.
-
-## How to install a single-node CORD test environment on CloudLab
-
-Setting up a single-node CORD environment is simple.
-
-* Start a CloudLab experiment using profile *OnePC-Ubuntu14.04.4* and login to
- the node
-* `wget
- https://raw.githubusercontent.com/opencord/platform-install/master/scripts/single-node-pod.sh`
-* `bash single-node-pod.sh [-t] [-e]`
- * With no options, the script installs the OpenStack services and a simulated
- fabric. It creates VMs for XOS and ONOS but does not start these services.
- * Adding the `-t` option will start XOS, bring up a vSG, install a test
- client, and run a simple E2E test.
- * Adding the `-e` option will add the
- [ExampleService](http://guide.xosproject.org/devguide/exampleservice/) to
- XOS (and test it if `-t` is also specified).
-
-As mentioned above, be patient! With a fast Internet connection, the entire
-process will take at least one hour to complete.
-
-The install will bring up various OpenStack services, including Neutron with
-the VTN plugin. It will also create two VMs called *xos* and *onos-cord* and
-prep them. It creates a single nova-compute node running inside a VM.
-
-It should be possible to use this method on any server running Ubuntu 14.04, as
-long as it has sufficient CPU cores and disk space. A server with at least 12
-cores and 48GB RAM is recommended.
-
-
-## How to install an OpenCloud cluster
-
-Once the prerequisites are satisfied, here are the basic steps for installing a
-new OpenCloud cluster named 'foo':
-
-* Create *foo-setup.yml* and *foo-compute.yml* files using *cloudlab-setup.yml*
- and *cloudlab-compute.yml* as templates. Create a *foo-hosts* file with the
- DNS names of your nodes based on *cloudlab-hosts*.
-* If you are **not** installing on CloudLab, edit *foo-hosts* and add
- *cloudlab=False* under *[all:vars]*.
-* If you are installing a cluster for inclusion in the **public OpenCloud**,
- change *mgmt_net_prefix* in *foo-setup.yml* to be unique across all OpenCloud
- clusters.
-* To set up Juju, use it to install the OpenStack services on the head node,
- and prep the compute nodes, run on the head node: ``` $ ansible-playbook -i
- foo-hosts foo-setup.yaml ```
-* Log into the head node. For each compute node, put it under control of Juju,
- e.g.: ``` $ juju add-machine ssh:ubuntu@compute-node ```
-* To install the *nova-compute* service on the compute nodes that were added to
- Juju, run on the control machine: ``` $ ansible-playbook -i foo-hosts
- foo-compute.yaml ```
-
-### Caveats
-
-* The installation configures port forwarding so that the OpenStack services
- can be accessed from outside the private network. Some OpenCloud-specific
- firewalling is also introduced, which will likely require modification for
- other setups. See:
- [files/etc/libvirt/hooks/qemu](https://github.com/andybavier/opencloud-cluster-setup/blob/master/files/etc/libvirt/hooks/qemu).
-* By default the compute nodes are controlled and updated automatically using
- *ansible-pull* from [this
- repo](https://github.com/andybavier/opencloud-nova-compute-ansible). You may
- want to change this.
-* All of the service interfaces are configured to use SSL because that's what
- OpenCloud uses in production. To turn this off, look for the relevant Juju
- commands in *cloudlab-setup.yaml*.
-
+Otherwise you should start with the [CORD repository](https://github.com/opencord/cord).