Page History

...

• 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, SDSC (San Diego Super Computing Center), 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

...

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

1. Configure DuraCloud properties file
2. Build and deploy the DuraCloud web applications
3. Initialize the DuraCloud applications
4. 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.

...

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

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

Setting up DuraCloud

...

1. Check out latest stable release from Subversion repository

   Code Block
   git clone --branch duracloud-34.70.0 https://github.com/duracloud/duracloud

2. Set environment variables

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

3. Create Mill database

4. Create Account Management Database
5. Configure Tomcat
   

   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>

   2. 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:

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

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

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

6. Start Tomcat

   Code Block
   $CATALINA_HOME/bin/startup.sh

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

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

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

      Code Block
      mvn clean install -pl integration

Initialize the DuraCloud applications

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

      Code Block
      mvn clean install -pl app-config

   2. Run the app-config utility from the //app-config/target directory

      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.

   4. integration

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 fileusing as user "root" using the default password of "duracloud"
   3. You should be able to view, add, update, and delete spaces and content in Spaces tab
2. Congratulations! You now have a functional DuraCloud installation.

...

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 815.51.2 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 executable

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

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

      Code Block
      mvn clean install -Pinstallers

   3. The installers can be found under the synctoolui/target directory

...