Documentation Structure
Change-Id: I4a2b4392267af08635aa8ebeae4631d4ffb583af
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4b89fda
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+npm-debug.log
+_book/
+node_modules/
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..84209cd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# OpenCord Introduction
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quod ducimus impedit quidem sapiente necessitatibus quo hic ut! Fugit ut sed sapiente maiores officia natus, deleniti, repellendus et nam quibusdam iusto!
+
+## Bill Of Materials
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Neque optio, ea error tenetur mollitia, repellendus consectetur iste hic molestias autem odio minima doloremque at sunt recusandae fugiat quidem quo architecto.
+
+See the full requirements [here](./prereqs/hardware.md)
+
+## Networking Connectivity
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Deleniti adipisci vero labore nostrum nulla dolore aut dolorem quis consequatur fuga ratione laudantium, ipsam, iusto incidunt similique eius illo cumque voluptatibus.
+
+[networking setup](./prereqs/networking.md)
+
+## Software Requirements
+
+### Kubernetes Installation
+
+If you know what we are talking about you can just go and install a Kubernetes cluster (> 1.9) in any way you want, otherwise you can follow one of this guide to install it:
+
+- [Install minikube on a single node](./prereqs/minikube.md)
+- [Install kubespray on a multiple nodes](./prereqs/kubespray.md)
+
+### Helm
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Labore magnam asperiores modi, amet suscipit hic itaque iste fugit nam voluptate, architecto fugiat quisquam ratione, consequuntur eum iure voluptas quo molestias.
+
+If you need help installing helm you can follow this guide: [Helm Installation](./prereqs/helm.md)
+
+## Deploy CORD profiles
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo dolorem totam facilis vel suscipit adipisci aspernatur recusandae cumque hic ipsa nemo nulla, dicta illum, earum? Dicta consequuntur eos corporis, placeat.
+
+- [RCORD-lite](./profiles/rcord-lite.md)
+- [MCORD](./profiles/mcord.md)
+
+## Appendix
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Voluptate nihil culpa, ratione doloribus, minima numquam ex commodi fuga sunt vero tempore pariatur officia nobis magni cupiditate. Consequuntur quam modi culpa!
+
+
+### Offline Installation
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Laudantium iure cum totam nihil impedit nemo voluptatum, commodi sequi animi quidem earum sed harum, velit aliquid, iusto tenetur consequuntur, praesentium asperiores.
+
+If you need help in setting up and insecure docker registry (good for non production environments) you can follow [this guide](./prereqs/docker-registry.md)
+
+### OpenStack-Helm Setup
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Laudantium iure cum totam nihil impedit nemo voluptatum, commodi sequi animi quidem earum sed harum, velit aliquid, iusto tenetur consequuntur, praesentium asperiores.
+
+If you need help in setting up and insecure docker registry (good for non production environments) you can follow [this guide](./prereqs/docker-registry.md)
\ No newline at end of file
diff --git a/SUMMARY.md b/SUMMARY.md
new file mode 100644
index 0000000..04573c1
--- /dev/null
+++ b/SUMMARY.md
@@ -0,0 +1,32 @@
+# Summary
+
+* [Installation Guide](README.md)
+ * [Bill Of Materials](./prereqs/hardware.md)
+ * [Networking Connectivity](./prereqs/networking.md)
+ * Software Requirements
+ * Kubernetes
+ * [Single Node KB8s](prereqs/minikube.md)
+ * [Multi Node KB8s](prereqs/kubespray.md)
+ * [Helm](prereqs/helm.md)
+ * [Docker Registry](prereqs/docker-registry.md)
+ * [OpenStack Integration](prereqs/openstack-helm.md)
+ * [Profiles]()
+ * [RCORD Lite](profiles/rcord-lite.md)
+ * [OLT Setup](profiles/olt-setup.md)
+ * [MCORD](profiles/mcord.md)
+ * [EnodeB Setup](profiles/enodeb-setup.md)
+ * [Helm Reference](charts/helm.md)
+ * [XOS-CORE](charts/xos-core.md)
+ * [ONOS](charts/onos.md)
+ * [VOLTHA](charts/voltha.md)
+ * [Fabric setup](prereqs/fabric-setup.md)
+
+* [Operating CORD](operating_cord/intro.md)
+ * Diagnostic
+
+* Developer Guide
+ * XOS Modeling
+ * GUI
+ * TOSCA
+ * ...
+ * Testing
diff --git a/book.json b/book.json
new file mode 100644
index 0000000..9737740
--- /dev/null
+++ b/book.json
@@ -0,0 +1,5 @@
+{
+ "plugins": [
+ "smart-nav-collapse"
+ ]
+}
\ No newline at end of file
diff --git a/charts/helm.md b/charts/helm.md
new file mode 100644
index 0000000..38d047f
--- /dev/null
+++ b/charts/helm.md
@@ -0,0 +1,15 @@
+# Helm
+
+## What is Helm?
+
+Briefly describe what helm is
+
+## How to get CORD Helm charts
+
+### Donwload the helm-charts repository
+
+### Add the CORD repository to helm
+
+```
+helm repo add ...
+```
\ No newline at end of file
diff --git a/charts/onos.md b/charts/onos.md
new file mode 100644
index 0000000..792d0d0
--- /dev/null
+++ b/charts/onos.md
@@ -0,0 +1,24 @@
+# ONOS Helm chart
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Esse illum explicabo, expedita, repudiandae numquam, ab fuga molestias minus maxime, deleniti perspiciatis id repellendus ipsa nemo velit quaerat omnis sequi saepe.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+## ONOS-Fabric
+
+`helm install ...`
+
+## ONOS-VOLHTA
+
+> NOTE that this require [VOLTHA](voltha.md) to be installed
+
+`helm install ...`
+
+## ONOS-VTN
+
+`helm install ...`
\ No newline at end of file
diff --git a/charts/voltha.md b/charts/voltha.md
new file mode 100644
index 0000000..0926e44
--- /dev/null
+++ b/charts/voltha.md
@@ -0,0 +1,7 @@
+# Deploying VOLTHA
+
+```
+helm repo add incubator https://kubernetes-charts-incubator.storage.googleapis.com/
+helm dep build
+helm install -n voltha voltha
+```
\ No newline at end of file
diff --git a/charts/xos-core.md b/charts/xos-core.md
new file mode 100644
index 0000000..a7e5259
--- /dev/null
+++ b/charts/xos-core.md
@@ -0,0 +1,6 @@
+# Deploying XOS-CORE
+
+```
+help repo add ...
+helm install -n xos-core xos-core
+```
\ No newline at end of file
diff --git a/operating_cord/intro.md b/operating_cord/intro.md
new file mode 100644
index 0000000..49966c6
--- /dev/null
+++ b/operating_cord/intro.md
@@ -0,0 +1 @@
+# Operating CORD
\ No newline at end of file
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..1431335
--- /dev/null
+++ b/package.json
@@ -0,0 +1,20 @@
+{
+ "name": "opencord-documentation",
+ "version": "1.0.0",
+ "description": "Documentation for the OpenCORD Project",
+ "main": "index.js",
+ "dependencies": {
+ "gitbook-plugin-smart-nav-collapse": "^0.1.0"
+ },
+ "devDependencies": {},
+ "scripts": {
+ "start": "gitbook serve --log=debug --debug",
+ "build": "gitbook build"
+ },
+ "repository": {
+ "type": "git",
+ "url": "https://gerrit.opencord.org/docs"
+ },
+ "author": "OpenCORD",
+ "license": "Apache-2.0"
+}
diff --git a/prereqs/docker-registry.md b/prereqs/docker-registry.md
new file mode 100644
index 0000000..4da006e
--- /dev/null
+++ b/prereqs/docker-registry.md
@@ -0,0 +1,3 @@
+# Docker Registry
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ea molestiae quisquam non praesentium fuga at quod pariatur quis, illo. Incidunt doloremque at provident accusamus totam sint quibusdam repudiandae veniam recusandae.
\ No newline at end of file
diff --git a/prereqs/fabric-setup.md b/prereqs/fabric-setup.md
new file mode 100644
index 0000000..85295d2
--- /dev/null
+++ b/prereqs/fabric-setup.md
@@ -0,0 +1 @@
+# How to install fabric switches
\ No newline at end of file
diff --git a/prereqs/hardware.md b/prereqs/hardware.md
new file mode 100644
index 0000000..844ba44
--- /dev/null
+++ b/prereqs/hardware.md
@@ -0,0 +1,9 @@
+# Hardware Requirements
+
+## BOM
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Sed vitae vel reiciendis, adipisci voluptatum perferendis voluptas blanditiis, eos inventore maiores ipsam facere aliquid ex repudiandae itaque praesentium mollitia at, architecto.
+
+## RCORD Specifics
+
+## MCORD Specifics
diff --git a/prereqs/helm.md b/prereqs/helm.md
new file mode 100644
index 0000000..9b2181d
--- /dev/null
+++ b/prereqs/helm.md
@@ -0,0 +1,3 @@
+# Helm Installation guide
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Nesciunt odit iste molestiae, necessitatibus saepe vel porro accusantium sit. Rem, voluptas accusantium quasi perspiciatis laborum cumque rerum deserunt itaque sapiente! Harum?
\ No newline at end of file
diff --git a/prereqs/kubespray.md b/prereqs/kubespray.md
new file mode 100644
index 0000000..34841f7
--- /dev/null
+++ b/prereqs/kubespray.md
@@ -0,0 +1,3 @@
+# Install Kubespray on a multiple nodes
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Impedit tempora veniam laborum deleniti aperiam similique voluptatum architecto, rerum. Quae neque, quaerat. Voluptate voluptates, sunt obcaecati perferendis minima itaque adipisci quisquam.
\ No newline at end of file
diff --git a/prereqs/minikube.md b/prereqs/minikube.md
new file mode 100644
index 0000000..d38b12b
--- /dev/null
+++ b/prereqs/minikube.md
@@ -0,0 +1,3 @@
+# Install Minikube on a single node
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Assumenda unde repudiandae quaerat doloribus dicta facilis, ipsam molestias, fugiat ducimus voluptatum, nostrum impedit iure enim minus vel consectetur labore modi, est.
\ No newline at end of file
diff --git a/prereqs/networking.md b/prereqs/networking.md
new file mode 100644
index 0000000..7062ed1
--- /dev/null
+++ b/prereqs/networking.md
@@ -0,0 +1,3 @@
+# How to cable a POD
+
+NOTE: how do we define this for a single/virtual setup? Do we need to do that now?
\ No newline at end of file
diff --git a/prereqs/openstack-helm.md b/prereqs/openstack-helm.md
new file mode 100644
index 0000000..ef94208
--- /dev/null
+++ b/prereqs/openstack-helm.md
@@ -0,0 +1,3 @@
+# OpenStack Helm Installation
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quasi corporis officia dolorum fugit eligendi obcaecati earum, quam reprehenderit optio consectetur quaerat voluptates asperiores aut vel laudantium soluta laboriosam iure culpa.
\ No newline at end of file
diff --git a/profiles/enodeb-setup.md b/profiles/enodeb-setup.md
new file mode 100644
index 0000000..3fe725d
--- /dev/null
+++ b/profiles/enodeb-setup.md
@@ -0,0 +1 @@
+# How to install a physical eNodeB
\ No newline at end of file
diff --git a/profiles/mcord.md b/profiles/mcord.md
new file mode 100644
index 0000000..b29a459
--- /dev/null
+++ b/profiles/mcord.md
@@ -0,0 +1,19 @@
+# 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/kubespray.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)
\ No newline at end of file
diff --git a/profiles/olt-setup.md b/profiles/olt-setup.md
new file mode 100644
index 0000000..a49475e
--- /dev/null
+++ b/profiles/olt-setup.md
@@ -0,0 +1 @@
+# How to install the OLT
\ No newline at end of file
diff --git a/profiles/rcord-lite.md b/profiles/rcord-lite.md
new file mode 100644
index 0000000..cde5a64
--- /dev/null
+++ b/profiles/rcord-lite.md
@@ -0,0 +1,55 @@
+# RCORD Lite
+
+## 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 can follow one of this guide to install a [single node cluster](../prereqs/minikube.md) or a [multi node cluster](../prereqs/kubespray.md))
+- Helm, follow [this guide](../prereqs/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-voltha](../charts/onos.md#onos-voltha)
+
+## Install the RCORD-Lite helm chart
+
+```
+helm install -n rcord-lite xos_profiles/rcord-lite
+```
+
+### How to customize the RCORD-Lite helm chart
+
+Define a `my-rcord-lite-values.yaml` that looks like:
+
+```yaml
+# in service charts
+addressmanager:
+ imagePullPolicy: 'Always'
+fabric:
+ imagePullPolicy: 'Always'
+onos-service:
+ imagePullPolicy: 'Always'
+volt:
+ imagePullPolicy: 'Always'
+vsg-hw:
+ imagePullPolicy: 'Always'
+kubernetes:
+ imagePullPolicy: 'Always'
+vrouter:
+ imagePullPolicy: 'Always'
+xos-gui:
+ imagePullPolicy: 'Always'
+simpleexampleservice:
+ imagePullPolicy: 'Always'
+```
+and use it during the installation with:
+
+```bash
+helm install -n rcord-lite xos_profiles/rcord-lite -f my-rcord-lite-values.yaml
+```
\ No newline at end of file