opendev/storyboard
Code Issues Proposed changes

Updated documentation for installing Storyboard

Browse Source 
Updated 'Installing and Running for Developers' documentation.

Change-Id: I9d4059f342e3d29ffa6f87c289048888a432ff00
This commit is contained in:
Elizabeth Elwell 2016-02-29 18:27:35 +00:00
parent 2a8ba8c18c
commit d0d370f54a
1 changed files with 73 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
doc/source/install/development.rst
View File

@ -5,62 +5,31 @@
Storyboard has two components: this API server, and the
Javascript-based web client.
Launching the development VM
============================
StoryBoard has certain server dependencies which are often complicated to
install on any development environment. To simplify this,
we've provided a vagrantfile which includes all required services.
1. Install [vagrant](https://www.vagrantup.com/)
2. Install [VirtualBox](https://www.virtualbox.org/)
3. Run `vagrant up` in the storyboard root directory.
If you choose to go this route, the appropriate configuration values in
`storyboard.conf` will be as follows::
...
[notifications]
rabbit_host=127.0.0.1
rabbit_login_method = AMQPLAIN
rabbit_userid = storyboard
rabbit_password = storyboard
rabbit_port = 5672
rabbit_virtual_host = /
...
[database]
connection = mysql+pymysql://storyboard:storyboard@127.0.0.1:3306/storyboard
...
Note that the VM will attempt to bind to local ports 3306, 5672,
and 15672. If those ports are already in use, you will have to modify the
vagrant file and your configuration to accommodate.
This VM has also been set up for unit tests.
Installing and Upgrading the API server
=======================================
1. To start the API server, make sure you have the following packages installed
1. To start the API server, make sure you have the following packages installed
locally:
* libpq-dev
* libmysqlclient-dev
* python-dev
NOTE: MySQL must be >= 5.6
NOTE: MySQL must be >= 5.6
sudo apt-get update
sudo apt-get install libpq-dev libmysqlclient-dev python-dev
mysql --version
2. Clone storyboard::
2. Clone the storyboard repository::
git clone https://git.openstack.org/openstack-infra/storyboard
cd storyboard
3. Add MySQL user and create database (not necessary if using VM)::
3. Add MySQL user and create database::
mysql -u $DB_USER -p$DB_PASSWORD -e 'DROP DATABASE IF EXISTS storyboard;'
mysql -u $DB_USER -p$DB_PASSWORD -e 'CREATE DATABASE storyboard;'
@ -71,8 +40,10 @@ NOTE: MySQL must be >= 5.6
cp ./etc/storyboard.conf.sample ./etc/storyboard.conf
5. Edit ``./etc/storyboard.conf`` and set the ``connection`` parameter in
the ``[database]`` section.
5. Edit ``./etc/storyboard.conf`` and set the ``connection`` parameter in
the ``[database]`` section as per instructions in comments above that
parameter in the storyboard.conf file.
6. Install the correct version of tox. Latest tox has a bug. https://bugs.launchpad.net/openstack-ci/+bug/1274135::
@ -133,6 +104,66 @@ Installing the Javascript-based web client
tox -egrunt_no_api -- serve:prod
Make user an admin - current bug
================================
Once logged into the webclient, this user needs to be set to admin
manually due to a current bug in Storyboard.
1. Ensure that you have logged into your Storyboard instance at least once so that your
user details are stored in the database.
2. Run mysql and change your user to superadmin:
mysql -u root -p
mysql> use storyboard;
update users set is_superuser=1;
Optional steps: Launching the development VM with Vagrant
=========================================================
StoryBoard has certain server dependencies which are often complicated to
install on any development environment. To simplify this,
we've provided a vagrantfile which includes all required services.
The vagrant machine will handle mysql and rabbitmq (and set them up automatically)
however be aware that it is not set up for actually running the api in the vagrant vm.
Using the vagrant machine is useful because you can run the test suite against the
database it provides.
1. Install [vagrant](https://www.vagrantup.com/)
2. Install [VirtualBox](https://www.virtualbox.org/)
3. Run `vagrant up` in the storyboard root directory.
If you choose to go this route, the appropriate configuration values in
`storyboard.conf` will be as follows::
...
[notifications]
rabbit_host=127.0.0.1
rabbit_login_method = AMQPLAIN
rabbit_userid = storyboard
rabbit_password = storyboard
rabbit_port = 5672
rabbit_virtual_host = /
...
[database]
connection = mysql+pymysql://storyboard:storyboard@127.0.0.1:3306/storyboard
...
Note that the VM will attempt to bind to local ports 3306, 5672,
and 15672. If those ports are already in use, you will have to modify the
vagrant file and your configuration to accommodate.
This VM has also been set up for unit tests.
Optional steps: Seed database with base data
============================================