Mercurial > p > roundup > code

annotate doc/maintenance.txt @ 2002:b046b65e51db

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
if you're going to enforce class-level permissions... ...then enforce them at the class level
author Richard Jones <richard@users.sourceforge.net>
date Wed, 11 Feb 2004 00:22:20 +0000
parents 43e1f2457bf2
children
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
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
5 :Version: $Revision: 1.3 $
1218
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::
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
8
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
9 What does Roundup install?
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
10 ==========================
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
11
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
12 There's two "installations" that we talk about when using Roundup:
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
13
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
14 1. The installation of the software and its support files. This uses the
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
15 standard Python mechanism called "distutils" and thus Roundup's core code,
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
16 executable scripts and support data files are installed in Python's
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
17 directories. On Windows, this is typically:
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
18
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
19 Scripts
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
20 <python dir>\scripts\...
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
21 Core code
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
22 <python dir>\lib\site-packages\roundup\...
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
23 Support files
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
24 <python dir>\share\roundup\...
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
25
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
26 and on *nix (eg. Linux):
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
27
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
28 Scripts
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
29 <python root>/bin/...
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
30 Core code
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
31 <python root>/lib-<python version>/site-packages/roundup/...
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
32 Support files
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
33 <python root>/share/roundup/...
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
34
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
35 2. The installation of a specific tracker. When invoking the roundup-admin
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
36 "inst" (and "init") commands, you're creating a new Roundup tracker. This
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
37 installs configuration files, HTML templates, detector code and a new
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
38 database. You have complete control over where this stuff goes through
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
39 both choosing your "tracker home" and the DATABASE variable in
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
40 config.py.
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
41
1218
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 Tasks
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 Maintenance of Roundup can involve one of the following:
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 1. `tracker backup`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 2. `software upgrade`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 3. `migrating backends`_
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
51 3. `moving a tracker`_
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 Tracker Backup
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
55 --------------
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 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
58 directory to some other place using standard backup tools.
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
60
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 Software Upgrade
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
62 ----------------
1218
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 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
65 take:
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67 1. ensure that the unit tests run on your system
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68 2. copy your tracker home to a new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69 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
70 the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 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
72 version of the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73 5. stop the production web and email frontends
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74 6. perform the upgrade steps on the existing tracker directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75 7. upgrade the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 8. restart your tracker
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
78
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79 Migrating Backends
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
80 ------------------
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82 1. stop the existing tracker web and email frontends (preventing changes)
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83 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
84 your tracker to disk
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85 3. copy the tracker home to a new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86 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
87 5. delete the "db" directory from the new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 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
89 the new tracker home
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 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
91 backend
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92 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
93 move the new tracker home into its place
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94 9. restart web and email frontends
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96
1397
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
97 Moving a Tracker
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1397
diff changeset
98 ----------------
1397
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
99
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
100 If you're moving the tracker to a similar machine, you should:
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
101
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
102 1. install Roundup on the new machine and test that it works there,
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
103 2. stop the existing tracker web and email frontends (preventing changes),
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
104 3. copy the tracker home directory over to the new machine, and
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
105 4. start the tracker web and email frontends on the new machine.
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
106
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
107 Most of the backends are actually portable across platforms (ie. from Unix to
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
108 Windows to Mac). If this isn't the case (ie. the tracker doesn't work when
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
109 moved using the above steps) then you'll need to:
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
110
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
111 1. install Roundup on the new machine and test that it works there,
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
112 2. stop the existing tracker web and email frontends (preventing changes),
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
113 3. use the roundup-admin tool "export" command to export the contents of
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
114 the existing tracker,
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
115 4. copy the export to the new machine,
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
116 5. use the roundup-admin "import" command to import the tracker on the new
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
117 machine, and
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
118 6. start the tracker web and email frontends on the new machine.
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
119
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
120
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
121 -------------------
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
122
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
123 Back to `Table of Contents`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
124
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
125 .. _`Table of Contents`: index.html
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
126
Roundup Issue Tracker: http://roundup-tracker.org/