Building DuraCloud Software from Source

Introduction

DuraCloud application software is composed of many parts. A breakdown of the primary pieces is as follows:

• DuraStore - this web application provides the access to and management of storage resources, which includes handling the storage portion of the DuraCloud REST API
• StorageProviders - this set is made up of the StorageProvider interfaces and the implementations which connect to distinct cloud stores (currently Amazon S3, Rackspace CloudFiles, and EMC Atmos)
• DuraService - this web application handles the deployment and management of services within DuraCloud, which includes handling the services portion of the DuraCloud REST API
• DuraReport - this web application handles the generation of storage and service reports and provides the reporting portion of the DuraCloud REST API
• DurAdmin - this web application is the UI front end of DuraCloud, it provides users with a view into the information available from the other applications. DurAdmin uses the REST APIs of the other applications to communicate with them.
• Services - the set of all deployable services, as well as the support projects that allow the DuraCloud services infrastructure to function
• ComputeProviders - this set is made up of the ComputeProvider interfaces and the implementation which connect to distinct cloud compute services (currently Amazon EC2, using the typica library)
• Security - handles security for the DuraCloud applications
• Common - a set of projects which provide utilities for other portions of the codebase to reuse

The DuraCloud software, by its very nature, is designed to be integrated with underlying cloud storage and compute providers. As may be expected, these integrations are necessary for the system to be properly exercised. In order for DuraCloud to connect to these underlying providers, appropriate credentials must be available. The build process can be accomplished without these credentials, however, the next step of initializing the deployed applications depend on this information. The storage providers which are currently available are:

• Amazon S3
• Rackspace CloudFiles
• Windows Azure

This guide lays out the two tiers of building/testing the baseline:

1. build with unit tests
2. build with OSGi services container integration tests

Although this document is written from a Linux environment perspective, analogous builds/installations have been tested in Windows (but may have limitations, as noted below). Any comments or feedback are welcomed.

Prerequisites

Software that must be installed on your system prior to building/using DuraCloud

1. Maven 2.2.1 or above
2. Tomcat 6.x or above
3. Java 6 (note: the djatoka service has compatibility issues with open-jdk)
4. Subversion

Building DuraCloud

Build with unit tests

1. Check out latest stable release from Subversion repository

   svn co https://svn.duraspace.org/duracloud/tags/duracloud-1.1.0
   

2. Set environment variables

   export JAVA_OPTS="-XX:MaxPermSize=256m"
   export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=1024m"
   

3. Configure Tomcat
   1. Add to $CATALINA_HOME/conf/tomcat-users.xml

      <tomcat-users>
        <role rolename="manager"/>
        <role rolename="admin"/>
        <user username="[ANY-USERNAME]" password="[ANY-PASSWORD]" roles="admin,manager"/>
      </tomcat-users>
      

4. Start tomcat

   $CATALINA_HOME/bin/startup.sh
   

5. Configure Maven2
   1. Add tomcat user to $M2_HOME/conf/settings.xml

      <servers>
        <server>
          <id>tomcat-server</id>
          <username>[ANY-USERNAME]</username>
          <password>[ANY-PASSWORD]</password>
        </server>
      </servers>
      

6. Build
   1. From top of source tree

      mvn clean install
      

      Note: Due to the length of time required to execute integration tests as well as the nature of "eventually consistent" cloud services to not cooperate with a synchronous test suite, these tests are not included in the build by default.

Build with OSGi services container integration tests

This step assumes the successful completion of the previous build instructions

Optional items

Code coverage

1. If you plan on using Clover, the following element needs to be added to your maven 'settings.xml'

   <profiles>
     <profile>
       <id>profile-clover</id>
       <activation>
         <property>
           <name>profile</name>
           <value>clover</value>
         </property>
       </activation>
       <properties>
         <cloverLicense>[LOCATION-OF-clover.license-FILE]</cloverLicense>
       </properties>
     </profile>
   </profiles>
   

2. To run clover

   mvn clover2:instrument clover2:aggregate clover2:clover -Pprofile-clover
   

3. A report will be generated in the following directory:
   //target/site/clover/

Logging

1. DuraCloud uses the SLF4j logging framework backed by the LogBack implementation
2. By adding either a logback.xml or logback-test.xml file on the classpath, logging configuration can be customized

DuraCloud internal tools

ServicesAdmin CLI

1. This tool provides a commandline interface for interacting with the 'services-admin' installed in a running OSGi container (see notes above for starting the container)
2. To build and run the CLI, from within the //servicesadminclient module

   mvn assembly:assembly
   java -cp target/servicesadminclient-[VERSION]-cli.jar
   

Application initialization utility

1. This utility takes a config file (example at //app-config/src/main/resources/init.props) and initializes an instance of duracloud
2. Until the applications durastore and duraservice are initialized, they are non-functional
3. To build and run the app-config utility, from within the //app-config module

   mvn assembly:assembly
   java -jar target/app-config-1.1.0-driver.jar
   

StoreClient package

1. To create a distributable zip of the storeclient and its dependencies, from within //storeclient run

   mvn install -Ppackage-client
   

2. The zip will be found at /storeclient/target/store-client.zip

Misc configuration/discussion

Services on Windows

The following services do not function in a Windows deployment environment

• WebAppUtilService
• HelloWebappWrapper
• J2KService
• ImageMagickService

If you would like to run the ImageConversionService, you must install ImageMagick and have its /bin directory in your PATH, which is essentially what the ImageMagickService does in a linux environment.

root user

application config

OSGi container