Addding operating CORD section
Change-Id: I26ee8da35d42dfa93af24aa9945f7b1330e94acb
diff --git a/README.md b/README.md
index c446a9e..7fff017 100644
--- a/README.md
+++ b/README.md
@@ -18,8 +18,8 @@
You're finally ready to install the CORD components. Choose the component you'd like to install.
-- [RCORD-lite](./profiles/rcord-lite.md)
-- [MCORD](./profiles/mcord.md)
+- [RCORD-lite](./profiles/rcord/install.md)
+- [MCORD](./profiles/mcord/install.md)
## More
diff --git a/SUMMARY.md b/SUMMARY.md
index 3c77719..d6d84d5 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -12,18 +12,26 @@
* [Docker Registry](prereqs/docker-registry.md)
* [Fabric setup](prereqs/fabric-setup.md)
* [Install CORD](profiles/intro.md)
- * [RCORD Lite](profiles/rcord-lite.md)
- * [OLT Setup](profiles/olt-setup.md)
- * [MCORD](profiles/mcord.md)
- * [EnodeB Setup](profiles/enodeb-setup.md)
- * [OpenStack Integration](openstack.md)
+ * [RCORD Lite](profiles/rcord/install.md)
+ * [OLT Setup](profiles/rcord/olt-setup.md)
+ * [MCORD](profiles/mcord/install.md)
+ * [EnodeB Setup](profiles/mcord/enodeb-setup.md)
+ * [OpenStack Integration](prereqs/openstack.md)
* [Helm Reference](charts/helm.md)
* [XOS-CORE](charts/xos-core.md)
* [ONOS](charts/onos.md)
* [VOLTHA](charts/voltha.md)
* [Kafka](charts/kafka.md)
* [Operating CORD](operating_cord/operating_cord.md)
- * [Diagnostics](operating_cord/diag.md)
+ * General info
+ * [Diagnostics](operating_cord/diag.md)
+ * [REST API](operating_cord/rest_apis.md)
+ * [TOSCA](xos-tosca/README.md)
+ * [XOSSH](xos/dev/xossh.md)
+ * [XOS Internals](operating_cord/xos_internals.md)
+ * [XOS Containers](xos/xos_internals.md)
+ * [XOS Configuration](xos/modules/xosconfig.md)
+ * [RCORD](profiles/rcord/setup.md)
* [Defining Models in CORD](xos/README.md)
* [XOS Support for Models](xos/dev/xproto.md)
* [Core Models](xos/core_models.md)
@@ -49,3 +57,4 @@
* [Test Setup](cord-tester/qa_testsetup.md)
* [Test Environment](cord-tester/qa_testenv.md)
* [System Tests](cord-tester/validate_pods.md)
+
diff --git a/operating_cord/operating_cord.md b/operating_cord/operating_cord.md
index 49966c6..9b6f9a7 100644
--- a/operating_cord/operating_cord.md
+++ b/operating_cord/operating_cord.md
@@ -1 +1,17 @@
-# Operating CORD
\ No newline at end of file
+# Operating CORD
+
+This guide defines various processes and procedures for operating a
+CORD POD. It assumes the [build-and-install](../README.md) has already
+completed, and you want to operate and manage a running POD.
+
+Today, CORD most often runs for demo, development, or evaluation
+purposes, so this guide is limited to simple procedures suitable for
+such settings. We expect more realistic operational scenarios will be
+supported in the future.
+
+It is also the case that CORD's operations and management interface
+is primarily defined by its Northbound API. The RESTful version of
+this API is documented [here](rest_apis.md)
+
+This API is auto-generated from a set of models, where CORD's
+model-based design is describe [elsewhere](../xos/README.md).
diff --git a/operating_cord/rest_apis.md b/operating_cord/rest_apis.md
new file mode 100644
index 0000000..d507149
--- /dev/null
+++ b/operating_cord/rest_apis.md
@@ -0,0 +1,20 @@
+# CORD REST APIs
+
+## XOS
+
+A RESTful interface is available for configuring and controlling XOS. It is
+auto-generated from the set of [models](/xos/README.md) configured into the POD
+manifest, and includes both core and service-specific models.
+
+* [Core](https://guide.opencord.org/{{ book.branch }}/api/xos/#/core)
+* [Address Manager](https://guide.opencord.org/{{ book.branch }}/api/xos/#/addressmanager)
+* [vTR](https://guide.opencord.org/{{ book.branch }}/api/xos/#/vtr)
+* [vSG](https://guide.opencord.org/{{ book.branch }}/api/xos/#/vsg)
+* [vNoD Local](https://guide.opencord.org/{{ book.branch }}/api/xos/#/vnodlocal)
+* [vRouter](https://guide.opencord.org/{{ book.branch }}/api/xos/#/vrouter)
+* [ONOS Service](https://guide.opencord.org/{{ book.branch }}/api/xos/#/onos)
+* [Fabric Service](https://guide.opencord.org/{{ book.branch }}/api/xos/#/fabric)
+* [Example Service](https://guide.opencord.org/{{ book.branch }}/api/xos/#/exampleservice)
+* [vEE](https://guide.opencord.org/{{ book.branch }}/api/xos/#/vee)
+* [vEG](https://guide.opencord.org/{{ book.branch }}/api/xos/#/veg)
+* [vnaas](https://guide.opencord.org/{{ book.branch }}/api/xos/#/vnaas)
diff --git a/operating_cord/xos_internals.md b/operating_cord/xos_internals.md
new file mode 100644
index 0000000..735e69d
--- /dev/null
+++ b/operating_cord/xos_internals.md
@@ -0,0 +1,14 @@
+# XOS Internals
+
+XOS is the component of CORD that implements the control plane
+through which operators control and manage CORD. This normally
+happens through a set of XOS-generated interfaces:
+
+* [TOSCA](../xos-tosca/README.md)
+* [REST API](rest_apis.md)
+* [XOSSH](../xos/dev/xossh.md)
+
+This section describes XOS internals, including how it is configured and
+deployed on a running POD. Additional information about how to write
+XOS models (from which these interfaces are generated) is
+described [elsewhere](../xos/README.md) in thie guide.
diff --git a/overview.md b/overview.md
index 3795cbe..c1a4dd7 100644
--- a/overview.md
+++ b/overview.md
@@ -14,9 +14,9 @@
The [http://guide.opencord.org](http://guide.opencord.org) website is built
using the [GitBook Toolchain](https://toolchain.gitbook.com/), with the
documentation root in
-[build/docs](https://github.com/opencord/cord/blob/{{ book.branch }}/docs) in a
-checked out source tree. It is build with `make`, and requires that gitbook,
-python, and a few other tools are installed.
+[docs](https://github.com/opencord/docs/blob/{{ book.branch }}) in a
+checked out source tree. It is build with `make`, and requires that `gitbook`,
+`python`, and a few other tools are installed.
Source for individual guides is available in the [CORD code
repository](https://gerrit.opencord.org); look in the `docs` directory of each
diff --git a/openstack.md b/prereqs/openstack.md
similarity index 100%
rename from openstack.md
rename to prereqs/openstack.md
diff --git a/profiles/mcord.md b/profiles/mcord.md
deleted file mode 100644
index 5e60d83..0000000
--- a/profiles/mcord.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# MCORD
-
-## Prerequisites
-
-Lorem ipsum dolor sit amet, consectetur adipisicing elit. Nobis veritatis
-eligendi vitae dolorem animi non unde odio, hic quasi totam recusandae repellat
-minima provident aliquam eveniet a tempora saepe. Iusto.
-
-- A Kubernetes cluster (you will need a [multi node
- cluster](../prereqs/k8s-multi-node.md))
-- Helm, follow [this guide](../prereqs/helm.md)
-- Openstack-Helm, follow [this guide](../prereqs/openstack-helm.md)
-
-## CORD Components
-
-Lorem ipsum dolor sit amet, consectetur adipisicing elit. Fugit et quam tenetur
-maiores dolores ipsum hic ex doloremque, consectetur porro sequi vitae tempora
-in consequuntur provident nostrum nobis. Error, non?
-
-Then you need to install this charts:
-
-- [xos-core](../charts/xos-core.md)
-- [onos-fabric](../charts/onos.md#onos-fabric)
-- [onos-vtn](../charts/onos.md#onos-vtn)
diff --git a/profiles/enodeb-setup.md b/profiles/mcord/enodeb-setup.md
similarity index 100%
rename from profiles/enodeb-setup.md
rename to profiles/mcord/enodeb-setup.md
diff --git a/profiles/mcord/install.md b/profiles/mcord/install.md
new file mode 100644
index 0000000..e513eec
--- /dev/null
+++ b/profiles/mcord/install.md
@@ -0,0 +1,23 @@
+# MCORD
+
+## Prerequisites
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Nobis veritatis
+eligendi vitae dolorem animi non unde odio, hic quasi totam recusandae repellat
+minima provident aliquam eveniet a tempora saepe. Iusto.
+
+- A Kubernetes cluster (you will need a [multi nodecluster](../../prereqs/k8s-multi-node.md))
+- Helm, follow [this guide](../../prereqs/helm.md)
+- Openstack-Helm, follow [this guide](../../prereqs/openstack-helm.md)
+
+## CORD Components
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Fugit et quam tenetur
+maiores dolores ipsum hic ex doloremque, consectetur porro sequi vitae tempora
+in consequuntur provident nostrum nobis. Error, non?
+
+Then you need to install this charts:
+
+- [xos-core](../../charts/xos-core.md)
+- [onos-fabric](../../charts/onos.md#onos-fabric)
+- [onos-vtn](../../charts/onos.md#onos-vtn)
diff --git a/profiles/rcord-lite.md b/profiles/rcord/install.md
similarity index 81%
rename from profiles/rcord-lite.md
rename to profiles/rcord/install.md
index c3f9156..8855302 100644
--- a/profiles/rcord-lite.md
+++ b/profiles/rcord/install.md
@@ -7,9 +7,9 @@
minima provident aliquam eveniet a tempora saepe. Iusto.
- A Kubernetes cluster (you can follow one of this guide 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)
+ node cluster](../../prereqs/k8s-single-node.md) or a [multi node
+ cluster](../../prereqs/k8s-multi-node.md))
+- Helm, follow [this guide](../../prereqs/helm.md)
## CORD Components
@@ -19,9 +19,9 @@
Then you need to install this charts:
-- [xos-core](../charts/xos-core.md)
-- [onos-fabric](../charts/onos.md#onos-fabric)
-- [onos-voltha](../charts/onos.md#onos-voltha)
+- [xos-core](../../charts/xos-core.md)
+- [onos-fabric](../../charts/onos.md#onos-fabric)
+- [onos-voltha](../../charts/onos.md#onos-voltha)
- kafka
## Install the RCORD-Lite helm chart
diff --git a/profiles/olt-setup.md b/profiles/rcord/olt-setup.md
similarity index 100%
rename from profiles/olt-setup.md
rename to profiles/rcord/olt-setup.md
diff --git a/profiles/rcord/setup.md b/profiles/rcord/setup.md
new file mode 100644
index 0000000..c5dd3fe
--- /dev/null
+++ b/profiles/rcord/setup.md
@@ -0,0 +1,3 @@
+# RCORD POD Configuration
+
+Coming soon
diff --git a/terminology.md b/terminology.md
index 2569c31..73074cd 100644
--- a/terminology.md
+++ b/terminology.md
@@ -26,12 +26,3 @@
: A switch in a POD that interconnects other switches and servers inside the
POD.
-**vSG**
-: The virtual Subscriber Gateway (vSG) is the CORD counterpart for existing
- CPEs. It implements a bundle of subscriber-selected functions, such as
- Restricted Access, Parental Control, Bandwidth Metering, Access Diagnostics and
- Firewall. These functions run on commodity hardware located in the Central
- Office rather than on the customer’s premises. There is still a device in the
- home (which we still refer to as the CPE), but it has been reduced to a
- bare-metal switch.
-