annotate doc/maintenance.txt @ 1286:4cbbdcf449f6 0.5.1

pre-release checkin
author Richard Jones <richard@users.sourceforge.net>
date Wed, 16 Oct 2002 06:55:17 +0000
parents 4c9882cb16a3
children 2219893cb787
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 ============================
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 Maintaining Roundup Trackers
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 ============================
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 :Version: $Revision: 1.1 $
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 .. contents::
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 :depth: 1
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 Tasks
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 =====
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 Maintenance of Roundup can involve one of the following:
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 1. `tracker backup`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 2. `software upgrade`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 3. `migrating backends`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 Tracker Backup
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 ==============
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 Stop the web and email frontends and to copy the contents of the tracker home
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 directory to some other place using standard backup tools.
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 Software Upgrade
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 ================
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 Always make a backup of your tracker before upgrading software. Steps you may
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 take:
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 1. ensure that the unit tests run on your system
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 2. copy your tracker home to a new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 3. follow the steps in the upgrading documentation for the new version of
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 4. test each of the admin tool, web interface and mail gateway using the new
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 version of the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 5. stop the production web and email frontends
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 6. perform the upgrade steps on the existing tracker directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 7. upgrade the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 8. restart your tracker
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 Migrating Backends
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 ==================
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 1. stop the existing tracker web and email frontends (preventing changes)
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 2. use the roundup-admin tool "export" command to export the contents of
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 your tracker to disk
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 3. copy the tracker home to a new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 4. change the backend used in the tracker home ``select_db.py`` file
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 5. delete the "db" directory from the new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53 6. use the roundup-admin "import" command to import the previous export with
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 the new tracker home
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 7. test each of the admin tool, web interface and mail gateway using the new
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56 backend
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 8. move the old tracker home out of the way (rename to "tracker.old") and
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 move the new tracker home into its place
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59 9. restart web and email frontends
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62 -------------------
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 Back to `Table of Contents`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66 .. _`Table of Contents`: index.html
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67

Roundup Issue Tracker: http://roundup-tracker.org/