credativ team mailing list archive

[Don Kirkby <donkirkby+launpd@xxxxxxxxx>]

Don Kirkby has proposed merging lp:~zaber/openupgrade-server/6.1-docs into lp:openupgrade-server.

Requested reviews:
  OpenUpgrade Committers (openupgrade-committers)

For more details, see:
https://code.launchpad.net/~zaber/openupgrade-server/6.1-docs/+merge/123621

Question 208187 reminded me that the documentation never explicitly spells out the steps required to run a migration. This is my attempt to spell it out at the end of the introduction.
-- 
https://code.launchpad.net/~zaber/openupgrade-server/6.1-docs/+merge/123621
Your team OpenUpgrade Committers is requested to review the proposed merge of lp:~zaber/openupgrade-server/6.1-docs into lp:openupgrade-server.

=== modified file 'openerp/openupgrade/doc/source/intro.rst'
--- openerp/openupgrade/doc/source/intro.rst	2012-06-06 09:13:43 +0000
+++ openerp/openupgrade/doc/source/intro.rst	2012-09-10 18:38:27 +0000
@@ -18,3 +18,30 @@
 Apart from a collection of migration scripts, this project aims at providing developers with a set of tools that they can use to extract the changes that their migration scripts need to cover. You can read more on that in the :doc:`analysis` section.
 
 Please do not use the OpenUpgrade software to run a live instance of your OpenERP database. It is not maintained for that purpose. Use the official OpenERP software for that.
+
+Migrating Your Database
+=======================
+
+1. Check out the OpenUpgrade source code from Launchpad for the branches you
+   need. Each branch migrates to its version from the previous version, so
+   branch 6.0 migrates from 5.0 to 6.0. If you are skipping versions, you still
+   need to run all the branches in between.
+
+2. Decide which database you are going to upgrade. You probably want to take a
+   backup of your live database before you start this process!
+
+3. Edit the configuration files and command line parameters to point to the
+   database you are going to upgrade. The parameters will probably be the same
+   as you use on your live server, except they point to the OpenUpgrade
+   addons source code, point to the database you want to upgrade, and add the
+   *--update all --stop-after-init* flags.
+
+4. Run the upgrade and check for errors. You will probably learn a lot about
+   your data and have to do some manual clean up before and after the upgrade. 
+   Expect to repeat the process several times as you encounter errors, clean up
+   your data, and try again.
+
+5. Once the data migration is successful, run the official version of OpenERP
+   against it to test how the migrated data behaves under the new version. 
+   Remember that the OpenUpgrade version of the source code is only intended to 
+   perform the migration, not run the OpenERP server.
\ No newline at end of file