Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 7296:c3b0fd62b0b8
Minor tweaks to upgrading general directions.
Recommended using virtual env for install in step 4.
Make explicit that you use the new roundup-admin for migration in step 6.
Cleaned up some wording.
Replaced python 3.4 with python 3.6 in supported version paragraph.
Added section on running different trackers with diferent versions of
Roundup via virtual envirnments.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 03 May 2023 11:11:45 -0400 |
| parents | 194093011cb7 |
| children | e21c7fe0b57a |
comparison
equal
deleted
inserted
replaced
| 7295:1ce75966d274 | 7296:c3b0fd62b0b8 |
|---|---|
| 8 | 8 |
| 9 ====================================== | 9 ====================================== |
| 10 Upgrading to newer versions of Roundup | 10 Upgrading to newer versions of Roundup |
| 11 ====================================== | 11 ====================================== |
| 12 | 12 |
| 13 Please read each section carefully and edit your tracker home files | 13 Please read each section carefully and edit the files in your tracker home |
| 14 accordingly. Note that there is information about upgrade procedures in the | 14 accordingly. Note that there is information about upgrade procedures in the |
| 15 `administration guide`_ in the `Software Upgrade`_ section. | 15 `administration guide`_ in the `Software Upgrade`_ section. |
| 16 | 16 |
| 17 If a specific version transition isn't mentioned here (eg. 0.6.7 to 0.6.8) | 17 If a specific version transition isn't mentioned here (e.g. 0.6.7 to 0.6.8) |
| 18 then you don't need to do anything. If you're upgrading from 0.5.6 to | 18 then you don't need to do anything. If you're upgrading from 0.5.6 to |
| 19 0.6.8 though, you'll need to check the "0.5 to 0.6" and "0.6.x to 0.6.3" | 19 0.6.8 though, you'll need to apply the "0.5 to 0.6" and "0.6.x to 0.6.3" |
| 20 steps. | 20 steps. |
| 21 | 21 |
| 22 General steps: | 22 General steps: |
| 23 | 23 |
| 24 1. Make note of your current Roundup version. | 24 1. Make note of your current Roundup version. |
| 25 2. Take your Roundup installation offline (web, email, | 25 2. Take your Roundup installation offline (web, email, |
| 26 cron scripts, roundup-admin etc.) | 26 cron scripts, roundup-admin etc.) |
| 27 3. Backup your Roundup instance | 27 3. Backup your Roundup instance |
| 28 4. Install a new version of Roundup | 28 4. Install the new version of Roundup (preferably in a new virtual |
| 29 environment) | |
| 29 5. Make version specific changes as described below for | 30 5. Make version specific changes as described below for |
| 30 each version transition. If you are starting at 1.5.0 | 31 each version transition. If you are starting at 1.5.0 |
| 31 and installing to 2.3, you need to make the changes for **all** | 32 and installing to 2.3.0, you need to make the changes for **all** |
| 32 versions starting at 1.5 and ending at 2.3. E.G. | 33 versions starting at 1.5 and ending at 2.3. E.G. |
| 33 1.5.0 -> 1.5.1, 1.5.1 -> 1.6.0, ..., 2.1.0 -> 2.2.0, | 34 1.5.0 -> 1.5.1, 1.5.1 -> 1.6.0, ..., 2.1.0 -> 2.2.0, |
| 34 2.2.0 -> 2.3.0. | 35 2.2.0 -> 2.3.0. |
| 35 6. Run ``roundup-admin -i <tracker_home> migrate`` for | 36 6. Run ``roundup-admin -i <tracker_home> migrate`` using the newer |
| 36 **all** your trackers. This will update the database if | 37 version of Roundup for **all** the trackers you have |
| 37 it is required. | 38 upgraded. This will update the database if it is required. |
| 38 7. Bring your Roundup instance back online | 39 7. Bring your Roundup instance back online |
| 39 8. Test | 40 8. Test |
| 40 | 41 |
| 41 **IMPORTANT** The v1.5.x releases of Roundup were the last to support | 42 **IMPORTANT** The v1.5.x releases of Roundup were the last to support |
| 42 Python v2.5 and v2.6. Starting with the v1.6 releases of Roundup | 43 Python v2.5 and v2.6. Starting with the v1.6 releases of Roundup |
| 43 Python version 2.7 that is newer than 2.7.2 is required to run | 44 Python version 2.7 that is newer than 2.7.2 is required to run |
| 44 Roundup. Starting with Roundup version 2.0.0 we also support Python 3 | 45 Roundup. Starting with Roundup version 2.0.0 we also support Python 3 |
| 45 versions newer than 3.4. | 46 versions newer than 3.6. |
| 46 | 47 |
| 47 Recent release notes have the following labels: | 48 Recent release notes have the following labels: |
| 48 | 49 |
| 49 * required - Roundup will not work properly if these steps are not done | 50 * required - Roundup will not work properly if these steps are not done |
| 50 * recommended - Roundup will still work, but these steps can cause | 51 * recommended - Roundup will still work, but these steps can cause |
| 51 security or stability issues if not done. | 52 security or stability issues if not done. |
| 52 * optional - new features or changes to existing features you might | 53 * optional - new features or changes to existing features you might |
| 53 want to use | 54 want to use |
| 54 * info - important possibly visible changes in how things operate | 55 * info - important possibly visible changes in how things operate |
| 56 | |
| 57 If you use virtual environments for your installation, you can run | |
| 58 trackers with different versions of Roundup. So you can have one tracker | |
| 59 using version 2.2.0 and another tracker using version 1.6.1. This | |
| 60 allows you to upgrade trackers one at a time rather than having to | |
| 61 upgrade all your trackers at once. | |
| 55 | 62 |
| 56 Contents: | 63 Contents: |
| 57 | 64 |
| 58 .. contents:: | 65 .. contents:: |
| 59 :local: | 66 :local: |