OpenUpgrade Server

Merge lp:~therp-nl/openupgrade-server/7.0-doc_reorder_migration_bits into lp:openupgrade-server

  1. 7.0-doc_reorder_migration_bits
  2. Merge into 7.0
Proposed by Stefan Rijnhart (Opener)
Status: Merged
Merged at revision: 4650
Proposed branch: lp:~therp-nl/openupgrade-server/7.0-doc_reorder_migration_bits
Merge into: lp:openupgrade-server
Diff against target: 139 lines (+61/-53)
3 files modified
openerp/openupgrade/doc/source/index.rst (+0/-1)
openerp/openupgrade/doc/source/intro.rst (+6/-52)
openerp/openupgrade/doc/source/migration_details.rst (+55/-0)
To merge this branch: bzr merge lp:~therp-nl/openupgrade-server/7.0-doc_reorder_migration_bits
Reviewer Review Type Date Requested Status
Pedro Manuel Baeza code review Approve
Holger Brunn (Therp) Approve
Review via email: mp+214185@code.launchpad.net

Description of the change

Reorder migration part of table of contents as follows

Migrating your database
. Automated migration script
... Introduction
... Problems
... In a nutshell
. Migration process details
... Configuration options

To post a comment you must log in.
Revision history for this message
Holger Brunn (Therp) (hbrunn) :
review: Approve
Revision history for this message
Sylvain LE GAL (GRAP) (sylvain-legal) wrote :

Hi.

Thanks for refactoring documentation.

Just a question. I didn't test, just read the MP, but don't you have to write extension of the files L78,L79 ?
migrate.py.rst
migration_details.rst

Regards.

review: Needs Information (code review, no test)
Revision history for this message
Holger Brunn (Therp) (hbrunn) wrote :

no, the extension would actually hurt

Revision history for this message
Sylvain LE GAL (GRAP) (sylvain-legal) wrote :

OK !

review: Approve
Revision history for this message
Pedro Manuel Baeza (pedro.baeza) wrote :

Thanks for continuing improving documentation.

Regards.

review: Approve (code review)
Revision history for this message
Stefan Rijnhart (Opener) (stefan-opener) wrote :

