Mercurial > p > roundup > code
comparison doc/maintenance.txt @ 1965:43e1f2457bf2
info about how roundup is installed
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Sat, 10 Jan 2004 21:53:27 +0000 |
| parents | 2219893cb787 |
| children |
comparison
equal
deleted
inserted
replaced
| 1960:ca2dca3db172 | 1965:43e1f2457bf2 |
|---|---|
| 1 ============================ | 1 ============================ |
| 2 Maintaining Roundup Trackers | 2 Maintaining Roundup Trackers |
| 3 ============================ | 3 ============================ |
| 4 | 4 |
| 5 :Version: $Revision: 1.2 $ | 5 :Version: $Revision: 1.3 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 :depth: 1 | 8 |
| 9 What does Roundup install? | |
| 10 ========================== | |
| 11 | |
| 12 There's two "installations" that we talk about when using Roundup: | |
| 13 | |
| 14 1. The installation of the software and its support files. This uses the | |
| 15 standard Python mechanism called "distutils" and thus Roundup's core code, | |
| 16 executable scripts and support data files are installed in Python's | |
| 17 directories. On Windows, this is typically: | |
| 18 | |
| 19 Scripts | |
| 20 <python dir>\scripts\... | |
| 21 Core code | |
| 22 <python dir>\lib\site-packages\roundup\... | |
| 23 Support files | |
| 24 <python dir>\share\roundup\... | |
| 25 | |
| 26 and on *nix (eg. Linux): | |
| 27 | |
| 28 Scripts | |
| 29 <python root>/bin/... | |
| 30 Core code | |
| 31 <python root>/lib-<python version>/site-packages/roundup/... | |
| 32 Support files | |
| 33 <python root>/share/roundup/... | |
| 34 | |
| 35 2. The installation of a specific tracker. When invoking the roundup-admin | |
| 36 "inst" (and "init") commands, you're creating a new Roundup tracker. This | |
| 37 installs configuration files, HTML templates, detector code and a new | |
| 38 database. You have complete control over where this stuff goes through | |
| 39 both choosing your "tracker home" and the DATABASE variable in | |
| 40 config.py. | |
| 41 | |
| 9 | 42 |
| 10 Tasks | 43 Tasks |
| 11 ===== | 44 ===== |
| 12 | 45 |
| 13 Maintenance of Roundup can involve one of the following: | 46 Maintenance of Roundup can involve one of the following: |
| 14 | 47 |
| 15 1. `tracker backup`_ | 48 1. `tracker backup`_ |
| 16 2. `software upgrade`_ | 49 2. `software upgrade`_ |
| 17 3. `migrating backends`_ | 50 3. `migrating backends`_ |
| 51 3. `moving a tracker`_ | |
| 18 | 52 |
| 19 | 53 |
| 20 Tracker Backup | 54 Tracker Backup |
| 21 ============== | 55 -------------- |
| 22 | 56 |
| 23 Stop the web and email frontends and to copy the contents of the tracker home | 57 Stop the web and email frontends and to copy the contents of the tracker home |
| 24 directory to some other place using standard backup tools. | 58 directory to some other place using standard backup tools. |
| 25 | 59 |
| 60 | |
| 26 Software Upgrade | 61 Software Upgrade |
| 27 ================ | 62 ---------------- |
| 28 | 63 |
| 29 Always make a backup of your tracker before upgrading software. Steps you may | 64 Always make a backup of your tracker before upgrading software. Steps you may |
| 30 take: | 65 take: |
| 31 | 66 |
| 32 1. ensure that the unit tests run on your system | 67 1. ensure that the unit tests run on your system |
| 38 5. stop the production web and email frontends | 73 5. stop the production web and email frontends |
| 39 6. perform the upgrade steps on the existing tracker directory | 74 6. perform the upgrade steps on the existing tracker directory |
| 40 7. upgrade the software | 75 7. upgrade the software |
| 41 8. restart your tracker | 76 8. restart your tracker |
| 42 | 77 |
| 78 | |
| 43 Migrating Backends | 79 Migrating Backends |
| 44 ================== | 80 ------------------ |
| 45 | |
| 46 | 81 |
| 47 1. stop the existing tracker web and email frontends (preventing changes) | 82 1. stop the existing tracker web and email frontends (preventing changes) |
| 48 2. use the roundup-admin tool "export" command to export the contents of | 83 2. use the roundup-admin tool "export" command to export the contents of |
| 49 your tracker to disk | 84 your tracker to disk |
| 50 3. copy the tracker home to a new directory | 85 3. copy the tracker home to a new directory |
| 58 move the new tracker home into its place | 93 move the new tracker home into its place |
| 59 9. restart web and email frontends | 94 9. restart web and email frontends |
| 60 | 95 |
| 61 | 96 |
| 62 Moving a Tracker | 97 Moving a Tracker |
| 63 ================ | 98 ---------------- |
| 64 | 99 |
| 65 If you're moving the tracker to a similar machine, you should: | 100 If you're moving the tracker to a similar machine, you should: |
| 66 | 101 |
| 67 1. install Roundup on the new machine and test that it works there, | 102 1. install Roundup on the new machine and test that it works there, |
| 68 2. stop the existing tracker web and email frontends (preventing changes), | 103 2. stop the existing tracker web and email frontends (preventing changes), |