opendev/gerrit
Code Issues Proposed changes

Move non-migration-related NoteDb config options to regular docs

Browse Source 
Change-Id: If30ca7f4418d9b78e026d115d38a0a2974d6b5e9
This commit is contained in:
Dave Borowitz
2017-08-15 14:48:37 -04:00
parent 52e30e77d8
commit cd9edda39b
2 changed files with 22 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Documentation/config-gerrit.txt
View File

@@ -3286,8 +3286,8 @@ Common examples:
=== Section noteDb
NoteDb is the next generation of Gerrit storage backend, currently powering
`googlesource.com`. It is not (yet) recommended for general use, but if you want
to learn more, see the link:dev-note-db.html[developer documentation].
`googlesource.com`. For more information, including how to migrate your data,
see the link:dev-note-db.html[documentation].
[[notedb.accounts.sequenceBatchSize]]notedb.accounts.sequenceBatchSize::
+
@@ -3302,6 +3302,26 @@ each process retrieves at once.
+
By default, 1.
[[noteDb.retryMaxWait]]noteDb.retryMaxWait::
+
Maximum time to wait between attempts to retry update operations when one
attempt fails due to contention (aka lock failure) on the underlying ref
storage. Operations are retried with exponential backoff, plus some random
jitter, until the interval reaches this limit. After that, retries continue to
occur after a fixed timeout (plus jitter), up to
link:#noteDb.retryTimeout[`noteDb.retryTimeout`].
+
Defaults to 5 seconds; unit suffixes are supported, and assumes milliseconds if
not specified.
[[noteDb.retryTimeout]]noteDb.retryTimeout::
+
Total timeout for retrying update operations when one attempt fails due to
contention (aka lock failure) on the underlying ref storage.
+
Defaults to 20 seconds; unit suffixes are supported, and assumes milliseconds if
not specified.
[[oauth]]
=== Section oauth

25
Documentation/dev-note-db.txt
View File

@@ -146,28 +146,3 @@ primarily as a reference.
of all changes in NoteDb is accurate, and so is only safe once all changes are
NoteDb primary. Otherwise, reading changes only from NoteDb might result in
inaccurate results, and writing to NoteDb would compound the problem. +
There is additional general configuration for the NoteDb backend that is not
directly related to the migration process. These options will continue to be
supported after the migration is complete and the migration-related options are
obsolete.
[[noteDb.retryMaxWait]]noteDb.retryMaxWait::
+
Maximum time to wait between attempts to retry update operations when one
attempt fails due to contention (aka lock failure) on the underlying ref
storage. Operations are retried with exponential backoff, plus some random
jitter, until the interval reaches this limit. After that, retries continue to
occur after a fixed timeout (plus jitter), up to
link:#noteDb.retryTimeout[`noteDb.retryTimeout`].
+
Defaults to 5 seconds; unit suffixes are supported, and assumes milliseconds if
not specified.
[[noteDb.retryTimeout]]noteDb.retryTimeout::
+
Total timeout for retrying update operations when one attempt fails due to
contention (aka lock failure) on the underlying ref storage.
+
Defaults to 20 seconds; unit suffixes are supported, and assumes milliseconds if
not specified.