opendev/gerrit
Code Issues Proposed changes

Document skipping of reindexing step for offline NoteDB migration

Browse Source 
Since the reindexing of changes can take a considerable amount of time,
we explicitly mention in the documentation that it can be skipped.

The needed parameter is of course already described in the migration
program's help page, but that's too easy to miss if the parameter is
not explicitly mentioned in the documentation.

Change-Id: I873f3f072c6249e618419466c3e8e16d2160d495
This commit is contained in:
Christian Aistleitner
2020-06-15 16:17:17 +02:00
parent 98b5d8f55c
commit d2d5658c17
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/note-db.txt
View File

@@ -109,6 +109,13 @@ Migration requires a heap size comparable to running a Gerrit server. If you
normally run `gerrit.war daemon` with an `-Xmx` flag, pass that to the migration
tool as well.
[NOTE]
Note that by appending `--reindex false` to the above command, you can skip the
lenghty, implicit reindexing step of the migration. This is useful if you plan
to perform further Gerrit upgrades while the server is offline and have to
reindex later anyways (E.g.: a follow-up upgrade to Gerrit 3.2 or newer, which
requires to reindex changes anyways).
*Advantages*
* Much faster than online; can use all available CPUs, since no live traffic