Building DuraCloud Software from Source

Introduction

If you would prefer to install DuraCloud from a binary distribution, you can find instructions for that process here.

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 Windows Azure)
DuraCloud REST API
DuraBoss - this web application includes the reporter, executor, auditor, and manifest projects, each of which expose their own distinct set of calls via 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.
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 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 provided as part of the application initialization step. It is recommended that you acquire the necessary storage provider credentials prior to attempting to set up DuraCloud. Only one storage provider is required to run DuraCloud.

The storage providers which are currently supported are listed here.

This guide lays out the steps necessary to begin using DuraCloud:

Build and deploy the DuraCloud web applications
Initialize the DuraCloud applications
Test your installation

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

Java: Version 7 required, Java 8 preferred
1. The Oracle JDK is recommended for building DuraCloud, as this is the JDK used for DuraCloud testing.
Maven 3.x
Tomcat 7.x
Git

Setting up DuraCloud

Any portions of the configuration below for which you need to include a replacement value will be written in all capital letters and included in brackets: [LIKE-THIS]

Build and deploy the DuraCloud web applications

Check out latest stable release from Subversion repository

git clone --branch duracloud-3.7.0 https://github.com/duracloud/duracloud

Set environment variables

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

Configure Tomcat

Add to $CATALINA_HOME/conf/tomcat-users.xml

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

Add to $CATALINA_HOME/conf/server.xml
Add the config attribute "URIEncoding" with value "UTF-8" to your Tomcat Connector. Your connector may look like the following:
```
<Connector port="8080" protocol="HTTP/1.1" 
               connectionTimeout="20000" 
               redirectPort="8443"
               URIEncoding="UTF-8" />
```

Start Tomcat
```
$CATALINA_HOME/bin/startup.sh
```
Configure Maven3
1. Add tomcat user to $M2_HOME/conf/settings.xml. Make sure that the username and password used here match those included in the tomcat-users.xml file.
```
<servers>
  <server>
    <id>tomcat-server</id>
    <username>[ANY-USERNAME]</username>
    <password>[ANY-PASSWORD]</password>
  </server>
</servers>
```
Build
1. From top of the source tree, execute (note that this build runs unit tests, but not integration tests):
```
mvn clean install -DskipIntTests
```
Bonus, running Integration Tests
1. Grab a copy of the file in the codebase under common-json/src/main/resources/test-config.json and place it somewhere on your system
2. You'll need an account for each of the providers to be tested. Update the JSON file to include your credentials. These tests actually communicate with each storage provider and verify that the calls being made work properly
3. Add an environment variable called DURACLOUD-TEST-CONFIG with the value being the full path to your updated credentials JSON file
4. From the top of the source tree, execute
```
mvn clean install -pl integration
```

Initialize the DuraCloud applications

Use the application initialization (app-config) utiltiy to configure the deployed DuraCloud applications
1. If you haven't already done a full build, you need to build the app-config utility. From the top of the source tree, execute (you can skip this if you made it through step 6 above):
```
mvn clean install -pl app-config
```
2. Run the app-config utility from the //app-config/target directory
```
java -jar target/app-config-[VERSION]-driver.jar <init.props>
```
  1. The init.props file is a configuration file which specifies all of the information necessary for the DuraCloud applications to run. An example of this file can be found at //app-config/src/main/resources/init.props. This file will need to be updated to match your environment.
3. When the app-config utility completes successfully, the last line of output printed to the console will be the word "success". If this is not the case, check that your configuration file includes the correct information.

Test your installation

Once all of the above steps have been completed, your DuraCloud should be ready to test.
1. Go to http://localhost:8080/duradmin (change host or port as necessary).
2. Log in using the credentials provided in your configuration file
3. You should be able to view, add, update, and delete spaces and content in Spaces tab
Congratulations! You now have a functional DuraCloud installation.

Optional items

SyncTool installers

The installers for the Sync Tool (Windows, Mac, Linux) are built using BitRock InstallBuilder Enterprise, so this tool must be installed locally.
1. Download and install BitRock InstallBuilder Enterprise version 8.5.2 or above
2. Place the license file for InstallBuilder in the InstallBuilder installation directory
Update the maven settngs.xml file ($M2_HOME/conf/settings.xml) to include the path to the installbuilder executable
1. Add a duracloud profile to include the InstallBuilder path, and include the duracloud profile in the set of active profiles
```
<profiles>
  <profile>
    <id>duracloud</id>
    <properties>
      <installbuilder.executable.path>[FULL-PATH-TO-BITROCK-INSTALLBUILDER-EXECUTABLE]</installbuilder.executable.path>
    </properties>
  </profile>
</profiles>

...

<activeProfiles>
  <activeProfile>duracloud</activeProfile>
</activeProfiles>
```
2. From the //synctoolui directory in the DuraCloud source tree, execute
```
mvn clean install -Pinstallers
```
3. The installers can be found under the synctoolui/target directory

Logging

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

DuraCloud internal tools

Building Java client packages

To create a distributable zip of the storeclient or reportclient which includes their dependencies, from within the project directory (//storeclient, //reportclient) run
```
mvn install -Ppackage-client
```
The packaged zip will be found under the project's target directory

Page tree