CR-1783 Fix for OPENDJ-910: Document new native packaging

Mark Craig

03.53.2013 1352d26fad20499570925a2f44ca1bedd6c0ab15

CR-1783 Fix for OPENDJ-910: Document new native packaging

 opendj3/src/main/docbkx/install-guide/chap-install-cli.xml

@@ -68,7 +68,21 @@
     </listitem>
    </varlistentry>

    <!-- TODO: .deb, .rpm not yet posted on a download page -->
    <varlistentry>
     <term>opendj_<?eval ${docTargetVersion}?>_all.deb</term>
     <listitem>
      <para>OpenDJ directory server native package for Debian and related
      Linux distributions.</para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term>opendj-<?eval ${docTargetVersion}?>.noarch.rpm</term>
     <listitem>
      <para>OpenDJ directory server native package for Red Hat and related
      Linux distributions.</para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term>OpenDJ-<?eval ${docTargetVersion}?>-DSML.war</term>
@@ -352,7 +366,7 @@
Administrative Users:     cn=Directory Manager
Installation Path:        /path/to/opendj
Version:                  OpenDJ <?eval ${docTargetVersion}?>
Java Version:             1.6.0_29
Java Version:             <replaceable>version</replaceable>
Administration Connector: Port 4444 (LDAPS)

          --- Connection Handlers ---
@@ -378,6 +392,189 @@
  option, specifying values for all the other options you require.</para>
 </note>

 <procedure xml:id="install-deb">
  <title>To Install From the Debian Package</title>
  <indexterm><primary>Debian (.deb) package</primary></indexterm>

  <para>On Debian and related Linux distributions such as Ubuntu, you can
  install OpenDJ directory server from the Debian package.</para>

  <step>
   <para>Before you install OpenDJ, install a Java runtime environment if none
   is installed yet.</para>

   <screen>$ sudo apt-get install default-jre</screen>
  </step>

  <step>
   <para>Install the OpenDJ directory server package.</para>

   <screen>$ sudo dpkg -i opendj*.deb
Selecting previously unselected package opendj.
(Reading database ... 185569 files and directories currently installed.)
Unpacking opendj (from opendj_<?eval ${docTargetVersion}?>_all.deb) ...

Setting up opendj (<?eval ${docTargetVersion}?>) ...
$</screen>

   <para>The .deb installs OpenDJ directory server in the directory
   <filename>/opt/opendj</filename>.</para>

   <para>The files are owned by root by default, making it easier to have OpenDJ
   listen on ports 389 and 636.</para>
  </step>

  <step>
   <para>Configure OpenDJ directory server by using the command
   <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>
  </step>

  <step performance="optional">
   <para>Check OpenDJ directory server status.</para>

   <screen>$ sudo /opt/opendj/bin/status


>>>> Specify OpenDJ LDAP connection parameters

Administrator user bind DN [cn=Directory Manager]:

Password for user 'cn=Directory Manager':

          --- Server Status ---
Server Run Status:        Started
Open Connections:         1

          --- Server Details ---
Host Name:                ubuntu.example.com
Administrative Users:     cn=Directory Manager
Installation Path:        /opt/opendj
Version:                  OpenDJ <?eval ${docTargetVersion}?>
Java Version:             <replaceable>version</replaceable>
Administration Connector: Port 4444 (LDAPS)

          --- Connection Handlers ---
Address:Port : Protocol               : State
-------------:------------------------:---------
--           : LDIF                   : Disabled
0.0.0.0:161  : SNMP                   : Disabled
0.0.0.0:389  : LDAP (allows StartTLS) : Enabled
0.0.0.0:636  : LDAPS                  : Enabled
0.0.0.0:1689 : JMX                    : Disabled
0.0.0.0:8080 : HTTP                   : Disabled

          --- Data Sources ---
Base DN:     dc=example,dc=com
Backend ID:  userRoot
Entries:     2002
Replication: </screen>
  </step>

  <step performance="optional">
   <para>If you want to run OpenDJ when the system starts, see <link
   xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
   xlink:href="admin-guide#create-rc-script-1">create-rc-script</link>.</para>
  </step>
 </procedure>

 <procedure xml:id="install-rpm">
  <title>To Install From the RPM Package</title>
  <indexterm><primary>Red Hat (.rpm) package</primary></indexterm>

  <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>Before you install OpenDJ, install a Java runtime environment if none
   is installed yet.</para>

   <screen>$ java -version
java version ...
OpenJDK Runtime Environment ...</screen>
  </step>

  <step>
   <para>Install the OpenDJ directory server package.</para>

   <screen>$ su
Password:
# rpm -i opendj*.rpm
Pre Install - initial install
Post Install - initial install

