description-upgrade.xml revision 73adb2e3dbaa8a9f6448cefccb7933f68c3c7348
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
! Copyright 2015 ForgeRock AS.
!
-->
<!--
This use of <informalexample> is mild tag abuse.
It serves as a single container element for all the elements here.
-->
<informalexample
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:schemaLocation='http://docbook.org/ns/docbook
<para>
This utility thus performs only part of the upgrade process,
which includes the following phases for a single server.
</para>
<orderedlist>
<listitem>
<para>
Get and unpack a newer version of OpenDJ directory server software.
</para>
</listitem>
<listitem>
<para>
Stop the current OpenDJ directory server.
</para>
</listitem>
<listitem>
<para>
Overwrite existing binary and script files with those of the newer version,
and then run this utility before restarting OpenDJ.
</para>
</listitem>
<listitem>
<para>
Start the upgraded OpenDJ directory server.
</para>
</listitem>
</orderedlist>
<important>
<para>
This utility <emphasis>does not back up OpenDJ before you upgrade,
nor does it restore OpenDJ if the utility fails</emphasis>.
In order to revert a failed upgrade,
make sure you back up OpenDJ directory server
before you overwrite existing binary and script files.
</para>
</important>
<para>
By default this utility requests confirmation
before making important configuration changes.
You can use the <option>--no-prompt</option> option
to run the command non-interactively.
</para>
<para>
When using the <option>--no-prompt</option> option,
if this utility 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 <option>--force</option> option
to force a non-interactive upgrade to continue in this case,
also performing long running and critical tasks.
</para>
<para>
for a full list of operations performed.
</para>
</informalexample>