openstack/designate
Code Issues Proposed changes

DOC: Update Ubuntu developer environment doc

Browse Source 
The current developer documentation will result in build failures on
Ubuntu. The version of pip packaged for Ubuntu 14.04 can not parse the
project's current requirements.txt files and a couple of dependencies
are missing. This patch aims to add instructions to:

* Add the libssl-dev and libffi-dev dependencies
* Install an updated version of pip
* Remove the deprecated '--no-site-packages' parameter from virtualenv

Change-Id: I6944e5baff67b6e0f0464d7b18d12322968bb2a3
This commit is contained in:
Mike Carden 2016-05-26 12:42:25 +10:00 committed by Michael Carden
parent 9c4edeec1e
commit dfca6591b6
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/install/ubuntu-dev.rst
View File

@ -49,7 +49,7 @@ Installing Designate
::
$ sudo apt-get update
$ sudo apt-get install python-pip python-virtualenv git
$ sudo apt-get install python-pip python-virtualenv libssl-dev libffi-dev git
$ sudo apt-get build-dep python-lxml
2. Clone the Designate repo from GitHub
@ -65,17 +65,24 @@ Installing Designate
3. Setup a virtualenv
.. note::
This is an optional step, but will allow Designate's dependencies
to be installed in a contained environment that can be easily deleted
if you choose to start over or uninstall Designate.
This step is necessary to allow the installation of an up-to-date
pip, independent of the version packaged for Ubuntu. it is
also useful in isolating the remainder of Designate's dependencies
from the rest of the system.
::
$ virtualenv --no-site-packages .venv
$ virtualenv .venv
$ . .venv/bin/activate
4. Install an up-to-date pip
4. Install Designate and its dependencies
::
$ pip install -U pip
5. Install Designate and its dependencies
.. note::
If you run into the error: Installed distribution pbr 1.1.1 conflicts with requirement pbr>=0.6,!=0.7,<1.0, try doing pip install pbr==0.11.0
@ -86,7 +93,7 @@ Installing Designate
$ python setup.py develop
5. Change directories to the etc/designate folder.
6. Change directories to the etc/designate folder.
.. note::
Everything from here on out should take place in or below your designate/etc folder
@ -96,21 +103,21 @@ Installing Designate
$ cd etc/designate
6. Create Designate's config files by copying the sample config files
7. Create Designate's config files by copying the sample config files
::
$ cp -a rootwrap.conf.sample rootwrap.conf
7. Make the directory for Designate’s log files
8. Make the directory for Designate’s log files
::
$ mkdir -p ../../log
8. Make the directory for Designate’s state files
9. Make the directory for Designate’s state files
::