From 31c979078fbb858f31f06df70ac75bcac537ba66 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Mon, 27 Jun 2011 10:21:20 +0000
Subject: [PATCH] Address comments about db-cache and entry cache from Ludo
---
opendj3/src/main/docbkx/admin-guide/chap-tuning.xml | 21 ++++++++++++++++++++-
1 files changed, 20 insertions(+), 1 deletions(-)
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-tuning.xml b/opendj3/src/main/docbkx/admin-guide/chap-tuning.xml
index e7a679d..e1d9ca2 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-tuning.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-tuning.xml
@@ -354,7 +354,11 @@
<para>Database cache size is, by default, set as a percentage of the JVM
heap, using the backend property <literal>db-cache-percent</literal>.
Alternatively, you use the backend property
- <literal>db-cache-size</literal> to set the size.</para>
+ <literal>db-cache-size</literal> to set the size. If you set up multiple
+ database backends, the total percent of JVM heap used must remain less than
+ 100, and must leave space for other uses. Default settings work for servers
+ with one user data backend JVM heaps up to 2 GB. For heaps larger than 2 GB,
+ you can allocate a larger percentage of heap space to DB cache.</para>
<para>Depending on the size of your database, you have a choice to make
about database cache settings.</para>
@@ -380,6 +384,21 @@
</section>
<section>
+ <title>Entry Cache Settings</title>
+
+ <para>OpenDJ implements an entry cache. The entry cache is not designed to
+ cache every entry in your database, but is instead useful in cases where you
+ have a few, typically large entries that are regularly used. For example, if
+ you have a few large static groups and applications that regularly check
+ group membership, you could cache your group entries.</para>
+
+ <screen width="80">$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password \
+> create-entry-cache --cache-name "Large Group Entry Cache" --type fifo \
+> --set cache-level:1 --set include-filter:"(ou=Large Static Groups)" \
+> --set max-entries:10 --set enabled:true -X -n</screen>
+ </section>
+
+ <section>
<title>Logging Settings</title>
<para>Debug logs trace the internal workings of OpenDJ, and therefore
--
Gitblit v1.10.0