...

Installers Architectures

As of march 2008, we currently have the following set of installers for Apache DS:

...

This layout consists in an organized set of files and directory directories which looks like this:

The bin directory contains the Apache DS binaries:

...

To generate the installer, a directory is created and contains a specific structure to be used with the PackageMaker command line utility.
Here's the layout of this directory:
Image Removed Image Added

The Info.plist file contains the general information about the package (package name, version, etc.).
The Resources directory contains the resources of the Installer (License and background files).
The root directory contains the files to be installed and their location on the target system, the root directory acting as the root of the filesystem (/).
This way, for example, the file org.apache.directory.server.plist inside the root > Library > LaunchDaemons directories will be installed at /Library/LaunchDaemons/org.apache.directory.server.plist.

Image Removed

Image Removed

Installation layout

Image Removed

Installers Projects Architecture

...

.

The generation will create a Mac OS X Installer Package called Apache Directory Server Installer.pkg.

This package is handled as a single file in the Finder but it is actually a folder (with a .pkg extension) containing a particular structure.
So, it is impossible to distribute the package file through the Internet.
To avoid this distribution problem, the package is distributed inside a DMG (Disk iMaGe).

To generate the disk image, a directory is created and contains a specific structure to be used with the hdiutil command line utility.
Here's the layout of this directory:
Image Added

The dmg directory that will be used as root for the dmg contains the following files:

• a (hidden) .background directory in which is hidden the background image (baskgound.png) for the disk image.
• a (hidden) .DS_Store file holding the View Options for the disk image.
• the Apache Directory Server Installer.pkg package.

Once it is generated and mounted, the disk image will only display the Apache Directory Server Installer.pkg package, as show below:
Image Added

Installation layout

The installer installs the following files on the target system:

• Server files are installed by default at /usr/local/apacheds-1.5.2-SNAPSHOT
• Instances files are installed by default at /usr/local/apacheds-1.5.2-SNAPSHOT/instances
• An init script is installed at /Library/LaunchDaemons/org.apache.directory.server.plist

Installers Projects Architecture

Installers are divided into 3 projects:

• Daemon Plugin project (/daemons/plugin/)
• Installers ApacheDS project (/installers/apacheds)
• Installers ApacheDS NoArch project (/installers/apacheds-noarch)

Daemon Plugin project

This is the main project where daemon and installers are built.

This project is a Maven 2 plugin. It defines one goal "generate", which creates installers.

This goal is defined in the ServiceInstallersMojo class.

Its configuration takes an "Application" as argument which defines a few parameters (name, description, version, etc.)

It uses various installer targets:

• IzPacKTargets (Old multi-platforms installer made with IzPack)
• RpmTagets (Current RPM package installer)
• PkgTargets (Current Mac OS X PKG package installer)
• InnoTargets (Old Windows installer made with Inno)
• NsisTargets (Current Windows Installer made with NSIS)
• DebTargets (Current Deb package installer)
• BinTargets (Current Bin package installer)

It also defines "exclusions" for libraries that should not be bundled in the lib directory and "packageFiles" for files that should be packaged within the installer.

Installers ApacheDS project

This projects builds the installers using the Deamon Plugin.

It only includes a "Dummy" java class and a few resources for the installers.

The setup is done in the pom.xml file of the project.

Various profiles are defined to generate different installers.

Here's an example of profile:

<profiles>
   <profile>
      <id>macosx</id>
      <build>
        <plugins>
          <plugin>
            <groupId>org.apache.directory.daemon</groupId>
            <artifactId>daemon-plugin</artifactId>
            <version>1.1.2-SNAPSHOT</version>
            <configuration>
              <application>
                <name>apacheds</name>
                <version>1.5.2-SNAPSHOT</version>
                <description>Apache Directory Suite</description>

                <icon>src/main/resources/feather.ico</icon>
                <copyrightYear>2007</copyrightYear>
                <minimumJavaVersion>1.5</minimumJavaVersion>
                <url>http://directory.apache.org</url>
                <email>users@directory.apache.org</email>
                <license>target/classes/META-INF/LICENSE</license>
                <authors>
                  <author>Apache Directory Team</author>
                  <author>akarasulu@apache.org</author>
                  <author>ckoppelt@apache.org</author>
                  <author>elecharny@apache.org</author>
                  <author>erodriguez@apache.org</author>
                  <author>ersiner@apache.org</author>
                  <author>oersoy@apache.org</author>
                  <author>pamarcelot@apache.org</author>
                  <author>szoerner@apache.org</author>
                  <author>seelmann@apache.org</author>
                  <author>trustin@apache.org</author>
                </authors>
              </application>
              <packagedFiles>
                <packagedFile>
                  <source>org.apache.directory.server:apacheds-server-tools</source>
                  <destinationPath>bin/apacheds-tools.jar</destinationPath>
                  <dependency>true</dependency>
                  <installationBundleId>Binaries</installationBundleId>
                </packagedFile>
                <packagedFile>
                  <source>target/classes/META-INF/NOTICE</source>
                  <destinationPath>NOTICE</destinationPath>
                  <executable>false</executable>
                  <filtered>true</filtered>
                </packagedFile>
              </packagedFiles>
              <applicationClass>
                org.apache.ldap.server.Service
              </applicationClass>
              <pkgTargets>
                <pkgTarget>
                 <id>apacheds-macosx</id>
                  <finalName>apacheds-macosx</finalName>
                  <osName>Mac OS X</osName>
                  <osFamily>macosx</osFamily>
                  <osVersion>10.5</osVersion>
                  <osArch>x86</osArch>
                  <daemonFramework>tanuki</daemonFramework>
                </pkgTarget>
              </pkgTargets>

              <excludes>
                <!-- apacheds-tools.jar does not get put in lib directory -->
                <exclude>org.apache.directory.server:apacheds-server-tools</exclude>

                <exclude>ant:ant</exclude>
                <exclude>aopalliance:aopalliance</exclude>
                <exclude>xerces:xerces</exclude>
                <!--exclude>commons-pool:commons-pool</exclude-->
                <exclude>xml-apis:xml-apis</exclude>
                <exclude>aspectwerkz:aspectwerkz-core</exclude>
                <exclude>velocity:velocity</exclude>
                <exclude>org.springframework:spring-aop</exclude>
                <exclude>qdox:qdox</exclude>
                <exclude>oro:oro</exclude>
                <exclude>commons-attributes:commons-attributes-compiler</exclude>
                <exclude>commons-attributes:commons-attributes-api</exclude>
                <exclude>cglib:cglib</exclude>
                <exclude>velocity:velocity-dep</exclude>
                <exclude>com.jamonapi:jamon</exclude>
                <exclude>asm:asm</exclude>
                <exclude>freemarker:freemarker</exclude>
                <exclude>asm:asm-util</exclude>
                <exclude>jasperreports:jasperreports</exclude>
              </excludes>
            </configuration>
            <executions>
              <execution>
                <goals>
                  <goal>generate</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>

Installers ApacheDS NoArch project

This project produces a tarball containing the Default Apache DS server files layout, that you can unpack where you want (it does not include the Tanuki wrapper, so this is a one-instance server only).

Generating Installers

To generate the installers, you have to go to the Installers ApacheDS project (/installers/apacheds) and execute the following command

mvn clean install -Pprofile

where "profile" is the name of the installers profile you want to use.