[DOC] Updated abstract list screenshoot
[cds-indico.git] / doc / toWiki / MAINTENANCE_CERN
blob7a2d170c27f52cf623bdbbe10d603d07018c8c72
1 Indico at CERN maintenance guide
2 ================================
4 0. Purpose of this document
6 This document aims at describing the details of the Indico installation at CERN.
7 You won't find any information about how to install the system or any 
8 explanation of the different parts of it, you'll only find the details about the
9 concrete configuration at CERN and some instructions for keeping up running.
12 1. Overview of the Indico system at CERN
14 Nowadays, there is one machine which is dedicated for production at CERN: 
15 "pcdh94.cern.ch" which is aliased as "indico.cern.ch". This machine contains
16 the whole system including the DB and App servers. Please find in the following
17 sections details about each component of the system and its concrete 
18 configuration.
21 2. DB server 
23 As it has been said the DB server is installed and running on the machine 
24 "indico.cern.ch". 
25 At CERN, ZEO is begin used in order to communicate with ZODB 
26 so a ZEO server must be running all the time. The configuration of the ZEO 
27 sever is kept in a separated config file which is in /data04/zeo/etc/zeo.cfg.
28 Some details about the ZEO configuration:
29     * connection: using TCP socket at address "cdsdoc.cern.ch" port "9675"
30     * db storage: using FileStorage at "/data04/zodb-data/makac/data.fs"
31     * log file: at "/data04/zeo/log/zeo.log"
33 In order to start/stop the ZEO server and ensure it is always running, Zope 
34 zdaemon is used. The configuration of the zdctl is kept in a separted 
35 configuration file at "/data04/zeo/etc/zdctl.cfg". This file contains the
36 details about how to launch the ZEO server. With the current configuration
37 zdctl will launch the ZEO server using zdrun which makes sure that the server is
38 always running and if it dies it restarts it automatically. 
39 In order to control ZEO server zdctl must always be used; here there are some 
40 commands:
42     * Start DB server: /soft/bin/python2.3 /soft/python/lib/python2.3/site-packages/zdaemon/zdctl.py -C /data04/zeo/etc/zdctl.cfg start
43     * Stop DB server: /soft/bin/python2.3 /soft/python/lib/python2.3/site-packages/zdaemon/zdctl.py -C /data04/zeo/etc/zdctl.cfg stop
45 However, a special script exists for making things easier: 
46     
47     * Start DB server: /soft/bin/indico_ctl start
48     * Stop DB server: /soft/bin/indico_ctl stop
50 Right now the DB server is running under user "hsanchez" so if you are not 
51 logged as "hsanchez" you need to execute it with root privileges.
54 3. Archive repository
56 The archive repository is also on the "indico.cern.ch" machine. The archive 
57 repository is under "/data04/MaKaC/archive". This file space must be owned and 
58 writable for www-data group.
61 4. Application server
63 4.1. Indico package
65 The Indico package is installed in the standard python "site-packages" library:
66 "/soft/python/lib/python2.3/site-packages/MaKaC". Which means that the Indico
67 configuration file is in "/soft/python/lib/python2.3/site-packages/MaKaC/common/MaKaCConfig.py". Any change in the configuration requires a restarting of the 
68 HTTP server (see section 4.2).
69 Only root has the right for modifying/updating MaKaC and any update of the 
70 Indico package should be done only with FULLY TESTED releases. No modification 
71 of the code should be done in the production machine directly; instead, the CVS
72 code should be modified and tested in a developement machine; then a new release
73 should be done generating a source distribution for it which can be installed
74 on the production machine (detailed instructions about how to upgrade the 
75 production machine installation can be found at [1]).
77 4.2. Web interface
79 The HTTP server...(ask Tibor how to deal with it).
81 The htdocs layer of the Indico system (mod_python handlers), resources and CSS 
82 stylesheets are installed under "/soft/httpd/host/indico/htdocs/". These files 
83 should be www-data readable.
86 5. Other
88 5.1. Submitted abstracts backup
90 For security reasons, all the submitted abstracts from the Call for Asbtarcts 
91 process are backed up in separated XML files. These files are strored under the
92 directory "/data04/bk".
94 6. References
96 [1] "Upgrade of the Indico sw on the production machine" 
97                                 indico/doc/UPGRADE_INDICO_PRODUCTION_CERN