README-2.12.txt 7.67 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
===========================
ERP5 buildout for Zope 2.12
===========================

Introduction
============

ERP5 Buildout provides a way to build and manage ERP5 software components
with all needed dependencies.

ERP5 Buildout also provides a way to manage separate installation instances of
ERP5 to share non-data components of an ERP5 software installation from a
single location, allowing for easy component upgrade.

Software
========

Łukasz Nowak's avatar
Łukasz Nowak committed
18
Software part is system independent.
19

Łukasz Nowak's avatar
Łukasz Nowak committed
20
Requirements to build ERP5 Appliance 2.12 are:
21

Łukasz Nowak's avatar
Łukasz Nowak committed
22 23 24 25 26 27 28 29
 * C and C++ compiler
 * standard C and C++ library with development headers
 * make
 * patch
 * python (>=2.4) with development headers (to run buildout)
 * subversion client (XXX: It will be removed some day)

** WARNING ** DO __NOT__ use helpers, they are only for ERP5 Appliance 2.8 flavour. ** WARNING **
30 31 32 33 34 35 36 37 38 39

Setup
-----

Checkout: https://svn.erp5.org/repos/public/erp5/trunk/buildout/
For example:

  svn co https://svn.erp5.org/repos/public/erp5/trunk/buildout/ ~/erp5.buildout

  $ cd ~/erp5.buildout
40 41 42 43 44 45 46 47 48

Bootstrap buildout
~~~~~~~~~~~~~~~~~~

Download the newest bootstrap.py file from:
  http://svn.zope.org/*checkout*/zc.buildout/trunk/bootstrap/bootstrap.py

And run it:

49
  $ python -S bootstrap.py -c buildout-2.12.cfg
50

51 52 53
WARNING: please read "Troubleshooting" section bellow, you may need to
unset environment variables in your GNU/Linux distribution

54
  $ python -S -c 'import urllib2;print urllib2.urlopen("http://svn.zope.org/*checkout*/zc.buildout/trunk/bootstrap/bootstrap.py").read()' | python -S - -c buildout-2.12.cfg
55 56 57 58

Run the Zope 2.12 buildout
~~~~~~~~~~~~~~~~~~~~~~~~~~~

59
  $ bin/buildout -v -c buildout-2.12.cfg
60 61 62 63 64

This will download and install the software components needed to run ERP5 on
Zope 2.12 including Zope 2.12 plus dependencies (including
Acquisition with _aq_dynamic patch) and CMF 2.2 plus dependencies.

65 66 67
Note on -S: this switch is overridden by PYTHON_PATH environment variable. In
doubt, unset it before invoking that command.

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
Minimal requirements
--------------------

At the very least, running buildout requires:

 * Python 2.4 or later including development files (e.g. python2.4-devel or 
   python2.4-dev package from your system package manager. A file like
   /usr/lib*/python*/config/Makefile should be installed in the system.
   XXX Since we compile our own python, are development files still necessary?)
 * C development toolchain (Make, gcc, gpp, etc.) 
 * subversion (svn) client, to check-out this buildout.

Post-build check
----------------

83
Run:
84
  python tests/assertSoftware.py
85 86 87 88

Instances
=========

89 90
Note: Instance generation is still a work in progress. In particular, these
instructions should be much simplified.
91 92 93 94 95 96 97

After the software components are built, we can generate ERP5 instance
buildouts from that software.

Assuming the ERP5 software buildout is available in ~/erp5.buildout the
following sequence of steps should result in a working "instance" buildout:

98 99 100 101 102 103
$ mkdir ~/instances                         # 0
$ cd ~/instances                            # 1
$ ln -s ~/erp5.buildout/instance-profiles   # 2a
$ ln -s ~/erp5.buildout/profiles            # 2b
$ ln -s ~/erp5.buildout/software-profiles   # 2c
$ cat > buildout.cfg                        # 3
104 105 106

[buildout]
extends-cache = instance-profiles/extends-cache
107 108
# Default run buildout in offline mode.
offline = true
109 110 111 112 113 114 115 116 117 118
extends =
  profiles/development-2.12.cfg
  instance-profiles/software-home.inc

parts =
  mysql-instance
  oood-instance
  supervisor-instance
^D
$ ~/erp5.buildout/bin/bootstrap2.6      # 4
119
$ bin/buildout -v         # 5
120