Merged manually into 8.0 which will be the reference project for the docs soon.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'openerp/openupgrade/doc/source/index.rst'
--- openerp/openupgrade/doc/source/index.rst 2014-04-03 18:27:24 +0000
+++ openerp/openupgrade/doc/source/index.rst 2014-04-04 09:05:31 +0000
@@ -20,7 +20,6 @@
20 analysis.rst20 analysis.rst
21 development.rst21 development.rst
22 API.rst22 API.rst
23 migrate.py.rst
2423
25You should find the latest version of this documentation here: `<https://doc.therp.nl/openupgrade>`_24You should find the latest version of this documentation here: `<https://doc.therp.nl/openupgrade>`_
2625
2726
=== modified file 'openerp/openupgrade/doc/source/intro.rst'
--- openerp/openupgrade/doc/source/intro.rst 2013-08-02 12:35:06 +0000
+++ openerp/openupgrade/doc/source/intro.rst 2014-04-04 09:05:31 +0000
@@ -19,57 +19,11 @@
1919
20Please 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.20Please 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.
2121
22Migrating Your Database22Migrating your database
23=======================23=======================
2424
251. Check out the OpenUpgrade source code from Launchpad for the branches you25.. toctree::
26 need. Each branch migrates to its version from the previous version, so26 :maxdepth: 2
27 branch 6.0 migrates from 5.0 to 6.0. If you are skipping versions, you still27
28 need to run all the branches in between.28 migrate.py
2929 migration_details
302. Compare your set of installed modules with the modules that are covered by
31 the OpenUpgrade Addons branch you are using. Upgrading a database that has
32 uncovered modules installed is likely to fail. Authoritative in this respect
33 is the existence and contents of a *user_notes.txt* file in the
34 migrations/[version] subdirectory of each module. We also try to indicate
35 module coverage in the documentation but it sometimes lags behind.
36
373. Decide which database you are going to upgrade. You absolutely *must* make a
38 backup of your live database before you start this process!
39
404. Edit the configuration files and command line parameters to point to the
41 database you are going to upgrade. The parameters will probably be the same
42 as you use on your live server, except they point to the OpenUpgrade
43 addons source code, point to the database you want to upgrade, and add the
44 *--update all --stop-after-init* flags.
45
465. Run the upgrade and check for errors. You will probably learn a lot about
47 your data and have to do some manual clean up before and after the upgrade.
48 Expect to repeat the process several times as you encounter errors, clean up
49 your data, and try again. If necessary, ask for help or report bugs on
50 Launchpad.
51
526. Once the data migration is successful, run the official version of OpenERP
53 against it to test how the migrated data behaves under the new version.
54 Remember that the OpenUpgrade version of the source code is only intended to
55 perform the migration, not run the OpenERP server.
56
57Configuration options
58=====================
59
60OpenUpgrade allows for the following configuration options. Add these options
61to a separate stanza in the server configuration file under a header
62*[openupgrade]*
63
64* *autoinstall* - A dictionary with module name keys and lists of module names
65 as values. If a key module is installed on your database, the modules from
66 the value (and their dependencies) are selected for installation as well.
67
68* *forced_deps* - A dictionary with module name keys and lists of module names
69 as values. If a key module is installed on your database, the modules from
70 the value will be treated as a module dependency. With this directive, you
71 can manipulate the order in which the modules are migrated. If the modules
72 from the value are not already installed on your database, they will be
73 selected for installation (as will their dependencies). Be careful not to
74 introduce a circular dependency using this directive.
75
7630
=== added file 'openerp/openupgrade/doc/source/migration_details.rst'
--- openerp/openupgrade/doc/source/migration_details.rst 1970-01-01 00:00:00 +0000
+++ openerp/openupgrade/doc/source/migration_details.rst 2014-04-04 09:05:31 +0000
@@ -0,0 +1,55 @@
1Migration process details
2=========================
3
4Instead of running *migrate.py*, you can also check out the code manually and upgrade your database by calling openerp-server directly. You will want to do this when you are working on developing migration scripts for uncovered modules.
5
61. Check out the OpenUpgrade source code from Launchpad for the branches you
7 need. Each branch migrates to its version from the previous version, so
8 branch 7.0 migrates from 6.1 to 7.0. If you are skipping versions, you still
9 need to run all the branches in between.
10
112. Compare your set of installed modules with the modules that are covered by
12 the OpenUpgrade Addons branch you are using. Upgrading a database that has
13 uncovered modules installed is likely to fail. Authoritative in this respect
14 is the existence and contents of a *user_notes.txt* file in the
15 migrations/[version] subdirectory of each module. We also try to indicate
16 module coverage in the documentation but it sometimes lags behind.
17
183. Decide which database you are going to upgrade. You absolutely *must* make a
19 backup of your live database before you start this process!
20
214. Edit the configuration files and command line parameters to point to the
22 database you are going to upgrade. The parameters will probably be the same
23 as you use on your live server, except they point to the OpenUpgrade
24 addons source code, point to the database you want to upgrade, and add the
25 *--update all --stop-after-init* flags.
26
275. Run the upgrade and check for errors. You will probably learn a lot about
28 your data and have to do some manual clean up before and after the upgrade.
29 Expect to repeat the process several times as you encounter errors, clean up
30 your data, and try again. If necessary, ask for help or report bugs on
31 Launchpad.
32
336. Once the data migration is successful, run the official version of OpenERP
34 against it to test how the migrated data behaves under the new version.
35 Remember that the OpenUpgrade version of the source code is only intended to
36 perform the migration, not run the OpenERP server.
37
38Configuration options
39+++++++++++++++++++++
40
41OpenUpgrade allows for the following configuration options. Add these options
42to a separate stanza in the server configuration file under a header
43*[openupgrade]*
44
45* *autoinstall* - A dictionary with module name keys and lists of module names
46 as values. If a key module is installed on your database, the modules from
47 the value (and their dependencies) are selected for installation as well.
48
49* *forced_deps* - A dictionary with module name keys and lists of module names
50 as values. If a key module is installed on your database, the modules from
51 the value will be treated as a module dependency. With this directive, you
52 can manipulate the order in which the modules are migrated. If the modules
53 from the value are not already installed on your database, they will be
54 selected for installation (as will their dependencies). Be careful not to
55 introduce a circular dependency using this directive.

Subscribers

People subscribed via source and target branches