root / docs / intgrt-guide.rst @ d194e869
History | View | Annotate | Download (2.4 kB)
1 |
.. _intgrt-guide: |
---|---|
2 |
|
3 |
Synnefo Integrator's Guide |
4 |
^^^^^^^^^^^^^^^^^^^^^^^^^^ |
5 |
|
6 |
This is the complete Synnefo Integrator's Guide |
7 |
|
8 |
Developer's quick start |
9 |
======================= |
10 |
|
11 |
This section describes how to setup quickly a synnefo development environment. |
12 |
The setup uses ``pip`` and ``virtualenv`` and we assume you do it on a working |
13 |
debian system. The purpose of this section is to provide the synnefo developer |
14 |
with a quick installation, so that he can have all the synnefo components |
15 |
up and running to start developing. |
16 |
|
17 |
| :ref:`Integrator's quick installation guide <quick-install-intgrt-guide>` |
18 |
| This guide will walk you through a complete installation using ``pip``. |
19 |
|
20 |
|
21 |
Synnefo internals |
22 |
================= |
23 |
|
24 |
snf-vncauthproxy |
25 |
---------------- |
26 |
|
27 |
To support OOB console access to the VMs over VNC, the vncauthproxy |
28 |
daemon must be running on every :ref:`APISERVER <APISERVER_NODE>` node. |
29 |
|
30 |
.. note:: The Debian package for vncauthproxy undertakes all configuration |
31 |
automatically. |
32 |
|
33 |
Download and install the latest vncauthproxy from its own repository, |
34 |
at `https://code.grnet.gr/git/vncauthproxy`, or a specific commit: |
35 |
|
36 |
.. code-block:: console |
37 |
|
38 |
$ bin/pip install -e git+https://code.grnet.gr/git/vncauthproxy@INSERT_COMMIT_HERE#egg=vncauthproxy |
39 |
|
40 |
Create ``/var/log/vncauthproxy`` and set its permissions appropriately. |
41 |
|
42 |
Alternatively, build and install Debian packages. |
43 |
|
44 |
.. code-block:: console |
45 |
|
46 |
$ git checkout debian |
47 |
$ dpkg-buildpackage -b -uc -us |
48 |
# dpkg -i ../vncauthproxy_1.0-1_all.deb |
49 |
|
50 |
.. warning:: |
51 |
**Failure to build the package on the Mac.** |
52 |
|
53 |
``libevent``, a requirement for gevent which in turn is a requirement for |
54 |
vncauthproxy is not included in `MacOSX` by default and installing it with |
55 |
MacPorts does not lead to a version that can be found by the gevent |
56 |
build process. A quick workaround is to execute the following commands:: |
57 |
|
58 |
$ cd $SYNNEFO |
59 |
$ sudo pip install -e git+https://code.grnet.gr/git/vncauthproxy@5a196d8481e171a#egg=vncauthproxy |
60 |
<the above fails> |
61 |
$ cd build/gevent |
62 |
$ sudo python setup.py -I/opt/local/include -L/opt/local/lib build |
63 |
$ cd $SYNNEFO |
64 |
$ sudo pip install -e git+https://code.grnet.gr/git/vncauthproxy@5a196d8481e171a#egg=vncauthproxy |
65 |
|
66 |
.. todo:: Mention vncauthproxy bug, snf-vncauthproxy, inability to install using pip |
67 |
.. todo:: kpap: fix installation commands |
68 |
|
69 |
|
70 |
Components |
71 |
========== |
72 |
|