From ca3d973e81f4e41a9eae460733bc3c1ab675d972 Mon Sep 17 00:00:00 2001
From: Maxim Thomas <maxim.thomas@gmail.com>
Date: Fri, 07 Feb 2025 06:26:56 +0000
Subject: [PATCH] Documentation update (#480)
---
opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc | 67 +++++------
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-troubleshooting.adoc | 7
opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc | 9
opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-upgrade.adoc | 250 ++---------------------------------------
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc | 9
5 files changed, 61 insertions(+), 281 deletions(-)
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc
index 596b8a5..39a21e5 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc
@@ -18,6 +18,7 @@
:figure-caption!:
:example-caption!:
:table-caption!:
+:opendj-version: 4.9.2
[#chap-monitoring]
@@ -149,10 +150,10 @@
----
Use a command such as `snmpwalk` to check that the SNMP listen port works:
-[source, console]
+[source, console, subs="attributes"]
----
$ snmpwalk -v 2c -c OpenDJ@OpenDJ localhost:11161
-SNMPv2-SMI::mib-2.66.1.1.1.1 = STRING: "OpenDJ 3.5.3..."
+SNMPv2-SMI::mib-2.66.1.1.1.1 = STRING: "OpenDJ {opendj-version}..."
SNMPv2-SMI::mib-2.66.1.1.2.1 = STRING: "/path/to/opendj"
...
----
@@ -247,7 +248,7 @@
The `status` command takes administrative credentials to read the configuration, as does the control panel:
-[source, console]
+[source, console, subs="attributes"]
----
$ status --bindDN "cn=Directory Manager" --bindPassword password
@@ -259,7 +260,7 @@
Host Name: localhost
Administrative Users: cn=Directory Manager
Installation Path: /path/to/opendj
-Version: OpenDJ 3.5.3
+Version: OpenDJ {opendj-version}
Java Version: version
Administration Connector: Port 4444 (LDAPS)
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-troubleshooting.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-troubleshooting.adoc
index bec56c5..c1e3049 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-troubleshooting.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-troubleshooting.adoc
@@ -12,12 +12,13 @@
information: "Portions copyright [year] [name of copyright owner]".
Copyright 2017 ForgeRock AS.
- Portions Copyright 2024 3A Systems LLC.
+ Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
:example-caption!:
:table-caption!:
+:opendj-version: 4.9.2
[#chap-troubleshooting]
@@ -787,10 +788,10 @@
When you cannot resolve a problem yourself, and want to ask for help, clearly identify the problem and how you reproduce it, and also the version of OpenDJ you use to reproduce the problem. The version includes both a version number and also a build time stamp:
-[source, console]
+[source, console, subs="attributes"]
----
$ dsconfig --version
-OpenDJ 3.5.3
+OpenDJ {opendj-version}
Build yyyymmddhhmmssZ
----
Be ready to provide the following additional information:
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc b/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc
index f8d3db6..3ad6e71 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc
@@ -18,6 +18,7 @@
:figure-caption!:
:example-caption!:
:table-caption!:
+:opendj-version: 4.9.2
[#chap-install]
@@ -65,32 +66,26 @@
. Download software releases from the link:https://github.com/OpenIdentityPlatform/OpenDJ/releases[GitHub, window=\_blank].
+
--
-The following OpenDJ 3.5.3 server software is available:
+The following OpenDJ {opendj-version} server software is available:
-opendj-3.5.3.zip,opendj-oem-3.5.3.zip (OEM Edition)::
+opendj-{opendj-version}.zip::
Cross-platform OpenDJ directory server installation files.
-opendj_3.5.3-1_all.deb,opendj-oem_3.5.3-1_all.deb (OEM Edition)::
+opendj_{opendj-version}-1_all.deb::
OpenDJ directory server native package for Debian and related Linux distributions.
-opendj-3.5.3-1.noarch.rpm,opendj-oem-3.5.3-1.noarch.rpm (OEM Edition)::
+opendj-{opendj-version}-1.noarch.rpm::
OpenDJ directory server native package for Red Hat and related Linux distributions.
-opendj-dsml-servlet-3.5.3.war::
+org.openidentityplatform.opendj.opendj-dsml-servlet.war::
Cross-platform OpenDJ DSML gateway web archive
-opendj-rest2ldap-servlet-3.5.3.war::
+org.openidentityplatform.opendj.opendj-rest2ldap-servlet.war::
Cross-platform OpenDJ REST to LDAP gateway web archive
--
+
-[NOTE]
-======
-The OEM distribution of OpenDJ directory server does not include Berkeley DB Java Edition, and so does not support JE backends.
-======
-+
-
. If you plan to install OpenDJ DSML gateway or OpenDJ REST to LDAP gateway, make sure you have an appropriate application server installed.
+
@@ -113,9 +108,9 @@
======
After completing the steps in xref:#before-you-install["To Prepare For Installation"], follow these steps:
-. Unzip opendj-3.5.3.zip, and then run the `setup` command, described in xref:../reference/admin-tools-ref.adoc#setup-1[setup(1)] in the __Reference__.
+. Unzip opendj-{opendj-version}.zip, and then run the `setup` command, described in xref:../reference/admin-tools-ref.adoc#setup-1[setup(1)] in the __Reference__.
+
-When you unzip `opendj-3.5.3.zip`, a top-level `opendj` directory is created in the directory where you unzipped the file. On Windows systems if you unzip `opendj-3.5.3.zip`, with Right-Click > Extract All, be sure to remove the trailing `opendj-3.5.3` directory from the folder you specify.
+When you unzip `opendj-{opendj-version}.zip`, a top-level `opendj` directory is created in the directory where you unzipped the file. On Windows systems if you unzip `opendj-{opendj-version}.zip`, with Right-Click > Extract All, be sure to remove the trailing `opendj-{opendj-version}` directory from the folder you specify.
+
Find the `setup` command in the following locations:
@@ -203,11 +198,11 @@
====
The OpenDJ `setup --cli` command launches a command-line installation that is interactive by default. After completing the steps in xref:#before-you-install["To Prepare For Installation"], follow these steps:
-. Unzip `opendj-3.5.3.zip` in the file system directory where you want to install the server.
+. Unzip `opendj-{opendj-version}.zip` in the file system directory where you want to install the server.
+
The `setup` command, described in xref:../reference/admin-tools-ref.adoc#setup-1[setup(1)] in the __Reference__, uses the directory where you unzipped the files as the installation directory, and does not ask you where to install OpenDJ directory server. Therefore, if you want to install elsewhere on the file system, unzip the files in that location.
+
-When you unzip `opendj-3.5.3.zip`, a top-level `opendj` directory is created in the directory where you unzipped the file. On Windows systems if you unzip `opendj-3.5.3.zip`, with Right-Click > Extract All, be sure to remove the trailing `opendj-3.5.3` directory from the folder you specify.
+When you unzip `opendj-{opendj-version}.zip`, a top-level `opendj` directory is created in the directory where you unzipped the file. On Windows systems if you unzip `opendj-{opendj-version}.zip`, with Right-Click > Extract All, be sure to remove the trailing `opendj-{opendj-version}` directory from the folder you specify.
. Run the `setup --cli` command found in the `/path/to/opendj` directory.
+
@@ -386,7 +381,7 @@
. Run the `status` command, described in xref:../reference/admin-tools-ref.adoc#status-1[status(1)] in the __Reference__, to make sure your OpenDJ server is working as expected as shown in the following example:
+
-[source, console]
+[source, console, subs="attributes"]
----
$ /path/to/opendj/bin/status
@@ -404,7 +399,7 @@
Host Name: opendj.example.com
Administrative Users: cn=Directory Manager
Installation Path: /path/to/opendj
-Version: OpenDJ 3.5.3
+Version: OpenDJ {opendj-version}
Java Version: version
Administration Connector: Port 4444 (LDAPS)
@@ -448,14 +443,14 @@
. Install the OpenDJ directory server package:
+
-[source, console]
+[source, console, subs="attributes"]
----
-$ sudo dpkg -i opendj_3.5.3-1_all.deb
+$ sudo dpkg -i opendj_{opendj-version}-1_all.deb
Selecting previously unselected package opendj.
(Reading database ... 185569 files and directories currently installed.)
-Unpacking opendj (from opendj_3.5.3-1_all.deb) ...
+Unpacking opendj (from opendj_{opendj-version}-1_all.deb) ...
-Setting up opendj (3.5.3) ...
+Setting up opendj ({opendj-version}) ...
Adding system startup for /etc/init.d/opendj ...
/etc/rc0.d/K20opendj -> ../init.d/opendj
/etc/rc1.d/K20opendj -> ../init.d/opendj
@@ -487,10 +482,10 @@
. (Optional) Check OpenDJ directory server status:
+
-[source, console]
+[source, console, subs="attributes"]
----
$ service opendj status
-$opendj status: > Running.
+opendj status: > Running.
$ sudo /opt/opendj/bin/status
@@ -508,7 +503,7 @@
Host Name: ubuntu.example.com
Administrative Users: cn=Directory Manager
Installation Path: /opt/opendj
-Version: OpenDJ 3.5.3
+Version: OpenDJ {opendj-version}
Java Version: version
Administration Connector: Port 4444 (LDAPS)
@@ -559,9 +554,9 @@
. Install the OpenDJ directory server package:
+
-[source, console]
+[source, console, subs="attributes"]
----
-# rpm -i opendj-3.5.3-1.noarch.rpm
+# rpm -i opendj-{opendj-version}-1.noarch.rpm
Pre Install - initial install
Post Install - initial install
@@ -586,7 +581,7 @@
. (Optional) Check OpenDJ directory server status:
+
-[source, console]
+[source, console, subs="attributes"]
----
# service opendj status
opendj status: > Running.
@@ -607,7 +602,7 @@
Host Name: fedora.example.com
Administrative Users: cn=Directory Manager
Installation Path: /opt/opendj
-Version: OpenDJ 3.5.3
+Version: OpenDJ {opendj-version}
Java Version: version
Administration Connector: Port 4444 (LDAPS)
@@ -688,12 +683,12 @@
. Prepare an installation script:
+
-[source, console]
+[source, console, subs="attributes"]
----
$ cat /net/install/dj/1/setup.sh
#!/bin/sh
-unzip -d /path/to /net/install/dj/opendj-3.5.3.zip && cd /path/to/opendj
+unzip -d /path/to /net/install/dj/opendj-{opendj-version}.zip && cd /path/to/opendj
./setup --cli --propertiesFilePath /net/install/dj/1/setup.props \
--acceptLicense --no-prompt
----
@@ -743,10 +738,10 @@
. Run your installation script:
+
-[source, console]
+[source, console, subs="attributes"]
----
$ /net/install/dj/1/setup.sh
-Archive: /net/install/dj/opendj-3.5.3.zip
+Archive: /net/install/dj/opendj-{opendj-version}.zip
creating: /path/to/opendj
...
inflating: /path/to/opendj/setup
@@ -977,7 +972,7 @@
--
Follow these steps to install the OpenDJ REST to LDAP gateway:
-. Deploy `opendj-rest2ldap-servlet-3.5.3.war` according to the instructions for your application server.
+. Deploy `org.openidentityplatform.opendj.opendj-rest2ldap-servlet.war` according to the instructions for your application server.
. Edit the configuration files in the deployed gateway web application.
+
@@ -1062,7 +1057,7 @@
======
You configure the gateway to access your directory service by editing the configuration file `opendj-rest2ldap-servlet.json` in the deployed OpenDJ REST to LDAP gateway web application:
-. Deploy `opendj-rest2ldap-servlet-3.5.3-servlet.war` according to the instructions for your application server.
+. Deploy `org.openidentityplatform.opendj.opendj-rest2ldap-servlet.war` according to the instructions for your application server.
. Edit `opendj-rest2ldap-servlet.json` where you deployed the gateway web application.
+
@@ -1121,7 +1116,7 @@
====
The OpenDJ DSML gateway functions as a web application in a web application container. The DSML gateway runs independently of OpenDJ directory server. You configure the gateway to access your directory service by editing the `ldap.host` and `ldap.port` parameters in the gateway `WEB-INF/web.xml` configuration file:
-. Deploy `opendj-dsml-servlet-3.5.3.war` according to the instructions for your application server.
+. Deploy `org.openidentityplatform.opendj.opendj-dsml-servlet.war` according to the instructions for your application server.
. Edit `WEB-INF/web.xml` to ensure the values for `ldap.host` and `ldap.port` are correct.
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-upgrade.adoc b/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-upgrade.adoc
index 189c413..a315324 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-upgrade.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-upgrade.adoc
@@ -18,10 +18,11 @@
:figure-caption!:
:example-caption!:
:table-caption!:
+:opendj-version: 4.9.2
[#chap-upgrade]
-== Upgrading to OpenDJ 3.5
+== Upgrading to OpenDJ 4.9
This chapter covers upgrade from previous versions.
@@ -39,13 +40,9 @@
* xref:#before-you-upgrade["Before You Upgrade"]
-* xref:#upgrade-zip["To Upgrade to OpenDJ 3.5"]
+* xref:#upgrade-zip["To Upgrade to OpenDJ 4.9"]
-* xref:#upgrade-zip-example["Upgrading to OpenDJ 3.5"]
-
-* xref:#upgrade-je-pdb["To Upgrade to OpenDJ OEM Edition"]
-
-* xref:#upgrade-je-pdb-example["Upgrading To OpenDJ OEM Edition"]
+* xref:#upgrade-zip-example["Upgrading to OpenDJ 4.9"]
* xref:#upgrade-repl["To Upgrade Replicated Servers"]
@@ -64,13 +61,11 @@
+
Make sure you have the credentials to run commands as the user who owns the server.
-. (Optional) If OpenDJ directory server runs with Java 6, move to a newer version before continuing the upgrade process.
+. (Optional) If OpenDJ directory server runs with Java 6, move to a newer version, at least Java 8, before continuing the upgrade process.
+
To move to a newer version, edit the `default.java-home` setting in the `opendj/config/java.properties` file, and then run the `dsjavaproperties` command.
-. (Optional) If you are upgrading to OpenDJ OEM edition from OpenDJ 2.6, make sure there is enough disk space to export all of the data to LDIF files.
-
-. Download enterprise releases from the link:https://github.com/OpenIdentityPlatform/OpenDJ/releases[GitHub, window=\_blank] site.
+. Download the latest release from the link:https://github.com/OpenIdentityPlatform/OpenDJ/releases[GitHub, window=\_blank] site.
. (Optional) If you are upgrading OpenDJ directory server on Windows, and OpenDJ is registered as a Windows service, disable OpenDJ as a Windows service before upgrade, as in the following example:
+
@@ -89,10 +84,8 @@
====
[#upgrade-zip]
-.To Upgrade to OpenDJ 3.5
+.To Upgrade to OpenDJ 4.9
====
-If you are upgrading to the OEM edition from OpenDJ 2.6, then this procedure does not apply. Skip instead to xref:#upgrade-je-pdb["To Upgrade to OpenDJ OEM Edition"].
-
Before starting this procedure, follow the steps in xref:#before-you-upgrade["Before You Upgrade"].
To upgrade to OpenDJ directory server installed from native packages (.deb, .rpm), use the command-line package management tools provided by the system.
@@ -128,7 +121,7 @@
[NOTE]
======
-When you upgrade to OpenDJ 3.5 from an OpenDJ 3 or earlier, the upgrade procedure leaves the HTTP connection handler disabled.
+When you upgrade to OpenDJ 4.9 from an OpenDJ 3 or earlier, the upgrade procedure leaves the HTTP connection handler disabled.
The newer configuration supports inheritance and subsresources, but is not compatible with the previous configuration.
You must rewrite your configuration to the version described in xref:../reference/appendix-rest2ldap.adoc#appendix-rest2ldap["REST to LDAP Configuration"] in the __Reference__, and then reconfigure the server to use the new configuration. For details, see xref:../admin-guide/chap-connection-handlers.adoc#setup-rest2ldap["RESTful Client Access Over HTTP"] in the __Administration Guide__.
======
@@ -144,11 +137,11 @@
====
[#upgrade-zip-example]
-.Upgrading to OpenDJ 3.5
+.Upgrading to OpenDJ 4.9
====
The following example upgrades an OpenDJ 2.6.3 directory server, backing up the current server directory in case the upgrade process fails. In this example, the server properties are updated to use Java 8, and the Local DB backend is migrated to a JE backend:
-[source, console]
+[source, console, subs="attributes"]
----
$ cd /path/to/
$ sed -e "s/default.java-home=.*/default.java-home=\/path\/to\/jdk1.8/" \
@@ -159,29 +152,29 @@
$ /path/to/opendj/bin/stop-ds --quiet
... msg=The Directory Server is now stopped
$ zip -rq OpenDJ-backup.zip opendj/
-$ unzip -o ~/Downloads/opendj-3.5.3.zip
+$ unzip -o ~/Downloads/opendj-{opendj-version}.zip
$ /path/to/opendj/upgrade --acceptLicense
>>>> OpenDJ Upgrade Utility
* OpenDJ will be upgraded from version 2.6.3.12667 to
- 3.5.3.build-hash
+ {opendj-version}.build-hash
* See '/path/to/opendj/upgrade.log' for a detailed log of this operation
>>>> Preparing to upgrade
- OpenDJ 3.5.3 introduced changes to the JE backend configuration and database
+ OpenDJ {opendj-version} introduced changes to the JE backend configuration and database
format. The upgrade will update all JE backend configurations, but will only
migrate JE backend databases which are associated with *enabled* JE
backends. It is very strongly recommended that any existing data has been
backed up and that you have read the upgrade documentation before
proceeding. Do you want to proceed with the upgrade? (yes/no) [no]: yes
- OpenDJ 3.5.3 changed the matching rule implementations. All indexes have to
+ OpenDJ {opendj-version} changed the matching rule implementations. All indexes have to
be rebuilt. This could take a long time to proceed. Do you want to launch
this process automatically at the end of the upgrade? (yes/no) [no]: yes
- OpenDJ 3.5.3 improved the replication changelog storage format. As a
+ OpenDJ {opendj-version} improved the replication changelog storage format. As a
consequence, the old changelog content of the current replication server
will be erased by the upgrade. The new changelog content will be
automatically reconstructed from the changelog of other replication servers
@@ -233,7 +226,7 @@
Archiving concatenated schema....................................... 100%
>>>> OpenDJ was successfully upgraded from version 2.6.3.12667 to
-3.5.3.build-hash
+4.9.1.build-hash
>>>> Performing post upgrade tasks
@@ -249,217 +242,6 @@
----
====
-[#upgrade-je-pdb]
-.To Upgrade to OpenDJ OEM Edition
-====
-If you are not upgrading to the OEM edition from OpenDJ 2.6, then this procedure does not apply. Skip instead to xref:#upgrade-zip["To Upgrade to OpenDJ 3.5"].
-
-Before starting this procedure, follow the steps in xref:#before-you-upgrade["Before You Upgrade"].
-
-[NOTE]
-======
-OpenDJ directory server backend storage options have changed since OpenDJ 2.6. The underlying implementation is based on an extensible architecture, allowing you to choose the backend storage type when you create a persistent backend for directory data.
-
-This procedure applies when you upgrade to the OEM edition from OpenDJ 2.6, changing the underlying backend storage. The configuration changes from a Local DB backend to a PDB Backend, but the `upgrade` command in this version __deletes the data from OpenDJ directory server__. Follow the instructions in this procedure to avoid data loss.
-======
-Follow these steps:
-
-. Login as the user who owns the current OpenDJ server.
-
-. Stop the current OpenDJ server.
-
-. Export all of the data to LDIF files.
-+
-OpenDJ directory server OEM edition uses a new backend type, PDB. This edition does not support the older Local DB backend type. The upgrade process transforms the configuration to use the new backend type, but it does not export and import directory data. You must export the data, unpack the files of the new version over the old, run the upgrade, and then import the data.
-+
-The following example exports Example.com data from the `userRoot` backend to an LDIF file:
-+
-
-[source, console]
-----
-$ export-ldif --backendID userRoot --ldifFile ../ldif/Example.ldif
-----
-
-. If you have not already backed up the current OpenDJ server, make a back up copy of the directory where OpenDJ is installed.
-
-. Unpack the new files over the current server files:
-+
-
-* When upgrading the .zip distribution, overwrite the current files.
-+
-The following example overwrites the current files with the new files:
-+
-
-[source, console]
-----
-$ cd /path/to ; unzip -o ~/Downloads/opendj-3.5.3.zip
-----
-
-* When upgrading native packaging, use the command-line package management tools provided by the system to remove the 2.6 package, and then install the new package.
-+
-For details, see xref:chap-uninstall.adoc#uninstall-deb["To Uninstall the Debian Package"] or xref:chap-uninstall.adoc#uninstall-rpm["To Uninstall the RPM Package"], and xref:chap-install.adoc#install-deb["To Install From the Debian Package"] or xref:chap-install.adoc#install-rpm["To Install From the RPM Package"].
-
-
-. Run the `upgrade` command to bring OpenDJ configuration and schema data up to date with the new binary and script files that replaced existing server files.
-+
-By default, the `upgrade` command requests confirmation before making important configuration changes. For some potentially long-duration tasks, such as rebuilding indexes, the default choice is to defer the tasks until after upgrade. Tasks that are not performed during upgrade must generally be performed after upgrade but before you restart the server.
-+
-You can use the `--no-prompt` option to run the command non-interactively, with the `--acceptLicense` option to accept the license terms non-interactively.
-+
-When using the `--no-prompt` option, if the `upgrade` command cannot complete because it requires confirmation for a potentially very long or critical task, then it exits with an error and a message about how to finish making the changes. You can add the `--force` option to force a non-interactive upgrade to continue in this case, also performing long running and critical tasks.
-+
-Once this step is complete, OpenDJ directory server no longer has access to user data that was stored in Local DB backends.
-
-. (Optional) If user data occupies significant disk space, and not enough disk space is available, then remove binary backups of the user data that you exported to LDIF.
-+
-The upgrade process moves old user backend data to `opendj/db/*.bak` directories. This old user backend data is not accessible after upgrade. You can remove the old user backend data as shown in the following example:
-+
-
-[source, console]
-----
-$ rm -rf /path/to/opendj/db/*.bak
-----
-
-. Import all of the data from LDIF files.
-+
-The following example imports Example.com data from an LDIF file to the `userRoot` backend:
-+
-
-[source, console]
-----
-$ cd opendj/bin ; import-ldif --backendID userRoot --ldifFile ../ldif/Example.ldif
-----
-+
-Make sure you perform this step __for all user data backends__.
-
-. Start the upgraded OpenDJ server.
-+
-Replication updates the upgraded server with changes that occurred during the upgrade process.
-+
-At this point the upgrade process is complete. See the resulting `upgrade.log` file for a full list of operations performed.
-
-====
-
-[#upgrade-je-pdb-example]
-.Upgrading To OpenDJ OEM Edition
-====
-The following example upgrades an OpenDJ 2.6.3 directory server to OpenDJ OEM edition, where the backend type for data storage is PDB. With the OEM edition, Local DB and JE backends are not supported. In this example, the server properties are updated to use Java 8, and the Local DB backend configuration is converted to use PDB backend. The directory data is exported to LDIF before upgrade, and imported from LDIF after upgrade:
-
-[source, console]
-----
-$ cd /path/to/
-$ sed -e "s/default.java-home=.*/default.java-home=\/path\/to\/jdk1.8/" \
- opendj/config/java.properties \
- > opendj/config/java.properties.new ; \
- mv opendj/config/java.properties.new opendj/config/java.properties
-$ /path/to/opendj/bin/dsjavaproperties
-$ /path/to/opendj/bin/stop-ds --quiet
-... msg=The Directory Server is now stopped
-$ /path/to/opendj/bin/export-ldif --backendID userRoot \
- --ldifFile opendj/ldif/Example.ldif
-$ zip -rq opendj-backup.zip opendj/
-$ unzip -o ~/Downloads/opendj-oem-3.5.3.zip
-$ /path/to/opendj/upgrade --acceptLicense
-
->>>> OpenDJ Upgrade Utility
-
- * OpenDJ will be upgraded from version 2.6.3.12667 to
- 3.5.3.build-hash
- * See '/path/to/opendj/upgrade.log' for a detailed log of this operation
-
->>>> Preparing to upgrade
-
- WARNING: OpenDJ 3.5.3 OEM Edition removes support for the Berkeley JE
- backend.
-
- The upgrade tool will reconfigure all JE backends as PDB backends.
-
- After the upgrade the new PDB backend(s) will be empty. It is therefore very
- strongly recommended that any data that was in the JE backends be exported
- to LDIF so that it can be re-imported once the upgrade completes.
-
- Do you want to make this configuration change? (yes/no) [no]: yes
-
- OpenDJ 3.5.3 changed the matching rule implementations. All indexes have to
- be rebuilt. This could take a long time to proceed. Do you want to launch
- this process automatically at the end of the upgrade? (yes/no) [no]: yes
-
- OpenDJ 3.5.3 improved the replication changelog storage format. As a
- consequence, the old changelog content of the current replication server
- will be erased by the upgrade. The new changelog content will be
- automatically reconstructed from the changelog of other replication servers
- in the topology. After the upgrade, dsreplication reset-change-number can be
- used to reset the changelog change-number of the current replication server
- to match another replication server. Do you want to proceed with the
- upgrade? (yes/no) [no]: yes
-
- The upgrade is ready to proceed. Do you wish to continue? (yes/no) [yes]:
-
-
->>>> Performing upgrade
-
- Changing matching rule for 'userCertificate' and 'caCertificate' to
- CertificateExactMatch............................................... 100%
- Configuring 'CertificateExactMatch' matching rule................... 100%
- Replacing schema file '03-pwpolicyextension.ldif'................... 100%
- Removing 'dc=replicationchanges' backend............................ 100%
- Removing ACI for 'dc=replicationchanges'............................ 100%
- Adding default privilege 'changelog-read' to all root DNs........... 100%
- Adding PKCS5S2 password storage scheme configuration................ 100%
- Rerunning dsjavaproperties.......................................... 100%
- Updating ds-cfg-java-class attribute in File-Based Debug Logger..... 100%
- Deleting ds-cfg-default-debug-level attribute in File-Based Debug
- Logger.............................................................. 100%
- Updating ds-cfg-default-severity attribute in File-Based Error
- Logger.............................................................. 100%
- Updating ds-cfg-override-severity attribute in Replication Repair
- Logger.............................................................. 100%
- Removing config for 'Network Groups'................................ 100%
- Removing config for 'Workflows'..................................... 100%
- Removing config for 'Workflow Elements'............................. 100%
- Removing config for 'Network Group Plugin'.......................... 100%
- Removing config for 'Extensions'.................................... 100%
- Removing config for 'File System Entry Cache'....................... 100%
- Removing config for 'Entry Cache Preload'........................... 100%
- Removing file '/path/to/opendj/bin/dsframework'..................... 100%
- Removing file '/path/to/opendj/bat/dsframework.bat'................. 100%
- Removing file '/path/to/opendj/lib/je.jar'.......................... 100%
- Renaming local-db backend directory '/path/to/opendj/db/userRoot'
- to '/path/to/opendj/db/userRoot.bak'................................ 100%
- Reconfiguring local-db backends to PDB backends..................... 100%
- Reconfiguring local-db backend indexes to PDB backend indexes....... 100%
- Reconfiguring local-db backend VLV indexes to PDB backend VLV
- indexes............................................................. 100%
- Removing file '/path/to/opendj/bin/dbtest'.......................... 100%
- Removing file '/path/to/opendj/bat/dbtest.bat'...................... 100%
- Removing content of changelog in '/path/to/opendj/./changelogDb'
- directory........................................................... 100%
- Enable log file based replication changelog storage................. 100%
- Replacing schema file '02-config.ldif'.............................. 100%
- Archiving concatenated schema....................................... 100%
-
->>>> OpenDJ was successfully upgraded from version 2.6.3.12667 to
-3.5.3.build-hash
-
-
->>>> Performing post upgrade tasks
-
- [!] You must reimport all your data into the PDB backends in order to have a
- fully functional server
- ...
-
->>>> Post upgrade tasks complete
-
- * See '/path/to/opendj/upgrade.log' for a detailed log of this operation
-
-$ /path/to/opendj/bin/import-ldif --backendID userRoot \
- --ldifFile opendj/ldif/Example.ldif
-$ /path/to/opendj/bin/start-ds --quiet
-# Optionally remove Local DB backup data:
-$ rm -rf /path/to/opendj/db/userRoot.bak/
-----
-====
-
[#upgrade-repl]
.To Upgrade Replicated Servers
====
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc b/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc
index 104e9ff..3bfd939 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc
@@ -18,6 +18,7 @@
:figure-caption!:
:example-caption!:
:table-caption!:
+:opendj-version: 4.9.2
[#chap-writing-plugins]
@@ -169,7 +170,7 @@
. Install the example plugin in OpenDJ directory server:
+
-[source, console]
+[source, console, subs="attributes"]
----
$ cd /path/to/opendj
@@ -181,7 +182,7 @@
# The following example works with bsdtar,
# which might require installing a bsdtar package.
$ bsdtar -xvf \
- /path/to/opendj-server-example-plugin/target/opendj-server-example-plugin-3.5.3.zip \
+ /path/to/opendj-server-example-plugin/target/opendj-server-example-plugin-{opendj-version}.zip \
-s'|[^/]*/||'
x README.example.plugin
x config/
@@ -190,7 +191,7 @@
x config/schema/99-example-plugin.ldif
x lib/
x lib/extensions/
-x lib/extensions/opendj-server-example-plugin-3.5.3.jar
+x lib/extensions/opendj-server-example-plugin-{opendj-version}.jar
x lib/extensions/...
# Start the server and create the plugin configuration:
@@ -209,7 +210,7 @@
--no-prompt
...
INFO: Loaded extension from file
- '/path/to/opendj/lib/extensions/opendj-server-example-plugin-3.5.3.jar'
+ '/path/to/opendj/lib/extensions/opendj-server-example-plugin-{opendj-version}.jar'
(build <unknown>, revision <unknown>)
----
+
--
Gitblit v1.10.0