New quickstart guide
Change-Id: Idaa9392a0ab82bcee4815f9a47705d494a4f6cd0
diff --git a/README.md b/README.md
index 86214fa..89d8d76 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,16 @@
# Installation Guide
-This guide describes how to install CORD on a physical POD. It identifies a set of
-[prerequisites](prereqs/README.md), and then walks through
-the steps involved in bringing up the [Platform](platform.md). Once
-the Platform is installed, you are ready to bring up one of the
-available Profiles:
+This guide describes how to install CORD on a physical POD. It identifies a set of [prerequisites](prereqs/README.md), and then walks through the steps involved in bringing up the [Platform](platform.md). Once the Platform is installed, you are ready to bring up one of the available Profiles:
* [SEBA](./profiles/seba/install.md)
* [M-CORD](./profiles/mcord/install.md)
-This installation procedure requires management-network connectivity to the Internet.
-If your installation does not have such connectivity, or you are behind a restrictive
-firewall, consider [Offline Install](./offline-install.md).
+Alternatively if you just want to quickly bring up SEBA, try the [SEBA Quick Start](./seba_quickstart.md).
-If you do not have the [prerequisite hardware](./prereqs/hardware.md) needed for a POD,
-consider running a complete system entirely emulated in software using
-[SEBA-in-a-Box](./profiles/seba/siab-overview.md).
+This installation procedure requires management-network connectivity to the Internet. If your installation does not have such connectivity, or you are behind a restrictive firewall, consider [Offline Install](./offline-install.md).
-If you prefer a gentle walk through of process bringing up a subset
-of the CORD platform running on your lapto (e.g., to get an
-introduction to all the moving parts in CORD) then jumping to the
-[Quick Start](quickstart.md) page is also an option.
+If you do not have the [prerequisite hardware](./prereqs/hardware.md) needed for a POD, consider running a complete system entirely emulated in software using [SEBA-in-a-Box](./profiles/seba/siab-overview.md).
-Finally, if you want to get a broader lay-of-the-land, you
-might step back and read the [Overview](overview.md).
+If you prefer a gentle walkthrough of the process of bringing up a subset of the CORD platform running on your laptop (e.g., to get an introduction to all the moving parts in CORD) then jumping to the [ExampleService Quick Start](example_service_quickstart.md) page is also an option.
+
+Finally, if you want to get a broader lay-of-the-land, you might step back and read the [Overview](overview.md).
diff --git a/SUMMARY.md b/SUMMARY.md
index 53c4b1c..49138f7 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -3,8 +3,10 @@
* [Overview](overview.md)
* [Navigating CORD](navigate.md)
* [Quick Start](quickstart.md)
- * [MacOS](macos.md)
- * [Linux](linux.md)
+ * [SEBA Quick Start] (seba_quickstart.md)
+ * [ExampleService Quick Start] (example_service_quickstart.md)
+ * [MacOS](macos.md)
+ * [Linux](linux.md)
## Guides
diff --git a/example_service_quickstart.md b/example_service_quickstart.md
new file mode 100644
index 0000000..51f6376
--- /dev/null
+++ b/example_service_quickstart.md
@@ -0,0 +1,8 @@
+# ExampleService Quick Start
+
+This section walks you through an example installation sequence on two different Unix-based platforms. This is just a surface introduction to CORD. If you prefer to understand the installation process in more depth, including the full range of deployment options, you should start with the [Installation Guide](README.md) instead.
+
+This Quick Start describes how to install a subset of the CORD platform, plus a `SimpleExampleService`, on a single machine. Once you complete these steps, you might be interested in jumping ahead to the [SimpleExampleService Tutorial](simpleexampleservice/simple-example-service.md) to learn more about the make-up of a CORD service. Another option would be to explore CORD's [operational interfaces](operating_cord/general.md).
+
+* [MacOS](macos.md)
+* [Linux](linux.md)
diff --git a/quickstart.md b/quickstart.md
index 382d310..61d2b07 100644
--- a/quickstart.md
+++ b/quickstart.md
@@ -1,22 +1,9 @@
# Quick Start
-This section walks you through an example installation sequence on two
-different Unix-based platforms. This is just a surface introduction to
-CORD. If you prefer to understand the installation process in more
-depth, including the full range of deployment options, you should
-start with the [Installation Guide](README.md) instead.
+If you prefer to understand the installation process in more depth, including the full range of deployment options, you should start with the [Installation Guide](README.md) instead.
-This Quick Start describes how to install a subset of the CORD
-platform, plus a `SimpleExampleService`, on a single machine. Once you
-complete these steps, you might be interested in jumping ahead to the
-[SimpleExampleService Tutorial](simpleexampleservice/simple-example-service.md)
-to learn more about the make-up of a CORD service. Another option
-would be to explore CORD's [operational interfaces](operating_cord/general.md).
+There are two Quick Starts available.
-* [MacOS](macos.md)
-* [Linux](linux.md)
+* If you've met the hardware prerequisites and quickly want to get SEBA installed, use the [SEBA Quick Start](./seba_quickstart.md). If you don't have the hardware, try [SEBA-in-a-Box](./profiles/seba/siab-overview.md).
-If you want to quickly get started with a complete CORD system
-running on your laptop—including the CORD platform, the SEBA profile,
-an exemplar operator workflow, and an emulated data-plane—you could
-give [SEBA-in-a-Box](./profiles/seba/siab-overview.md) a try.
+* The other quick start helps you quickly understand the internal workings of the CORD platform - for example, how xproto, TOSCA and Helm all interact for a [simple example service](./example_service_quickstart.md).
diff --git a/seba_quickstart.md b/seba_quickstart.md
new file mode 100644
index 0000000..34d1a4f
--- /dev/null
+++ b/seba_quickstart.md
@@ -0,0 +1,82 @@
+# SEBA Quick Start
+
+This section provides instructions to quickly bring up SEBA.
+
+>**Note:** This Quick start assumes that [prerequisite](prereqs/README.md) hardware and software (up to Kubernetes and Helm) have already been installed.
+
+## Install components as a whole
+
+```shell
+# Add the CORD repository and update indexes
+helm repo add cord https://charts.opencord.org
+helm repo update
+
+# Install the CORD platform
+helm install -n cord-platform --version 6.1.0 cord/cord-platform
+
+# Wait until 3 etcd CRDs are present in Kubernetes
+kubectl get crd | grep -i etcd | wc -l
+
+# Install the SEBA profile
+helm install -n seba --version 1.0.0 cord/seba
+
+# Install the AT&T workflow
+helm install -n att-workflow --version 1.0.0 cord/att-workflow
+```
+
+## Alternatively, install as separate components
+
+```shell
+# Add the official Kubernetes incubator repostiory (for Kafka) and update the indexes
+helm repo add incubator http://storage.googleapis.com/kubernetes-charts-incubator
+helm repo update
+
+# Add the CORD repository and update the indexes
+helm repo add cord https://charts.opencord.org
+helm repo update
+
+# Install the CORD platform components
+helm install -n onos cord/onos
+helm install -n xos-core cord/xos-core
+helm install --version 0.8.8 \
+ --set configurationOverrides."offsets.topic.replication.factor"=1 \
+ --set configurationOverrides."log.retention.hours"=4 \
+ --set configurationOverrides."log.message.timestamp.type"="LogAppendTime" \
+ --set replicas=1 \
+ --set persistence.enabled=false \
+ --set zookeeper.replicaCount=1 \
+ --set zookeeper.persistence.enabled=false \
+ -n cord-kafka incubator/kafka
+
+# Optionally, install the logging and monitoring infrastructure components
+helm install -n nem-monitoring cord/nem-monitoring
+helm install --set elasticsearch.cluster.env.MINIMUM_MASTER_NODES="1" \
+ --set elasticsearch.client.replicas=1 \
+ --set elasticsearch.master.replicas=2 \
+ --set elasticsearch.master.persistence.enabled=false \
+ --set elasticsearch.data.replicas=1 \
+ --set elasticsearch.data.persistence.enabled=false \
+ -n logging cord/logging
+
+# Install etcd-operator and wait until 3 etcd CRDs are present in Kubernetes
+helm install -n etcd-operator stable/etcd-operator --version 0.8.0
+kubectl get crd | grep -i etcd | wc -l
+
+# Install the rest of the SEBA profile components
+helm install -n voltha cord/voltha
+helm install -n seba-service cord/seba-services
+helm install -n base-kubernetes cord/base-kubernetes
+
+# Install the AT&T workflow
+helm install -n att-workflow --version 1.0.0 cord/att-workflow
+```
+
+## Verify your installation and next steps
+
+Once the installation completes, monitor your setup using `kubectl get pods`.
+Wait until all pods are in *Running* state and “tosca-loader” pods are in *Completed* state.
+
+>**Note:** The tosca-loader pods may periodically transition into *error* state. This is expected. They will retry and eventually get to the desired state.
+>**Note:** Depending on the profile you're installing, you may need to check also different namespaces (for example, check the voltha namespace if you're installing SEBA with `kubectl get pods -n voltha`)
+
+Your POD is now installed and ready for use. To learn how to operate your POD continue to the [SEBA configuration section](../configuration.md).