From 60bfa27458182a94e723353bdceaf1d5a95e504f Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 28 May 2013 06:03:38 +0000
Subject: [PATCH] Fix for OPENDJ-947: Install Guide: some reference to 2.4.6 should be replaced with 2.4.5
---
opendj3/src/main/docbkx/install-guide/chap-upgrade.xml | 61 +--------------
opendj3/src/main/docbkx/shared/screen-upgrade.xml | 84 +++++++++++++++++++++
opendj3/src/main/docbkx/shared/man-upgrade.xml | 65 ----------------
opends/resource/man/man1/upgrade.1 | 17 ++-
4 files changed, 100 insertions(+), 127 deletions(-)
diff --git a/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml b/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
index 49dde97..4c5b8e5 100644
--- a/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
+++ b/opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
@@ -89,7 +89,7 @@
<step performance="optional">
<para>If OpenDJ is currently installed in a directory such as
- <filename>OpenDJ-2.4.6</filename>, you can change the directory name to
+ <filename>OpenDJ-2.4.5</filename>, you can change the directory name to
<filename>opendj</filename> to make it easier to unpack subsequent .zip
deliveries for future upgrades.</para>
</step>
@@ -132,66 +132,15 @@
</procedure>
<example xml:id="upgrade-zip-example"><?dbfo keep-together="auto"?>
- <title>Upgrading From OpenDJ 2.4.6</title>
+ <title>Upgrading From OpenDJ 2.4.5</title>
- <para>The following example upgrades an OpenDJ 2.4.6 directory server
- installed in <filename>/path/to/OpenDJ-2.4.6</filename>, backing up the
+ <para>The following example upgrades an OpenDJ 2.4.5 directory server
+ installed in <filename>/path/to/OpenDJ-2.4.5</filename>, backing up the
current server directory in case the upgrade process fails, and changing
the directory name to <filename>/path/to/opendj</filename> to simplify
future upgrades.</para>
- <screen>$ cd /path/to
-$ ls
-OpenDJ-2.4.6
-$ ./OpenDJ-2.4.6/bin/stop-ds --quiet
-... msg=The backend userRoot is now taken offline
-... msg=The Directory Server is now stopped
-$ zip -rq OpenDJ-backup.zip OpenDJ-2.4.6
-$ unzip -q ~/Downloads/OpenDJ-<?eval ${docTargetVersion}?>.zip
-$ cp -r opendj/* OpenDJ-2.4.6/
-$ rm -rf opendj
-$ mv OpenDJ-2.4.6 opendj
-$ ./opendj/upgrade --no-prompt
-
->>>> OpenDJ Upgrade Utility
-
- * OpenDJ will be upgraded from version 2.4.6.8102 to <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable>
- * See '/path/to/opendj/upgrade.log' for a detailed log of this operation
-
->>>> Preparing to upgrade
-
- OpenDJ <?eval ${docTargetVersion}?> 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.
- Do you want to make this configuration change? (yes/no) yes
-
- The upgrade is ready to proceed. Do you wish to continue? (yes/no) yes
-
-
->>>> Performing upgrade
-
- Fixing de-DE collation matching rule OID............................ 100%
- Updating password policy configurations............................. 100%
- Updating audit log publisher configuration.......................... 100%
- Adding 'etag' virtual attribute schema.............................. 100%
- Configuring 'etag' virtual attribute................................ 100%
- Configuring 'ds-pwp-password-expiration-time' virtual attribute..... 100%
- Updating certificate syntax configuration........................... 100%
- Updating JPEG syntax configuration.................................. 100%
- Updating country string syntax configuration........................ 100%
- Modifying filter in 'isMemberOf' virtual attribute configuration.... 100%
- Updating dictionary password validator configuration................ 100%
- Updating attribute value password validator configuration........... 100%
- Adding PBKDF2 password storage scheme configuration................. 100%
- Replacing schema file '02-config.ldif'.............................. 100%
- Archiving concatenated schema....................................... 100%
-
->>>> OpenDJ was successfully upgraded from version 2.4.6.8102 to <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable>
-
- * See '/path/to/opendj/upgrade.log' for a detailed log of this operation
-$ ./opendj/bin/start-ds --quiet
-$ </screen>
+ <xinclude:include href="../shared/screen-upgrade.xml" />
</example>
<procedure xml:id="upgrade-repl">
diff --git a/opendj3/src/main/docbkx/shared/man-upgrade.xml b/opendj3/src/main/docbkx/shared/man-upgrade.xml
index 3edb446..055b829 100644
--- a/opendj3/src/main/docbkx/shared/man-upgrade.xml
+++ b/opendj3/src/main/docbkx/shared/man-upgrade.xml
@@ -202,70 +202,7 @@
<para>The following example shows the upgrade process for OpenDJ directory
server installed from the cross-platform (.zip) delivery.</para>
- <!--
- Intentionally not using <?eval ${stableServerVersion}?> instead of 2.4.6:
-
- Once the ${stableServerVersion} has moved to the new file name,
- the directory names will change, so 2.4.6 is not a variable here,
- but instead an example that should be common for the first release
- with the new upgrade command.
-
- Perhaps people will forgive details missing in this upgrade that happened
- after the example was run.
- -->
-
- <screen>$ cd /path/to
-$ ls
-OpenDJ-2.4.6
-$ ./OpenDJ-2.4.6/bin/stop-ds --quiet
-... msg=The backend userRoot is now taken offline
-... msg=The Directory Server is now stopped
-$ zip -rq OpenDJ-backup.zip OpenDJ-2.4.6
-$ unzip -q ~/Downloads/OpenDJ-<?eval ${docTargetVersion}?>.zip
-$ cp -r opendj/* OpenDJ-2.4.6/
-$ rm -rf opendj
-$ mv OpenDJ-2.4.6 opendj
-$ ./opendj/upgrade --no-prompt
-
->>>> OpenDJ Upgrade Utility
-
- * OpenDJ will be upgraded from version 2.4.6.8102 to <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable>
- * See '/path/to/opendj/upgrade.log' for a detailed log of this operation
-
->>>> Preparing to upgrade
-
- OpenDJ <?eval ${docTargetVersion}?> 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.
- Do you want to make this configuration change? (yes/no) yes
-
- The upgrade is ready to proceed. Do you wish to continue? (yes/no) yes
-
-
->>>> Performing upgrade
-
- Fixing de-DE collation matching rule OID............................ 100%
- Updating password policy configurations............................. 100%
- Updating audit log publisher configuration.......................... 100%
- Adding 'etag' virtual attribute schema.............................. 100%
- Configuring 'etag' virtual attribute................................ 100%
- Configuring 'ds-pwp-password-expiration-time' virtual attribute..... 100%
- Updating certificate syntax configuration........................... 100%
- Updating JPEG syntax configuration.................................. 100%
- Updating country string syntax configuration........................ 100%
- Modifying filter in 'isMemberOf' virtual attribute configuration.... 100%
- Updating dictionary password validator configuration................ 100%
- Updating attribute value password validator configuration........... 100%
- Adding PBKDF2 password storage scheme configuration................. 100%
- Replacing schema file '02-config.ldif'.............................. 100%
- Archiving concatenated schema....................................... 100%
-
->>>> OpenDJ was successfully upgraded from version 2.4.6.8102 to <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable>
-
- * See '/path/to/opendj/upgrade.log' for a detailed log of this operation
-$ ./opendj/bin/start-ds --quiet
-$ </screen>
+ <xinclude:include href="screen-upgrade.xml" />
<para>Native packages (.deb, .rpm) perform more of the upgrade process,
stopping OpenDJ if it is running, overwriting older files with newer files,
diff --git a/opendj3/src/main/docbkx/shared/screen-upgrade.xml b/opendj3/src/main/docbkx/shared/screen-upgrade.xml
new file mode 100644
index 0000000..65ed117
--- /dev/null
+++ b/opendj3/src/main/docbkx/shared/screen-upgrade.xml
@@ -0,0 +1,84 @@
+<?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.
+ !
+ ! 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 2013 ForgeRock AS
+ !
+-->
+ <screen xml:id="upgrade-earliest-supported"
+ 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'
+>$ cd /path/to
+$ ls
+OpenDJ-2.4.5
+$ ./OpenDJ-2.4.5/bin/stop-ds --quiet
+... 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
+$ cp -r opendj/* OpenDJ-2.4.5/
+$ rm -rf opendj
+$ mv OpenDJ-2.4.5 opendj
+$ ./opendj/upgrade --no-prompt
+
+>>>> OpenDJ Upgrade Utility
+
+ * OpenDJ will be upgraded from version 2.4.5.7743 to <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable>
+ * See '/path/to/opendj/upgrade.log' for a detailed log of this operation
+
+>>>> Preparing to upgrade
+
+ OpenDJ <?eval ${docTargetVersion}?> 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.
+ Do you want to make this configuration change? (yes/no) yes
+
+ The upgrade is ready to proceed. Do you wish to continue? (yes/no) yes
+
+
+>>>> Performing upgrade
+
+ Fixing de-DE collation matching rule OID............................ 100%
+ Updating password policy configurations............................. 100%
+ Updating audit log publisher configuration.......................... 100%
+ Adding 'etag' virtual attribute schema.............................. 100%
+ Configuring 'etag' virtual attribute................................ 100%
+ Configuring 'ds-pwp-password-expiration-time' virtual attribute..... 100%
+ Updating certificate syntax configuration........................... 100%
+ Updating JPEG syntax configuration.................................. 100%
+ Updating country string syntax configuration........................ 100%
+ Modifying filter in 'isMemberOf' virtual attribute configuration.... 100%
+ Updating dictionary password validator configuration................ 100%
+ Updating attribute value password validator configuration........... 100%
+ Adding PBKDF2 password storage scheme configuration................. 100%
+ Adding 'http-config.json' configuration file........................ 100%
+ Adding HTTP connection handler configuration........................ 100%
+ Adding file-based HTTP access logger................................ 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>
+
+ * See '/path/to/opendj/upgrade.log' for a detailed log of this operation
+$ ./opendj/bin/start-ds --quiet
+$ </screen>
diff --git a/opends/resource/man/man1/upgrade.1 b/opends/resource/man/man1/upgrade.1
index ca8dcab..7eab236 100644
--- a/opends/resource/man/man1/upgrade.1
+++ b/opends/resource/man/man1/upgrade.1
@@ -197,20 +197,20 @@
.nf
$ cd /path/to
$ ls
-OpenDJ\-2\&.4\&.6
-$ \&./OpenDJ\-2\&.4\&.6/bin/stop\-ds \-\-quiet
+OpenDJ\-2\&.4\&.5
+$ \&./OpenDJ\-2\&.4\&.5/bin/stop\-ds \-\-quiet
\&.\&.\&. msg=The backend userRoot is now taken offline
\&.\&.\&. msg=The Directory Server is now stopped
-$ zip \-rq OpenDJ\-backup\&.zip OpenDJ\-2\&.4\&.6
+$ zip \-rq OpenDJ\-backup\&.zip OpenDJ\-2\&.4\&.5
$ unzip \-q ~/Downloads/OpenDJ\-2\&.6\&.0\&.zip
-$ cp \-r opendj/* OpenDJ\-2\&.4\&.6/
+$ cp \-r opendj/* OpenDJ\-2\&.4\&.5/
$ rm \-rf opendj
-$ mv OpenDJ\-2\&.4\&.6 opendj
+$ mv OpenDJ\-2\&.4\&.5 opendj
$ \&./opendj/upgrade \-\-no\-prompt
>>>> OpenDJ Upgrade Utility
- * OpenDJ will be upgraded from version 2\&.4\&.6\&.8102 to 2\&.6\&.0\&.\fIrevision\fR
+ * OpenDJ will be upgraded from version 2\&.4\&.5\&.7743 to 2\&.6\&.0\&.\fIrevision\fR
* See \*(Aq/path/to/opendj/upgrade\&.log\*(Aq for a detailed log of this operation
>>>> Preparing to upgrade
@@ -239,10 +239,13 @@
Updating dictionary password validator configuration\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100%
Updating attribute value password validator configuration\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100%
Adding PBKDF2 password storage scheme configuration\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100%
+ Adding \*(Aqhttp\-config\&.json\*(Aq configuration file\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100%
+ Adding HTTP connection handler configuration\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100%
+ Adding file\-based HTTP access logger\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100%
Replacing schema file \*(Aq02\-config\&.ldif\*(Aq\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100%
Archiving concatenated schema\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100%
->>>> OpenDJ was successfully upgraded from version 2\&.4\&.6\&.8102 to 2\&.6\&.0\&.\fIrevision\fR
+>>>> OpenDJ was successfully upgraded from version 2\&.4\&.5\&.7743 to 2\&.6\&.0\&.\fIrevision\fR
* See \*(Aq/path/to/opendj/upgrade\&.log\*(Aq for a detailed log of this operation
$ \&./opendj/bin/start\-ds \-\-quiet
--
Gitblit v1.10.0