#</screen>

   <para>The .rpm installs OpenDJ directory server in the directory
   <filename>/opt/opendj</filename>.</para>

   <para>The files are owned by root by default, making it easier to have OpenDJ
   listen on ports 389 and 636.</para>
  </step>

  <step>
   <para>Configure OpenDJ directory server by using the command
   <command>/opt/opendj/setup</command>.</para>

   <screen># /opt/opendj/setup --cli
...
To see basic server configuration status and configuration you can launch
 /opt/opendj/bin/status</screen>
  </step>

  <step performance="optional">
   <para>Check OpenDJ directory server status.</para>

   <screen># /opt/opendj/bin/status


>>>> Specify OpenDJ LDAP connection parameters

Administrator user bind DN [cn=Directory Manager]:

Password for user 'cn=Directory Manager':

          --- Server Status ---
Server Run Status:        Started
Open Connections:         1

          --- Server Details ---
Host Name:                fedora.example.com
Administrative Users:     cn=Directory Manager
Installation Path:        /opt/opendj
Version:                  OpenDJ <?eval ${docTargetVersion}?>
Java Version:             <replaceable>version</replaceable>
Administration Connector: Port 4444 (LDAPS)

          --- Connection Handlers ---
Address:Port : Protocol               : State
-------------:------------------------:---------
--           : LDIF                   : Disabled
0.0.0.0:161  : SNMP                   : Disabled
0.0.0.0:389  : LDAP (allows StartTLS) : Enabled
0.0.0.0:636  : LDAPS                  : Enabled
0.0.0.0:1689 : JMX                    : Disabled
0.0.0.0:8080 : HTTP                   : Disabled

          --- Data Sources ---
Base DN:     dc=example,dc=com
Backend ID:  userRoot
Entries:     2002
Replication: </screen>
  </step>

  <step performance="optional">
   <para>If you want to run OpenDJ when the system starts, see <link
   xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
   xlink:href="admin-guide#create-rc-script-1">create-rc-script</link>.</para>
  </step>
 </procedure>

 <procedure xml:id="install-properties-file">
  <title>To Install OpenDJ Directory Server With a Properties File</title>


 opendj3/src/main/docbkx/install-guide/chap-uninstall.xml

@@ -116,4 +116,61 @@
   <screen>$ rm -rf /path/to/opendj</screen>
  </step>
 </procedure>

 <procedure xml:id="uninstall-deb">
  <title>To Uninstall the Debian Package</title>
  <indexterm><primary>Debian (.deb) package</primary></indexterm>

  <para>When you uninstall the Debian package from the command line, OpenDJ
  directory server is stopped if it is running.</para>

  <step>
   <para>Remove the package from your system.</para>

   <screen>$ sudo dpkg -r opendj
(Reading database ... 185725 files and directories currently installed.)
Removing opendj ...
*Stopping OpenDJ server...
Stopping Server...
[03/Jun/2013:10:00:49 +0200] category=BACKEND severity=NOTICE
 msgID=9896306 msg=The backend userRoot is now taken offline
[03/Jun/2013:10:00:49 +0200] category=CORE severity=NOTICE
 msgID=458955 msg=The Directory Server is now stopped

*OpenDJ successfully removed

$ </screen>

   <para>Removing the package does not remove your data or configuration.
    You must remove <filename>/opt/opendj</filename> manually to get rid of
    all files.</para>
  </step>
 </procedure>

 <procedure xml:id="uninstall-rpm">
  <title>To Uninstall the RPM Package</title>
  <indexterm><primary>Red Hat (.rpm) package</primary></indexterm>

  <para>When you uninstall the RPM package from the command line, OpenDJ
  directory server is stopped if it is running.</para>

  <step>
   <para>Remove the package from your system.</para>

   <screen># rpm -e opendj-<?eval ${docTargetVersion}?>.noarch.rpm
Pre Uninstall - uninstall
Stopping Server...
[03/Jun/2013:10:42:46 +0200] category=BACKEND severity=NOTICE
 msgID=9896306 msg=The backend userRoot is now taken offline
[03/Jun/2013:10:42:46 +0200] category=CORE severity=NOTICE
 msgID=458955 msg=The Directory Server is now stopped
Post Uninstall - uninstall
OpenDJ successfully removed.
# </screen>

   <para>Removing the package does not remove your data or configuration.
   You must remove <filename>/opt/opendj</filename> manually to get rid of
   all files.</para>
  </step>
 </procedure>
</chapter>

 opendj3/src/main/docbkx/install-guide/chap-upgrade.xml

@@ -74,6 +74,12 @@
 <procedure xml:id="upgrade-zip">
  <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>

  <para>The following steps describe how to upgrade OpenDJ directory server
  installed from the cross-platform (.zip) delivery.</para>

  <step>
   <para>Login as the user who owns the current OpenDJ server.</para>
  </step>