121 122 123
The software-home configuration (along with the 'extends-cache' in the
'instance-profiles' symlink) provides all the information and components that
would otherwise have to be downloaded.
124 125 126 127 128 129

The steps above generate instance configurations for mysql and the
OpenOffice.org document conversion daemon. We need mysql, in particular,
to be running before configuring an actual ERP5 instance, so we'll start
supervisor:

130 131
$ bin/supervisord                   # 6

132 133 134 135
Now it is time to give supervisor few moments (about 10 seconds) to start all
required services. By running bin/supervisorctl status one can be informed if mysql
and oood are running.

136 137 138
Also, we need databases in the mysql server that correspond to both the ERP5
instance we're going to create, and the testrunner we will want to run:

139
$ var/bin/mysql -h 127.0.0.1 -u root
140 141 142
mysql> create database development_site;
mysql> grant all privileges on development_site.* to 'development_user'@'localhost' identified by 'development_password';
mysql> grant all privileges on development_site.* to 'development_user'@'127.0.0.1' identified by 'development_password';
143
mysql> create database test212;
144 145
mysql> grant all privileges on test212.* to 'test'@'localhost';
mysql> grant all privileges on test212.* to 'test'@'127.0.0.1';
Łukasz Nowak's avatar
Łukasz Nowak committed
146
mysql> exit
147 148 149 150 151

(there is automated support for creating databases but it's not currently
working with the Zope 2.12 buildout)

$ var/bin/
152 153 154 155 156 157 158 159 160

Now edit buildout.cfg and add "runUnitTest" (w/o quotes) to 'buildout:parts'.
The "development-instance" part will be pulled in automatically as a
dependency:

$ $EDITOR buildout.cfg                  # 7

Then run buildout again to finish the configuration

161
$ bin/buildout -ov         # 8
162 163 164 165 166 167 168 169

Now a fully configured development instance will be available in the directory
"var/development-instance", so you can do:

 $ var/development-site/bin/zopectl fg

And see an ERP5 instance running on "http://localhost:18080/". The port '18080'
refers to the 'development-instance:http-address' setting in
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
170 171 172
'profiles/development-2.12.cfg'. The file 'instance-profiles/zope-2.12.cfg'
provides the "Manager" credentials you should use (usually zope:zope), in
the 'zope-instance-template:user' variable.
173 174 175

You should also be able to run ERP5 unit tests like so:

176
 $ bin/runUnitTest testClassTool
177

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
Troubleshooting
===============

In various Linux distributions python is heavily patched and user related
environment variables are set system wide. This affects behaviour of python
and introduces various problem with running buildout.

In case of such issues consider resetting some python environment variables
before running buildout:

 * PYTHONPATH
 * PYTHONSTARTUP
 * PYTHONDONTWRITEBYTECODE

Example:

$ unset PYTHONPATH PYTHONSTARTUP PYTHONDONTWRITEBYTECODE
$ make
$ # other buildout related commands

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
TODO
====

 * Adjust the 'runUnitTest' recipe to push the mysql server coordinates into
   the 'bin/runUnitTest' script.

 * Refactor the .cfg files to reduce duplication and so that only the
   'instance-profiles' directory needs to be symlinked. Alternatively, push all
   .cfg files into a single 'profiles'
   directory.

 * Combine steps 2, 3 and 4 into a single step by creating a more powerful
   'bootstrap2.6' script.

 * Running 'buildout' twice in the instance (once to configure 'supervisor',
   'mysql' and 'oood' and once to setup the ZODB ERP5 instance) is confusing
   and error-prone. A buildout shouldn't deal with persistent state, only with
   file installation. Move the mysql database and ERP5 ZODB instance creation
   procedures to dedicated scripts in 'bin/' instead of implicitly running them
   in the (second) buildout run.

 * Patch the SOAPpy package provided by Nexedi so it doesn't fail with a
   SyntaxError on Python 2.6. Right now we're using a SOAPpy repackaging from
   http://ibid.omnia.za.net/eggs/ .

 * Synchronize the buildout behaviour for Zope 2.8 and 2.12 (i.e. allows Zope
   2.8 to work with a single buildout check-out).

 * See if we can use http://pypi.python.org/pypi/zc.sourcerelease/ to generate
   a single (humongous) tarball with all needed software components for fully
   offline operation.
Leonardo Rochael Almeida's avatar
Leonardo Rochael Almeida committed
229 230 231

 * Figure out why garbage is left on <software_home>/parts/unit_test after the
   test run. It can influence later test runs.