Ticket #3831 (partial) - Rewrite cache updater as twisted application:
[ganeti_webmgr.git] / UPGRADING
blobf812ef503da7972950094a5e74c7ecc5d27c6dda
1 ===============================================================================
2  Upgrading Ganeti Web Manager
3 ===============================================================================
5 This quick guide will walk you through upgrading Ganeti Web Manager. A more
6 detailed upgrade guide can be found on our wiki [1]. This guide is intended to
7 give you a quick summary of how to upgrade you GWM.
9 Our upgrade process uses Python-Django-South [2] a database migration tool that
10 will update your database.
12 The basic process goes as follows:
14  1. Download the latest code
15  2. Backup the database
16  3. Save a copy of settings.py
17  4. Deploy code to your existing directory
18  5. Copy settings.py back into the directory
19  6. Follow the guide for your version.
21 [1] http://code.osuosl.org/projects/ganeti-webmgr/wiki/Upgrading
22 [2] http://south.aeracode.org/docs/
24 ===============================================================================
25  Upgrading From Version 0.4 
26 ===============================================================================
28 If you are upgrading from version 0.4 you will be required to convert your
29 installation to use South. Version 0.4 did not track the database with South, so
30 South must be informed that your installation is already partially migrated.
32  1. Backup your database
33  2. Install python-django-south [1].
34  3. Add "south" to the list of INSTALLED_APPS inside settings.py
35  4. Make sure you add any new settings to settings.py that are listed in the
36     Settings Changes section [2]. 
37  5. Synchronize the database with:
38         ./manage.py syncdb
39  6. Convert the ganeti app to use South for future migrations:
40         ./manage.py migrate ganeti 0001 --fake
41  7. Convert the logs app to use South for future migrations:
42         ./manage.py migrate logs 0001 --fake
43  8. Run South migration:
44         ./manage.py migrate
46 [1] http://south.aeracode.org/docs/installation.html
47 [2] http://code.osuosl.org/projects/ganeti-webmgr/wiki/Upgrading#Settings-Changes
49 ===============================================================================
50  Upgrading from >=0.5
51 ===============================================================================
53  1. Backup your database
54  2. Run South migration.
55  3. Update settings.py following the guide on the wiki [1].
56         ./manage.py migrate
58 [1] http://code.osuosl.org/projects/ganeti-webmgr/wiki/Upgrading#Settings-Changes