From 3ff5bda5d53823aee9df5c75713d3ae71b0ba3be Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Wed, 03 Jul 2013 06:18:12 +0000
Subject: [PATCH] Updates for QA review comments thanks to Christophe
---
opendj3/src/main/docbkx/install-guide/chap-install-gui.xml | 2
opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml | 4
opendj3/src/main/docbkx/admin-guide/chap-rest-operations.xml | 6 -
opendj3/src/main/docbkx/admin-guide/chap-connection-handlers.xml | 14 ++++
opendj3/src/main/docbkx/admin-guide/chap-server-process.xml | 3 -
opendj3/src/main/docbkx/install-guide/chap-upgrade.xml | 7 +-
opendj3/src/main/docbkx/shared/screen-upgrade.xml | 25 ++++++-
opendj3/src/main/docbkx/release-notes/chap-compatibility.xml | 50 +++++++++++++---
opendj3/src/main/docbkx/install-guide/chap-install-cli.xml | 63 +++++++++++++++------
9 files changed, 124 insertions(+), 50 deletions(-)
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-connection-handlers.xml b/opendj3/src/main/docbkx/admin-guide/chap-connection-handlers.xml
index a694f61..833cd9f 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-connection-handlers.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-connection-handlers.xml
@@ -912,8 +912,9 @@
xlink:href="admin-guide#appendix-rest2ldap"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>REST LDAP
Configuration</citetitle></link>. The default mapping works out of the box
- with default Example.com data and with <link xlink:show="new"
- xlink:href="http://opendj.forgerock.org/Example.ldif">Example.ldif</link>.</para>
+ with Example.com data generated as part of the setup process and with
+ <link xlink:show="new" xlink:href="http://opendj.forgerock.org/Example.ldif"
+ >Example.ldif</link>.</para>
<step>
<para>Enable the connection handler.</para>
@@ -1312,4 +1313,13 @@
</step>
</procedure>
</section>
+
+ <section xml:id="snmp-access">
+ <title>SNMP Access</title>
+
+ <para>For instructions on setting up the SNMP Connection Handler, see the
+ section, <link xlink:href="admin-guide#snmp-monitoring"
+ xlink:role="http://docbook.org/xlink/role/olink"><citetitle>SNMP-Based
+ Monitoring</citetitle></link>.</para>
+ </section>
</chapter>
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-rest-operations.xml b/opendj3/src/main/docbkx/admin-guide/chap-rest-operations.xml
index f6deb60..d219328 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-rest-operations.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-rest-operations.xml
@@ -874,8 +874,7 @@
<literal>_action=create</literal> in the query string, and the JSON content of
your resource.</para>
- <para>The following example creates a new user entry. Lines are folded for
- readability.</para>
+ <para>The following example creates a new user entry.</para>
<screen width="82">$ curl
--request POST
@@ -950,9 +949,6 @@
<listitem>
<para>You can build filters using the following comparison expressions.</para>
- <para>Request URLs are folded in the following examples to make them
- easier to read.</para>
-
<variablelist>
<varlistentry>
<term><literal><replaceable>json-pointer</replaceable> eq <replaceable>json-value</replaceable></literal></term>
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-server-process.xml b/opendj3/src/main/docbkx/admin-guide/chap-server-process.xml
index 2995ab3..e473616 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-server-process.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-server-process.xml
@@ -62,7 +62,6 @@
<screen>$ sudo opendj/bin/create-rc-script
--outputFile /etc/init.d/opendj
--userName mark
-[sudo] password for mark:
$ sudo /etc/init.d/opendj start</screen>
<para>For example, on Linux if you run OpenDJ as root, you can use the
RC script to start the server at system boot, and stop the server at
@@ -112,7 +111,6 @@
<screen>$ sudo opendj/bin/create-rc-script
--outputFile /etc/init.d/opendj
--userName mark
-[sudo] password for mark:
$ sudo /etc/init.d/opendj stop</screen>
</listitem>
<listitem>
@@ -139,7 +137,6 @@
<screen>$ sudo opendj/bin/create-rc-script
--outputFile /etc/init.d/opendj
--userName mark
-[sudo] password for mark:
$ /etc/init.d/opendj restart</screen>
</listitem>
<listitem>
diff --git a/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml b/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
index 6974eeb..c5f6737 100644
--- a/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
+++ b/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
@@ -79,7 +79,7 @@
</varlistentry>
<varlistentry>
- <term>opendj_<?eval ${docTargetVersion}?>_all.deb</term>
+ <term>opendj_<?eval ${docTargetVersion}?>-1_all.deb</term>
<listitem>
<para>OpenDJ directory server native package for Debian and related
Linux distributions.</para>
@@ -87,7 +87,7 @@
</varlistentry>
<varlistentry>
- <term>opendj-<?eval ${docTargetVersion}?>.noarch.rpm</term>
+ <term>opendj-<?eval ${docTargetVersion}?>-1.noarch.rpm</term>
<listitem>
<para>OpenDJ directory server native package for Red Hat and related
Linux distributions.</para>
@@ -100,6 +100,12 @@
<para>Cross-platform OpenDJ DSML gateway web archive</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>opendj-rest2ldap-servlet-<?eval ${docTargetVersion}?>-servlet.war</term>
+ <listitem>
+ <para>Cross-platform OpenDJ REST LDAP gateway web archive</para>
+ </listitem></varlistentry>
</variablelist>
</step>
@@ -165,9 +171,17 @@
Java WebStart with a remote version of the software.</para>
<screen>$ /path/to/opendj/setup --cli
+READ THIS SOFTWARE LICENSE AGREEMENT CAREFULLY. BY DOWNLOADING OR INSTALLING
+THE FORGEROCK SOFTWARE, YOU, ON BEHALF OF YOURSELF AND YOUR COMPANY, AGREE TO
+BE BOUND BY THIS SOFTWARE LICENSE AGREEMENT. IF YOU DO NOT AGREE TO THESE
+TERMS, DO NOT DOWNLOAD OR INSTALL THE FORGEROCK SOFTWARE.
-OpenDJ <?eval ${docTargetVersion}?>
-Please wait while the setup program initializes...
+...
+
+Please read the License Agreement above.
+You must accept the terms of the agreement before continuing with the
+installation.
+Accept the license (Yes/No) [No]:Yes
What would you like to use as the initial root user DN for the Directory
Server? [cn=Directory Manager]:
@@ -349,7 +363,7 @@
<term>Start the server</term>
<listitem>
<para>If you do not start the server during installation, you can use
- the <command>bin/start-ds</command> command later.</para>
+ the <command>/path/to/opendj/bin/start-ds</command> command later.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -418,10 +432,10 @@
<step>
<para>Install the OpenDJ directory server package.</para>
- <screen>$ sudo dpkg -i opendj*.deb
+ <screen>$ sudo dpkg -i opendj_<?eval ${docTargetVersion}?>-1_all.deb
Selecting previously unselected package opendj.
(Reading database ... 185569 files and directories currently installed.)
-Unpacking opendj (from opendj_<?eval ${docTargetVersion}?>_all.deb) ...
+Unpacking opendj (from opendj_<?eval ${docTargetVersion}?>-1_all.deb) ...
Setting up opendj (<?eval ${docTargetVersion}?>) ...
$</screen>
@@ -438,7 +452,6 @@
<command>sudo /opt/opendj/setup</command>.</para>
<screen>$ sudo /opt/opendj/setup --cli
-[ sudo ] password for user:
...
To see basic server configuration status and configuration you can launch
/opt/opendj/bin/status</screen>
@@ -499,21 +512,29 @@
<para>On Red Hat and related Linux distributions such as Fedora and CentOS,
you can install OpenDJ directory server from the RPM package.</para>
+ <step>
+ <para>Log in as superuser to install the software.</para>
+
+ <screen>$ su
+Password:
+# </screen>
+ </step>
+
<step performance="optional">
<para>Before you install OpenDJ, install a Java runtime environment if none
is installed yet.</para>
- <screen>$ su
-Password:
-# rpm -ivh jdk-*.rpm</screen>
+ <para>You might need to download an .rpm to install the Java runtime
+ environment, and then install it using the <command>rpm</command>
+ command.</para>
+
+ <screen># rpm -ivh jre-*.rpm</screen>
</step>
<step>
<para>Install the OpenDJ directory server package.</para>
- <screen>$ su
-Password:
-# rpm -i opendj*.rpm
+ <screen># rpm -i opendj-<?eval ${docTargetVersion}?>-1.noarch.rpm
Pre Install - initial install
Post Install - initial install
@@ -636,8 +657,9 @@
<screen>$ cat /net/install/dj/1/setup.sh
#!/bin/sh
-unzip -d /path/to /net/install/dj/OpenDJ-<?eval ${docTargetVersion}?> && cd /path/to/opendj
-./setup --cli --propertiesFilePath /net/install/dj/1/setup.props --no-prompt</screen>
+unzip -d /path/to /net/install/dj/OpenDJ-<?eval ${docTargetVersion}?>.zip && cd /path/to/opendj
+./setup --cli --propertiesFilePath /net/install/dj/1/setup.props \
+ --acceptLicense --no-prompt</screen>
</step>
<step>
@@ -651,9 +673,14 @@
inflating: /path/to/opendj/uninstall
inflating: /path/to/opendj/upgrade
-OpenDJ <?eval ${docTargetVersion}?>
-Please wait while the setup program initializes...
+READ THIS SOFTWARE LICENSE AGREEMENT CAREFULLY. BY DOWNLOADING OR INSTALLING
+THE FORGEROCK SOFTWARE, YOU, ON BEHALF OF YOURSELF AND YOUR COMPANY, AGREE TO
+BE BOUND BY THIS SOFTWARE LICENSE AGREEMENT. IF YOU DO NOT AGREE TO THESE
+TERMS, DO NOT DOWNLOAD OR INSTALL THE FORGEROCK SOFTWARE.
+...
+
+Do you accept the License Agreement?yes
See /var/folders/.../opendj-setup-....log for a detailed log of this operation.
Configuring Directory Server ..... Done.
diff --git a/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml b/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
index d5e57db..56b46de 100644
--- a/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
+++ b/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
@@ -71,7 +71,7 @@
<para>The WebStart installer corresponds to what you start if you download
OpenDJ-<?eval ${docTargetVersion}?>.zip, unzip the file, and then run
- <command>./opendj/setup</command> (UNIX), <command>opendj\setup.bat</command>
+ <command>opendj/setup</command> (UNIX), <command>opendj\setup.bat</command>
(Windows), or <command>opendj/QuickSetup.app</command> (Mac OS X).</para>
<para>Java WebStart launches the the QuickSetup wizard, and soon the
diff --git a/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml b/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
index a454634..7206379 100644
--- a/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
+++ b/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
@@ -56,7 +56,7 @@
</step>
<step>
- <para>In order to revert should the upgrade fail, make sure you perform a
+ <para>In order to revert if the upgrade fails, make sure you perform a
full backup of your current OpenDJ installation.</para>
<para>It might be most expedient to back up the file system directory where
@@ -73,7 +73,7 @@
<title>To Upgrade an OpenDJ Directory Server</title>
<para>To upgrade OpenDJ directory server installed from native packages (.deb,
- .rpm), use the package management tools provided by the system.</para>
+ .rpm), use the command-line package management tools provided by the system.</para>
<para>The following steps describe how to upgrade OpenDJ directory server
installed from the cross-platform (.zip) delivery.</para>
@@ -115,7 +115,8 @@
<para>By default, the <command>upgrade</command> command requests
confirmation before making important configuration changes. You can use
the <option>--no-prompt</option> option to run the command
- non-interactively.</para>
+ non-interactively, with the <option>--acceptLicense</option> option to
+ accept the license terms non-interactively.</para>
<para>When using the <option>--no-prompt</option> option, if the
<command>upgrade</command> command cannot complete because it requires
diff --git a/opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml b/opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml
index 316d2a7..63acf2d 100644
--- a/opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml
+++ b/opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml
@@ -113,7 +113,7 @@
<para>Microsoft Windows Server 2008 R2 and Windows Server 2012</para>
</listitem>
<listitem>
- <para>Oracle Solaris 11</para>
+ <para>Oracle Solaris 11 x86</para>
</listitem>
</itemizedlist>
@@ -149,7 +149,7 @@
<para>OpenDJ DSML gateway has been validated on Apache Tomcat 6 and 7.</para>
<para>OpenDJ REST LDAP gateway has been validated on Apache Tomcat 6 and
- Jetty 7.</para>
+ Jetty 8.</para>
</section>
<section xml:id="prerequisites-fqdn">
diff --git a/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml b/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
index 2c907ab..bfdf971 100644
--- a/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
+++ b/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
@@ -49,19 +49,23 @@
OpenDJ <?eval ${docTargetVersion}?></citetitle></link> for
instructions.</para>
</listitem>
+
<listitem>
<para>The default DB cache size is now 50%, rather than 10%.</para>
<para>If you have multiple backends, configure cache sizes
accordingly.</para>
</listitem>
+
<listitem>
<para>The number of LDAP request handlers now defaults to half the CPU
count.</para>
</listitem>
+
<listitem>
<para>The replication purge delay default has increased from one day to
three days.</para>
</listitem>
+
<listitem>
<para>Syntax checking has been added for certificate and country attribute
values. This affects applications updating those attribute values.
@@ -71,22 +75,46 @@
3166</link> such as <literal>US</literal> instead of full names such as
<literal>United States</literal>.</para>
</listitem>
+
<listitem>
- <para>OpenDJ directory server now allows any client to use the LDAP
- Permissive Modify Request control, <literal>1.2.840.113556.1.4.1413</literal>,
- by default for newly installed servers.</para>
+ <para>The following global ACI settings have changed.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>OpenDJ directory server now allows any client to use the LDAP
+ Permissive Modify Request control, <literal>1.2.840.113556.1.4.1413</literal>,
+ by default for newly installed servers.</para>
+ </listitem>
+
+ <listitem>
+ <para>The "Anonymous read access" global ACI has changed. The list of
+ attributes that are not allowed has been changed to add
+ <literal>includedAttributes</literal> and to remove
+ <literal>targetUniqueID</literal>.</para>
+ </listitem>
+ </itemizedlist>
<para>When you upgrade from earlier versions of OpenDJ, however, the
- previous <literal>global-aci</literal> setting that governs this behavior
- is not updated. To apply the change manually, change the relevant
- <literal>global-aci</literal> by using the <command>dsconfig</command>
- command. An example of how to change a <literal>global-aci</literal>
- property can be found in the <citetitle>Administration Guide</citetitle>,
- <link xlink:show="new"
+ previous <literal>global-aci</literal> settings are not updated. To apply
+ the changes manually, change the relevant <literal>global-aci</literal>
+ settings by using the <command>dsconfig</command> command. An example of
+ how to change a <literal>global-aci</literal> property can be found in the
+ <citetitle>Administration Guide</citetitle>, <link xlink:show="new"
xlink:href="admin-guide#access-control-disable-anonymous"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>ACI: Disable
Anonymous Access</citetitle></link>.</para>
</listitem>
+
+ <listitem>
+ <para>For the SNMP, the default <literal>security-agent-file</literal> has
+ changed to <filename>opendj-snmp.security</filename> (<link xlink:show="new"
+ xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-982"
+ >OPENDJ-982</link>), and the upgrade process changes the file name. If the
+ SNMP Connection Handler fails to start after upgrade, use the
+ <command>dsconfig</command> command to make sure that the
+ <literal>security-agent-file</literal> property is correctly set for your
+ installation.</para>
+ </listitem>
</itemizedlist>
<!-- Not yet for OpenDJ 2.6.0.
@@ -122,7 +150,7 @@
<section xml:id="removed-functionality">
<title>Removed Functionality</title>
- <para>Native packages in SVR4 format for Solaris are no longer provided at
- this time.</para>
+ <para>Native packages in SVR4 format for Solaris are not provided at this
+ time.</para>
</section>
</chapter>
diff --git a/opendj3/src/main/docbkx/shared/screen-upgrade.xml b/opendj3/src/main/docbkx/shared/screen-upgrade.xml
index 65ed117..494da88 100644
--- a/opendj3/src/main/docbkx/shared/screen-upgrade.xml
+++ b/opendj3/src/main/docbkx/shared/screen-upgrade.xml
@@ -34,20 +34,32 @@
... msg=The backend userRoot is now taken offline
... msg=The Directory Server is now stopped
$ zip -rq OpenDJ-backup.zip OpenDJ-2.4.5
-$ unzip -q ~/Downloads/OpenDJ-<?eval ${docTargetVersion}?>.zip
+$ unzip -q ~/Downloads/OpenDJ-2.6.0.zip
$ cp -r opendj/* OpenDJ-2.4.5/
$ rm -rf opendj
$ mv OpenDJ-2.4.5 opendj
-$ ./opendj/upgrade --no-prompt
+$ ./opendj/upgrade --no-prompt --acceptLicense
>>>> OpenDJ Upgrade Utility
- * OpenDJ will be upgraded from version 2.4.5.7743 to <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable>
+ * OpenDJ will be upgraded from version 2.4.5.7743 to 2.6.0.9086
* See '/path/to/opendj/upgrade.log' for a detailed log of this operation
+READ THIS SOFTWARE LICENSE AGREEMENT CAREFULLY. BY DOWNLOADING OR INSTALLING
+THE FORGEROCK SOFTWARE, YOU, ON BEHALF OF YOURSELF AND YOUR COMPANY, AGREE TO
+BE BOUND BY THIS SOFTWARE LICENSE AGREEMENT. IF YOU DO NOT AGREE TO THESE
+TERMS, DO NOT DOWNLOAD OR INSTALL THE FORGEROCK SOFTWARE.
+
+ ...
+
+Please read the License Agreement above.
+You must accept the terms of the agreement before continuing with the
+installation
+Do you accept the License Agreement? yes
+
>>>> Preparing to upgrade
- OpenDJ <?eval ${docTargetVersion}?> modified the default configuration of the 'isMemberOf' virtual
+ OpenDJ 2.5.0 modified the default configuration of the 'isMemberOf' virtual
attribute so that it is included with group entries. This was done in order
to make it easier for users to determine which groups a 'nested' group
belongs to.
@@ -61,6 +73,7 @@
Fixing de-DE collation matching rule OID............................ 100%
Updating password policy configurations............................. 100%
Updating audit log publisher configuration.......................... 100%
+ Rename SNMP security config file.................................... 100%
Adding 'etag' virtual attribute schema.............................. 100%
Configuring 'etag' virtual attribute................................ 100%
Configuring 'ds-pwp-password-expiration-time' virtual attribute..... 100%
@@ -74,10 +87,12 @@
Adding 'http-config.json' configuration file........................ 100%
Adding HTTP connection handler configuration........................ 100%
Adding file-based HTTP access logger................................ 100%
+ Adding 'emailAddress' attribute..................................... 100%
+ Updating subject attribute to user attribute configuration.......... 100%
Replacing schema file '02-config.ldif'.............................. 100%
Archiving concatenated schema....................................... 100%
->>>> OpenDJ was successfully upgraded from version 2.4.5.7743 to <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable>
+>>>> OpenDJ was successfully upgraded from version 2.4.5.7743 to 2.6.0.9086
* See '/path/to/opendj/upgrade.log' for a detailed log of this operation
$ ./opendj/bin/start-ds --quiet
--
Gitblit v1.10.0