Contributing¶

Setting up a development environment in an OpenStack VM using cloud-init¶

The following cloud-config script can be passed as a –user-data argument to nova boot. This will result in a fully operational DLRN environment to hack on.

Setting up a development environment manually¶

Installing prerequisites:

$ sudo yum install mock rpm-build git createrepo python-virtualenv git-hg python-pip
$ sudo systemctl start httpd

Add the user you intend to run as to the mock group:

$ sudo usermod -a -G mock $USER

Checkout the Source code and install a virtualenv:

$ git clone https://github.com/openstack-packages/DLRN.git
$ cd DLRN
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
$ pip install -r test-requirements.txt
$ python setup.py develop

Submitting pull requests¶

Pull requests submitted through GitHub will be ignored. They should be sent to GerritHub instead, using git-review. Once submitted, they will show up here:

https://review.gerrithub.io/#/q/status:open+and+project:openstack-packages/delorean

Generating the documentation¶

Please note that the RDO Packaging Documentation also contains instructions for DLRN.

The documentation is generated with Sphinx. To generate the documentation, go to the documentation directory and run the make file:

$ cd DLRN/doc/source
$ make html

The output will be in DLRN/doc/build/html