From 7878bed5d327a869ed3b2527078e0b279c770d32 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Thu, 29 Mar 2012 13:56:31 +0000
Subject: [PATCH] Move prerequistes to release notes as for other products
---
/dev/null | 62 --------------------
opendj-sdk/opendj3/src/main/docbkx/release-notes/index.xml | 6 +-
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml | 4
opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml | 4
opendj-sdk/opendj3/src/main/docbkx/install-guide/index.xml | 1
opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml | 78 +++++++++++++++++++++----
6 files changed, 71 insertions(+), 84 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
index 6ec7d72..ffa202b 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
@@ -69,8 +69,8 @@
<para>Before you either download a build of OpenDJ LDAP SDK, or get the
source code to build your own SDK, make sure you have a Java Development Kit
- installed. See the <citetitle>Installation Guide</citetitle> section on
- <link xlink:href="install-guide#prerequisites-java"
+ installed. See the <citetitle>Release Notes</citetitle> section on
+ <link xlink:href="release-notes#prerequisites-java"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Java
Environment</citetitle></link> requirements.</para>
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 e61d69b..9730b1a 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,8 +39,8 @@
<step xml:id="check-for-java">
<para>Make sure you have the correct Java environment installed, as
- described in the section on <link
- xlink:href="install-guide#prerequisites-java"
+ described in the <citetitle>Release Notes</citetitle> section on <link
+ xlink:href="release-notes#prerequisites-java"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Java
Environment</citetitle></link> requirements.</para>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/index.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/index.xml
index 75703fe..91a7a09 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/index.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/index.xml
@@ -54,7 +54,6 @@
<xinclude:include href="preface.xml" />
<xinclude:include href='chap-install-gui.xml' />
- <xinclude:include href='chap-before-you-install.xml' />
<xinclude:include href='chap-install-cli.xml' />
<xinclude:include href='chap-jvm-opts.xml' />
<xinclude:include href='chap-upgrade.xml' />
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-before-you-install.xml b/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml
similarity index 82%
rename from opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-before-you-install.xml
rename to opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml
index d80db01..0f50e28 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-before-you-install.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml
@@ -29,14 +29,21 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <title>Before You Run OpenDJ in Production</title>
+ <title>Before You Install OpenDJ Software</title>
- <para>This chapter covers what you need to consider before you run OpenDJ in
- your production environment.</para>
-
+ <para>This chapter covers requirements to consider before you run OpenDJ,
+ especially before you run OpenDJ in your production environment.</para>
+
+ <para>If you have a special request to support a combination not listed here,
+ contact ForgeRock at <link xlink:href='mailto:info@forgerock.com'
+ >info@forgerock.com</link>.</para>
+
<section xml:id="prerequisites-java">
<title>Java Environment</title>
- <indexterm><primary>Java</primary><secondary>Requirements</secondary></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.
@@ -48,6 +55,51 @@
Standard Edition 6.0 (Sun version 1.6.0_10) runtime environment. ForgeRock
recommends that you use at least version 1.6.0_27 due to security
fixes.</para>
+
+ <para>To build applications with the OpenDJ LDAP SDK, you need the
+ corresponding Java SDK.</para>
+ </section>
+
+ <section xml:id="prerequisites-operating-systems">
+ <title>Operating System</title>
+ <indexterm>
+ <primary>Operating systems</primary>
+ <secondary>Requirements</secondary>
+ </indexterm>
+
+ <para>OpenDJ software depends on the Java environment more than it depends
+ on the underlying operating system. That said, OpenDJ
+ <?eval ${docTargetVersion}?> has been validated on the following operating
+ systems.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Apple Mac OS X 10.7</para>
+ </listitem>
+ <listitem>
+ <para>Linux 2.6</para>
+ </listitem>
+ <listitem>
+ <para>Microsoft Windows Server 2008</para>
+ </listitem>
+ <listitem>
+ <para>Oracle Solaris 10</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section xml:id="prerequisites-application-servers">
+ <title>Application Servers</title>
+ <indexterm>
+ <primary>Application servers</primary>
+ <secondary>Requirements</secondary>
+ </indexterm>
+
+ <para>OpenDJ directory server runs as a standalone Java service, and
+ does not depend on an application server.</para>
+
+ <para>OpenDJ <?eval ${docTargetVersion}?> DSML gateway has been validated
+ on Apache Tomcat 6.</para>
</section>
<section xml:id="prerequisites-fqdn">
@@ -67,12 +119,12 @@
<section xml:id="prerequisites-hardware">
<title>Hardware</title>
-
+
<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
@@ -98,7 +150,7 @@
tests based on the estimated rates of change and growth in directory data,
and then use the actual space used in the test environment to estimate how
much disk space you need in production.</para>
-
+
<para>OpenDJ directory servers almost always benefit from having enough
system memory to cache all directory database files used. The reason
is that reading from and writing to memory is typically much faster
@@ -108,7 +160,7 @@
sufficient memory to cache everything. To improve performance in such
cases, one approach is to add solid state drives as an intermediate
cache between memory and disk storage.</para>
-
+
<para>Processor architectures that provide fast single thread execution
tend to help OpenDJ software deliver the lowest response times. For top end
performance in terms both of sub-millisecond response times and also
@@ -120,7 +172,7 @@
to absorb hundreds or thousands of write operations per second. Their
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
@@ -134,7 +186,7 @@
entry, you need a network that can handle 800 MB/sec (3.2 Gbit/sec)
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
@@ -150,13 +202,11 @@
historical information in order to resolve potential replication
conflicts. You base your network throughput needs on peak loads. Also
base your storage throughput needs on peak loads.</para>
-
+
<note>
<para>OpenDJ servers do not currently support network file systems such
as NFS for database storage. Provide sufficient disk space on local storage
such as internal disk or an attached disk array.</para>
</note>
</section>
-
</chapter>
-
diff --git a/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-testing.xml b/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-testing.xml
deleted file mode 100644
index 9eafe91..0000000
--- a/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-testing.xml
+++ /dev/null
@@ -1,62 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ! CCPL HEADER START
- !
- ! This work is licensed under the Creative Commons
- ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
- ! To view a copy of this license, visit
- ! http://creativecommons.org/licenses/by-nc-nd/3.0/
- ! or send a letter to Creative Commons, 444 Castro Street,
- ! Suite 900, Mountain View, California, 94041, USA.
- !
- ! You can also obtain a copy of the license at
- ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
- ! See the License for the specific language governing permissions
- ! and limitations under the License.
- !
- ! If applicable, add the following below this CCPL HEADER, with the fields
- ! enclosed by brackets "[]" replaced with your own identifying information:
- ! Portions Copyright [yyyy] [name of copyright owner]
- !
- ! CCPL HEADER END
- !
- ! Copyright 2011 ForgeRock AS
- !
--->
-<chapter xml:id='chap-testing'
- xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'
- xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <title>Tested Operating Systems & Application Servers</title>
-
- <para>OpenDJ software depends on the Java environment more than it depends
- on the underlying operating systems. OpenDJ directory server relies on Java 6,
- specifically at least the Java Standard Edition 6.0 (Sun version 1.6.0_10)
- runtime environment. ForgeRock recommends that you use at least version
- 1.6.0_27 due to security fixes. To build applications with the OpenDJ LDAP
- SDK, you need the Java SDK as the runtime environment has no
- compiler.</para>
-
- <para>That said, OpenDJ <?eval ${docTargetVersion}?> has been validated on
- the following operating systems.</para>
-
- <itemizedlist>
- <listitem>
- <para>Apple Mac OS X 10.7</para>
- </listitem>
- <listitem>
- <para>Linux 2.6</para>
- </listitem>
- <listitem>
- <para>Microsoft Windows Server 2008</para>
- </listitem>
- <listitem>
- <para>Oracle Solaris 10</para>
- </listitem>
- </itemizedlist>
-
- <para>OpenDJ <?eval ${docTargetVersion}?> DSML gateway has been validated
- on Apache Tomcat 6.</para>
-</chapter>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/release-notes/index.xml b/opendj-sdk/opendj3/src/main/docbkx/release-notes/index.xml
index 87dd984..1f0519e 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/release-notes/index.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/release-notes/index.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<book xml:id='release-notes'
@@ -37,7 +37,7 @@
in Java.</para>
</abstract>
<copyright>
- <year>2011</year>
+ <year>2011-2012</year>
<holder>ForgeRock AS</holder>
</copyright>
<authorgroup>
@@ -85,9 +85,9 @@
</preface>
<xinclude:include href='chap-whats-new.xml' />
+ <xinclude:include href='chap-before-you-install.xml' />
<xinclude:include href='chap-compatibility.xml' />
<xinclude:include href='chap-issues.xml' />
- <xinclude:include href='chap-testing.xml' />
<xinclude:include href='chap-feedback.xml' />
<xinclude:include href='chap-support.xml' />
</book>
--
Gitblit v1.10.0