openstack/astara
Code Issues Proposed changes

Updates with name changes to the developer quickstart documentation.

Browse Source 
Change-Id: I6c8e2c84e8d649d4a54aa84f8fd85d9775e70f7b
Implements: blueprint astara-doc-updates-mitaka
This commit is contained in:
David Lenwell 2015-11-24 02:02:49 -08:00
parent f7f5eb6067
commit 102a564c96
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/source/developer_quickstart.rst
View File

@ -1,17 +1,17 @@
.. _developer_quickstart:
Akanda Developer Quickstart
=====================================
Astara 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
with an Astara development environment. The Astara 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
Deploying Astara using DevStack
-------------------------------
Preparation and prerequisites
@ -20,7 +20,7 @@ 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 at least 4GB of RAM and to have ``git`` installed::
you'll need at least 4GB of RAM (8 is better) and to have ``git`` installed::
sudo apt-get -y install git
@ -35,17 +35,17 @@ First clone the DevStack repository::
Configuring DevStack
++++++++++++++++++++
Next, you will need to enable the Akanda plugin in the DevStack configuration
Next, you will need to enable the Astara 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
enable_plugin astara https://github.com/openstack/astara
enable_service q-svc q-agt astara
disable_service n-net
HOST_IP=127.0.0.1
LOGFILE=/opt/stack/devstack/devstack.log
LOGFILE=/opt/stack/logs/devstack.log
DATABASE_PASSWORD=secret
RABBIT_PASSWORD=secret
SERVICE_TOKEN=secret
@ -53,29 +53,29 @@ and enable the relevant services::
ADMIN_PASSWORD=secret
END
You may wish to SSH into the appliance VMs for debugging purposes. The RUG will
enable access for the 'akanda' user for a specified public key. This may be
specified by setting AKANDA_APPLIANCE_SSH_PUBLIC_KEY variable in your devstack
config to point to an existing public key. The default is
You may wish to SSH into the appliance VMs for debugging purposes. The
orchestrator will enable access for the 'astara' user for a specified public
key. This may be specified by setting ASTARA_APPLIANCE_SSH_PUBLIC_KEY variable
in your devstack config to point to an existing public key. The default is
$HOME/.ssh/id_rsa.pub.
Building a Custom Service VM
++++++++++++++++++++++++++++
By default, the Akanda plugin downloads a pre-built official Akanda image. To
build your own from source, enable ``BUILD_AKANDA_APPLIANCE_IMAGE`` and specify
By default, the Astara plugin downloads a pre-built official Astara image. To
build your own from source, enable ``BUILD_ASTARA_APPLIANCE_IMAGE`` and specify
a repository and branch to build from::
cat >>/opt/stack/devstack/local.conf <<END
BUILD_AKANDA_APPLIANCE_IMAGE=True
AKANDA_APPLIANCE_REPO=http://github.com/stackforge/akanda-appliance.git
AKANDA_APPLIANCE_BRANCH=master
BUILD_ASTARA_APPLIANCE_IMAGE=True
ASTARA_APPLIANCE_REPO=http://github.com/openstack/astara-appliance.git
ASTARA_APPLIANCE_BRANCH=master
END
To build the appliance using locally modified ``akanda-appliance`` code, you
To build the appliance using locally modified ``astara-appliance`` code, you
may point devstack at the local git checkout by setting the
AKANDA_APPLIANCE_DIR variable. Ensure that any changes you want included in
ASTARA_APPLIANCE_DIR variable. Ensure that any changes you want included in
the image build have been committed to the repository and it is checked out
to the proper commit.
@ -87,6 +87,6 @@ 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
After it has completed, you should have a ``astara_orchestrator`` process running
alongside the other services and an Astara router appliance booted as a Nova
instance.