Commit 007365ed authored by Giorgos Korfiatis's avatar Giorgos Korfiatis
Browse files

docs: Improve development environment setup

Do not let `setup.py develop' automatically resolve dependencies,
because it fails to pick the right version when multiple versions
are available. Non-synnefo dependencies are expected to have been
previously installed by `snf-deploy'.

Also, restart server and daemons, when needed.
parent c659aa0e
......@@ -10,7 +10,11 @@ Environment set up
First of all you have to set up a developing environment for Synnefo.
**1. Create a new Squeeze VM**
**1. Create a new VM**
It has been tested on Debian Wheezy. It is expected to work with other
releases (e.g., Squeeze) too, as long as they are supported by
``snf-deploy``.
**2. Build your own Synnefo installation**
......@@ -44,10 +48,11 @@ And now get the Synnefo code from the official Synnefo repository
.. code-block:: console
# su some_regular_user
$ git clone https://code.grnet.gr/git/synnefo
Make sure you did the previous as a regular user. Otherwise you will have problems
with file permissions when deploying.
Make sure you clone the repository as a regular user. Otherwise you will
have problems with file permissions when deploying.
**6. Code and deploy**
......@@ -58,13 +63,42 @@ with file permissions when deploying.
$ devflow-update-version
2. Code
3. In every component you change run
3. In every component you change, run as root
.. code-block:: console
# python setup.py develop -N
This does not automatically install dependencies, in order to avoid
confusion with synnefo packages installed by ``snf-deploy``. External
dependencies have already been installed by ``snf-deploy``; if you introduce
a new dependency, you will have to explicitly install it.
4. You will need to restart the server with
.. code-block:: console
# service gunicorn restart
5. If your changes affected ``snf-dispatcher`` (from package
``snf-cyclades-app``) or ``snf-ganeti-eventd`` (from
``snf-cyclades-gtools``) you will need to restart these daemons, too.
Since step 3 installed the former under ``/usr/local/``, you need to
make sure that the correct version is evoked. You can override the
version installed by ``snf-deploy`` with
.. code-block:: console
# ln -sf /usr/local/bin/snf-dispatcher /usr/bin/snf-dispatcher
and then restart the daemons
.. code-block:: console
# python setup.py develop
# service snf-dispatcher restart
# service snf-ganeti-eventd restart
4. Refresh the web page and see your changes
6. Refresh the web page and see your changes
Synnefo REST APIs
=================
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment