Documentation: NOTE on use of sshkeys, and *projects cache on clusters
When using the sshkeys, and *projects caches on a cluster, warn
the Gerrit admin he should be aware of those caches to be potentially
stale. The problem can be minimised by either disabling them
altogether or setting a low value of refreshAfterWrite.
Release-Notes: Warn on cache settings of sshkeys and *projects caches on clusters
Change-Id: Ib49663fb674d5b2248b000562a358860e840b930
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt
index 682239f..ffe5d0a 100644
--- a/Documentation/config-gerrit.txt
+++ b/Documentation/config-gerrit.txt
@@ -1197,6 +1197,9 @@
`projects` cache. The intention is for this cache to have an in-memory
size of 0.
+NOTE: This cache should be disabled or set with a low refreshAfterWrite
+in a cluster setup using multiple primary or multiple replica nodes.
+
cache `"projects"`::
+
Caches the project description records, from the `refs/meta/config`
@@ -1204,6 +1207,9 @@
cache should be flushed. Newly inserted projects do not require
a cache flush, as they will be read upon first reference.
+NOTE: This cache should be disabled or set with a low refreshAfterWrite
+in a cluster setup using multiple primary or multiple replica nodes.
+
cache `"prolog_rules"`::
+
Caches parsed `rules.pl` contents for each project. This cache uses the same
@@ -1230,6 +1236,9 @@
As each individual user account may configure multiple SSH keys,
the total number of keys may be larger than the item count.
+NOTE: This cache should be disabled or set with a low refreshAfterWrite
+in a cluster setup using multiple primary or multiple replica nodes.
+
cache `"web_sessions"`::
+
Tracks the live user sessions coming in over HTTP. Flushing this
