From 4dcd7f435ac3c6c0e59bb2cbcb05069e75ebf25d Mon Sep 17 00:00:00 2001
From: Adam Gandelman <adamg@ubuntu.com>
Date: Mon, 4 May 2015 13:06:00 -0700
Subject: [PATCH] Add developer quickstart devstack instructions

Adds some notes about getting started with Akanda using DevStack.

Change-Id: I8c6cc04e135857af5a2cef13549f859cc0538100
---
 doc/source/developer_quickstart.rst | 66 +++++++++++++++++++++++++++++
 doc/source/index.rst                |  1 +
 2 files changed, 67 insertions(+)
 create mode 100644 doc/source/developer_quickstart.rst

diff --git a/doc/source/developer_quickstart.rst b/doc/source/developer_quickstart.rst
new file mode 100644
index 0000000..f22d73e
--- /dev/null
+++ b/doc/source/developer_quickstart.rst
@@ -0,0 +1,66 @@
+.. _developer_quickstart:
+
+Akanda Developer Quickstart
+=====================================
+
+This guide provides guidance for new developers looking to get up and running
+with an Akanda development environment. The Akanda components may be easily
+deployed alongside OpenStack using DevStack. For more information about
+DevStack visit ``http://docs.openstack.org/developer/devstack/``.
+
+
+.. _developer_quickstart_rest:
+
+Deploying Akanda using DevStack
+-------------------------------
+
+Preparation and prerequisites
++++++++++++++++++++++++++++++
+
+Deploying DevStack on your local workstation is not recommended. Instead,
+developers should use a dedicated virtual machine.  Currently, Ubuntu
+Trusty 14.04 is the tested and supported base operating system. Additionally,
+you'll need to have ``git`` installed::
+
+    sudo apt-get -y install git
+
+
+First clone the DevStack repository::
+
+    sudo mkdir -p /opt/stack/
+    sudo chown `whoami` /opt/stack
+    git clone https://git.openstack.org/openstack-dev/devstack /opt/stack/devstack
+
+
+Configuring DevStack
+++++++++++++++++++++
+
+Next, you will need to enable the Akanda plugin in the DevStack configuration
+and enable the relevant services::
+
+    cat >/opt/stack/devstack/local.conf <<END
+    [[local|localrc]]
+    enable_plugin akanda-rug https://github.com/stackforge/akanda-rug
+    enable_service q-svc q-agt ak-rug
+    disable_service n-net
+
+    HOST_IP=127.0.0.1
+    LOGFILE=/opt/stack/devstack/devstack.log
+    DATABASE_PASSWORD=secret
+    RABBIT_PASSWORD=secret
+    SERVICE_TOKEN=secret
+    SERVICE_PASSWORD=secret
+    ADMIN_PASSWORD=secret
+    END
+
+Deploying
++++++++++
+
+Simply run DevStack and allow time for the deployment to complete::
+
+    cd /opt/stack/devstack
+    ./stack.sh
+
+After it has completed, you should have a ``akanda-rug`` process running
+alongside the other services and an Akanda router appliance booted as a Nova
+instance.
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 104fd68..a58faec 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -26,6 +26,7 @@ Narrative Documentation
    appliance.rst
    contribute.rst
    operation.rst
+   developer_quickstart.rst
    reference.rst
 
 Licensing