Page History

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 Windows Azure)
• 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; the storage providers which are currently supported are listed here.
• 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
• 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 configuration 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:

...

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

1. Configure DuraCloud database
2. Build and deploy the DuraCloud web applications
3. Set up the OSGi services container
4. Initialize the DuraCloud applications
5. 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

1. Java: Version 8 required
   
   1. The Oracle JDK is recommended for building DuraCloud, as this is the JDK used for DuraCloud testing.
2. Maven 2.2.1 or above3.x
3. Tomcat 68.x or above
4. Java 6 (note: the djatoka service has compatibility issues with open-jdk)
6. Git
7. DuraCloud Management Console
8. DuraCloud MillSubversion

Setting up DuraCloud

Build and deploy the DuraCloud web applications

1. Check out latest stable release from

   Subversion

   GitHub repository

   Code Block
   svn cogit clone --branch duracloud-4.0.0 https://svngithub.duraspace.orgcom/duracloud/tags/duracloud-1.3.0

2. Set environment variables

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

3. Configure Tomcat

   Code Block $CATALINA

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

      No Format
      <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>

   Start tomcat

   1. Add to  $CATALINA_HOME/

   bin

   1. conf/

   startup.sh
4. Configure Maven2
   1. Add tomcat user to $M2_HOME/conf/settings.xml

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

5. Build
   1. From top of source tree

      Code Block
      mvn clean install

Set up the OSGi services container

This step assumes the successful completion of the previous build instructions

Once the OSGi services container is running, check to ensure that it was created properly

1. In the console where the "run" script was executed, an "osgi" prompt should be available. If it is not available, hitting enter should bring it up.
2. Type "ss" and hit enter. This should list all of the available bundles. This list should include 50 items, all of which are either in the ACTIVE or RESOLVED state.

Initialize the DuraCloud applications

1. 1. server.xml

      Add the config attribute "URIEncoding" with value "UTF-8" to your Tomcat Connector.  Your connector may look like the following:

      No Format
      <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />

   2. Create a duracloud properties file (/any/path/to/duracloud.properties) that contains the following keys: 

      No Format
      mill.db.name=<mill db name> mill.db.port=<mysql port> mill.db.host=<mysql host> mill.db.user=<username> mill.db.pass=<password> db.name=<ama db name> db.host=<mysql ama host> db.port=<mysql ama port> db.user=<username> db.pass=<password>

   3. Add -Dduracloud.config.file=/any/path/to/duracloud.properties to your JAVA_OPTS or CATALINA_OPTS environment variables. You can also set these values in $CATALINA_HOME/bin/setenv.sh (linux,osx) or $CATALINA_HOME/bin/setenv.bat (windows).  The duracloud.config.file system property can also refer to an Amazon S3 address using the s3://<bucket>/<path to file> syntax provided your tomcat instance is running on an instance with the appropriate AWS credentials.  More information on AWS credentials management.

2. Start Tomcat

   Code Block
   $CATALINA_HOME/bin/startup.sh

3. 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.

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

4. Build
   

   1. From top of the source tree, execute (note that this build runs unit tests, but not integration tests):

      Code Block
      mvn clean install -DskipIntTests

5. 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.  A sample credential configuration file can be found in the baseline at  <project root>/integration/src/test/resources/test-config.json

   4. From the top of the source tree, execute 

      Code Block
      mvn clean install -pl integration

   Use the application initialization (app-config) utiltiy to configure the deployed DuraCloud applications
   1. Build app-config utility, from within the //app-config module

      Code Block
      mvn assembly:assembly

   2. Run the app-config utility

      Code Block
      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

1. 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 filevalid DuraCloud Management Console credentials.
   3. You should be able to view, add, update, and delete spaces and content in Spaces tabYou should be able to deploy services in the Services tab
2. Congratulations! You now have a functional DuraCloud installation.

Optional items

Code coverage

SyncTool installers

1. 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 15.1.0 or above
   2. Place the license file for InstallBuilder in the InstallBuilder installation directory
2. Update the maven settngs.xml file ($M2_HOME/conf/settings.xml) to include the path to the installbuilder executableIf you plan on using Clover, the following element needs to be added to your maven 'settings.xml' No Format

   1. Add a duracloud profile to include the InstallBuilder path, and include the duracloud profile in the set of active profiles

      Code Block

   1. <profiles> <profile>

   <id>profile-clover</id> <activation> <property> <name>profile</name> <value>clover</value>

   1. <id>duracloud</id>

   </property> </activation>

   1. <properties>

   <cloverLicense>[LOCATION-OF-clover.license-FILE]</cloverLicense>

   1. <installbuilder.executable.path>[FULL-PATH-TO-BITROCK-INSTALLBUILDER-EXECUTABLE]</installbuilder.executable.path> </properties> </profile> </profiles>

3. To run clover

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

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

Service tests within OSGi (Linux only)

1. 1. ... <activeProfiles> <activeProfile>duracloud</activeProfile> </activeProfiles>

   2. From the //synctoolui directory in the DuraCloud source tree, execute

      Code Block
      mvn clean install -Pinstallers

   3. The installers can be found under the synctoolui/target directory
   Assuming that the OSGi services container is set up and running (as described above), tests that deploy services into the OSGi environment may be run
   1. From inside the //integration-test module Code Block mvn install -PrunServicesAdminTests

Logging

1. DuraCloud uses the SLF4j 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

...

Building Java client packages

1. To create a distributable zip of the storeclient

   , serviceclient,

   or reportclient which includes their dependencies, from within the project directory (//storeclient

   , //serviceclient

   , //reportclient) run

   Code Block
   mvn install -Ppackage-client

2. The packaged zip will be found under the project's target directory

Misc configuration/discussion

Services on Windows

The following services do not function in a Windows deployment environment

• WebAppUtilService
• HelloWebappWrapper
• J2KService
• ImageMagickService

...