We're using Sahara-specific configs and there are some other potential inconsistencies. * use common OpenStack [keystone_authtoken] section for middleware configurations; * token validator reworked to be consistent with update auth_token middleware usage; * auth_uri is now stored in context for consistency, additonally, it * provides correct auth_uri in multi process sahara deployment. Closes-Bug: #1257472 Closes-Bug: #1249063 Change-Id: I5a33ae6269d40dadcd4893b27a937a37e0c74006
3.4 KiB
Setting Up a Development Environment
This page describes how to setup a Sahara development environment by either installing it as a part of DevStack or pointing a local running instance at an external OpenStack. You should be able to debug and test your changes without having to deploy Sahara.
Setup a Local Environment with Sahara inside DevStack
See the main article.
Setup a Local Environment with an external OpenStack
- Install prerequisites
On OS X Systems:
# we actually need pip, which is part of python package
$ brew install python mysql postgresql
$ pip install virtualenv tox
On Ubuntu:
$ sudo apt-get update
$ sudo apt-get install git-core python-dev python-virtualenv gcc libpq-dev libmysqlclient-dev python-pip
$ sudo pip install tox
On Fedora-based distributions (e.g., Fedora/RHEL/CentOS/Scientific Linux):
$ sudo yum install git-core python-devel python-virtualenv gcc python-pip mariadb-devel postgresql-devel
$ sudo pip install tox
- Grab the code from GitHub:
$ git clone git://github.com/openstack/sahara.git
$ cd sahara
- Prepare virtual environment:
$ tools/install_venv
- Create config file from default template:
$ cp ./etc/sahara/sahara.conf.sample-basic ./etc/sahara/sahara.conf
5. Look through the sahara.conf and change parameters which default
values do not suite you. Set [keystone_authtoken]/auth_uri
and [keystone_authtoken]/identity_uri
to complete public
Identity API endpoint (like http://127.0.0.1:5000/v2.0/
)
and to unversioned complete admin Identity API endpoint (like
https://localhost:35357/
) correspondingly.
If you are using Neutron instead of Nova Network add
use_neutron = True
to config. If the linux kernel you're
utilizing support network namespaces then also specify
use_namespaces = True
.
Note
Config file can be specified for sahara-api
command
using --config-file
flag.
- Create database schema:
$ tox -evenv -- sahara-db-manage --config-file etc/sahara/sahara.conf upgrade head
- To start Sahara call:
$ tox -evenv -- sahara-api --config-file etc/sahara/sahara.conf -d
Setup local OpenStack dashboard with Sahara plugin
../horizon/dev.environment.guide
Tips and tricks for dev environment
- Pip speedup
Add the following lines to ~/.pip/pip.conf
[global]
download-cache = /home/<username>/.pip/cache
index-url = <mirror url>
Note! The ~/.pip/cache
folder should be created.
- Git hook for fast checks
Just add the following lines to .git/hooks/pre-commit and do chmod +x for it.
#!/bin/sh
# Run fast checks (PEP8 style check and PyFlakes fast static analysis)
tools/run_fast_checks
You can added the same check for pre-push, for example, run_tests and run_pylint.
- Running static analysis (PyLint)
Just run the following command
tools/run_pylint