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 <