Add developer quickstart devstack instructions
Adds some notes about getting started with Akanda using DevStack. Change-Id: I8c6cc04e135857af5a2cef13549f859cc0538100
This commit is contained in:
parent
09d0ae25af
commit
4dcd7f435a
66
doc/source/developer_quickstart.rst
Normal file
66
doc/source/developer_quickstart.rst
Normal file
@ -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.
|
@ -26,6 +26,7 @@ Narrative Documentation
|
||||
appliance.rst
|
||||
contribute.rst
|
||||
operation.rst
|
||||
developer_quickstart.rst
|
||||
reference.rst
|
||||
|
||||
Licensing
|
||||
|
Loading…
x
Reference in New Issue
Block a user