From 91f0957b25de67a7885eec8e4340e118269da51e Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 30 Sep 2011 10:23:29 +0000
Subject: [PATCH] Indexing, etc.
---
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml | 6 +++---
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-uninstall.xml | 12 ++++++------
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-jvm-opts.xml | 3 +--
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml | 13 ++++++++-----
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml | 19 +++++++++----------
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-before-you-install.xml | 6 ++++--
6 files changed, 31 insertions(+), 28 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-before-you-install.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-before-you-install.xml
index a8862bb..9642c11 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-before-you-install.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-before-you-install.xml
@@ -36,7 +36,7 @@
<section xml:id="prerequisites-java">
<title>Java Environment</title>
- <indexterm><primary>Java requirements</primary></indexterm>
+ <indexterm><primary>Java</primary><secondary>Requirements</secondary></indexterm>
<para>OpenDJ software consists of pure Java applications. OpenDJ servers
and clients therefore should run on any system with full Java support.
@@ -52,13 +52,13 @@
<section xml:id="prerequisites-hardware">
<title>Hardware</title>
- <indexterm><primary>Hardware requirements</primary></indexterm>
<para>Thanks to the underlying Java platform, OpenDJ software runs well
on a variety of processor architectures. Many directory service
deployments meet their service-level agreements without the very latest
or very fastest hardware.</para>
+ <indexterm><primary>Memory requirements</primary></indexterm>
<para>For a server evaluation installation, you need 256 MB memory (32-bit)
or 1 GB memory (64-bit) available to OpenDJ, with 100 MB free disk space for
the software and a small set of sample data. For installation in production,
@@ -87,6 +87,7 @@
slower threads get blocked waiting on resources, and thus are not optimal
for topologies with high write throughput requirements.</para>
+ <indexterm><primary>Network requirements</primary></indexterm>
<para>On systems with fast processors and enough memory to cache directory
data completely, the network can become a bottleneck. Even if a single
1 Gbit Ethernet interface offers plenty of bandwidth to handle your
@@ -100,6 +101,7 @@
throughput, not counting any other operations such as writes that
result in replication traffic.</para>
+ <indexterm><primary>Storage requirements</primary></indexterm>
<para>The storage hardware you choose must allow you to house not only
directory data including historical data for replication, but also
logs. If you choose to retain access logs for auditing purposes on a
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
index 89c9291..7f0e679 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
@@ -39,7 +39,7 @@
<step xml:id="check-for-java">
<para>Make sure you have the correct Java environment installed.</para>
- <indexterm><primary>Java requirements</primary></indexterm>
+ <indexterm><primary>Java</primary><secondary>Requirements</secondary></indexterm>
<screen>$ java -version
java version "1.6.0_24"
@@ -56,7 +56,7 @@
</step>
<step xml:id="download-opendj">
- <indexterm><primary>Download OpenDJ</primary></indexterm>
+ <indexterm><primary>Downloading OpenDJ</primary></indexterm>
<para>Get the appropriate installation packages from the <link
xlink:href='http://www.forgerock.org/opendj.html'
@@ -84,6 +84,8 @@
</step>
<step xml:id="enough-file-descriptors">
+ <indexterm><primary>File descriptor requirements</primary></indexterm>
+
<para>Allow OpenDJ software to use at least 64K (65536) file descriptors
to operate properly.</para>
@@ -96,6 +98,8 @@
</step>
<step xml:id="app-server-needed-for-dsml">
+ <indexterm><primary>DSML gateway</primary></indexterm>
+
<para>If you plan to install OpenDJ DSML gateway, make sure you have an
appropriate application server installed.</para>
</step>
@@ -374,7 +378,8 @@
<procedure xml:id="install-dsml-gateway">
<title>To Install OpenDJ DSML gateway</title>
- <indexterm><primary>DSML gateway installation</primary></indexterm>
+ <indexterm><primary>DSML gateway</primary></indexterm>
+
<para>The OpenDJ DSML gateway functions as a web application located in a
web application container. The DSML gateway runs independently of OpenDJ
directory server. You configure the gateway to access your directory service
@@ -398,6 +403,4 @@
for your application server.</para>
</step>
</procedure>
-
</chapter>
-
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
index 723c6e8..ddcf92a 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
@@ -30,7 +30,9 @@
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Installing OpenDJ With the QuickSetup Wizard</title>
-
+ <indexterm><primary>Downloading OpenDJ</primary></indexterm>
+ <indexterm><primary>Quick install</primary></indexterm>
+
<para>If you want only to try OpenDJ server software, and you do not plan to
store any real or important data that you want to keep, then read only this
section, or just try out installation without reading any further. Visit the
@@ -132,6 +134,4 @@
(Windows), or bin/Control Panel.app (Mac OS X) to launch the Control Panel
again later.</para></caption>
</mediaobject>
-
</chapter>
-
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-jvm-opts.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-jvm-opts.xml
index 578176b..0fb52c9 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-jvm-opts.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-jvm-opts.xml
@@ -35,7 +35,7 @@
<para>By default, OpenDJ installs with options appropriate for evaluation, not
for production.</para>
- <indexterm><primary>JVM settings</primary></indexterm>
+ <indexterm><primary>Java</primary><secondary>Settings</secondary></indexterm>
<variablelist>
<para>You can change JVM options for the server in the QuickStart installer,
@@ -83,4 +83,3 @@
</varlistentry>
</variablelist>
</chapter>
-
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-uninstall.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-uninstall.xml
index fd9333a..496d39e 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-uninstall.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-uninstall.xml
@@ -30,11 +30,12 @@
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Removing OpenDJ Servers</title>
-
+ <indexterm><primary>Uninstalling</primary></indexterm>
+
<para>Remove OpenDJ directory server software with the
<command>uninstall</command> command.</para>
- <procedure>
+ <procedure xml:id="uninstall-gui">
<title>To Uninstall OpenDJ From the Graphical Uninstaller</title>
<step>
<para>(UNIX) Run
@@ -51,7 +52,7 @@
<caption>
<para>Select what to remove in the initial screen.</para>
</caption>
- </mediaobject>
+ </mediaobject>
</step>
<step>
@@ -62,11 +63,11 @@
<imageobject>
<imagedata fileref="images/uninstall-finished.png" format="PNG" />
</imageobject>
- </mediaobject>
+ </mediaobject>
</step>
</procedure>
- <procedure>
+ <procedure xml:id="uninstall-cli">
<title>To Uninstall OpenDJ On the Command Line</title>
<step>
@@ -116,4 +117,3 @@
</step>
</procedure>
</chapter>
-
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
index 409df57..29af40c 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
@@ -30,7 +30,8 @@
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Upgrading to OpenDJ <?eval ${project.version}?></title>
-
+ <indexterm><primary>Upgrading</primary></indexterm>
+
<para>You can upgrade from an earlier version of OpenDJ either directly
from within the Java WebStart installer, or on the command-line using the
<command>upgrade</command> command.</para>
@@ -42,7 +43,7 @@
import your data from LDIF.</para>
</note>
- <section>
+ <section xml:id="before-you-upgrade">
<title>Before You Upgrade</title>
<para>You must perform the upgrade procedure as the user who own the OpenDJ
@@ -95,13 +96,13 @@
</orderedlist>
</section>
- <section>
+ <section xml:id="upgrade-servers">
<title>Upgrading OpenDJ Servers</title>
<para>You can upgrade from the graphical installer, or from the command
line.</para>
- <procedure>
+ <procedure xml:id="upgrade-gui">
<title>To Upgrade From the Graphical Installer</title>
<step>
<para>Login to a session where you can use a GUI as the user who owns the
@@ -149,7 +150,7 @@
</step>
</procedure>
- <procedure>
+ <procedure xml:id="upgrade-cli">
<title>To Upgrade On the Command Line</title>
<step>
@@ -199,21 +200,19 @@
</step>
</procedure>
- <procedure>
+ <procedure xml:id="upgrade-repl">
<title>To Upgrade Replicated Servers</title>
<step>
<para>Upgrade each server sequentially, as described above.</para>
</step>
</procedure>
- <procedure>
+ <procedure xml:id="upgrade-dsml">
<title>To Upgrade OpenDJ DSML Gateway</title>
<step>
- <para>Replace the gateweay web application with the newer version,
+ <para>Replace the gateway web application with the newer version,
as for a fresh installation.</para>
</step>
</procedure>
</section>
-
</chapter>
-
--
Gitblit v1.10.0