Getting Started

Getting started with Apache OODT can be a daunting task. With a number of components to setup and configure it can be both time consuming and confusing. To help solve this problem Radix and the Vagrant Virtual Machine were created.

RADiX

RADiX is a Maven Archtype designed to get OODT up and running quickly and easily. Maven will download the correct libraries and run the correct configuration routines to deploy a fully working OODT platform including File Manage, Workflow, OpsUI etc.

RADiX can run on both Unix systems and Windows and requires nothing more than a Java JDK and Apache Maven installed on your computer.

To find out how to get started with RADiX quickly then visit its wiki page here

Vagrant VM

Vagrant extends upon Radix to give you a configured Virtual Machine with a preconfigured RADiX installation already built and ready along with the networking configuration setup so you can connect to OpsUI without having to change the networking setup.

The Vagrant VM is idea if you want a portable image that can be replicated time after time or copied around colleagues.

To get started with the OODT Vagrant VM, visit the wiki page.

Apache OODT Wiki Documentation

Apache OODT has a number of components and various ways to configure and use each one. To keep the documentation as up to date as possible, we have migrated all our documentation to the Apache OODT Wiki space.

The documentation on the wiki is updated regularly with component information, tutorials and examples. If you use Apache OODT and would like to help contribute to the sizable documentation effort, then please ask on the development mailing list for details about how you can help with OODT documentation.

OODT Javadoc

The Javadoc links below are a convenient way for your to browse current and previous versions of the project Java documentation:

  • Nightly (current master SNAPSHOT)
  • 0.10
  • 0.9
  • 0.8.1
  • 0.8
  • 0.7

For earlier version of the Javadoc please get in touch with us and we can generate them for you.

Overview

The high level goal of this effort is to build a distribution of OODT that sets up, installs, and runs within a few commands. Reducing the number of commands to run OODT is an effort to push the edge of ease of setup and configuration required to get going. This distribution of OODT will include both a deployment and source structure for managing the evolution of your installation of OODT.

Maven offers an improved way to export, configure and build OODT called Archetypes. Archetypes simply put are a way to define templates for projects. Within these project templates we will include packaging instructions to conform to the guidelines below to increase the similarity amongst deployments of OODT. Moreover, we will build higher level scripts and configuration to tie the pieces together at the system level. Finally, we will leverage the CAS Install Maven Plugin to take us from our source structure to our deployment structure.

This wiki will be used to capture thoughts, ideas and plans for the first archetypes we develop for OODT. To keep things simple we are going to initially focus on a small number of modules that are typically deployed and configured together. Finally, our goal is to build an 80% solution that works in most cases to get people out of the gates and running with a full OODT solution. We believe this effort will help increase adoption and conformity amongst installations of an already great system.

Installing OODT with Radix

curl -s "https://git-wip-us.apache.org/repos/asf?p=oodt.git;a=blob_plain;f=mvn/archetypes/radix/src/main/resources/bin/radix;hb=HEAD" | bash
mv oodt oodt-src; cd oodt-src; mvn install
mkdir ../oodt; tar -xvf distribution/target/oodt-distribution-0.1-bin.tar.gz -C ../oodt
cd ../oodt; ./bin/oodt start
./resmgr/bin/batch_stub 2001

Introduction

This user-guide will help you understand, and set up a Vagrant powered Virtual Machine containing a pre-configured OODT installation.

Requirements

  • Vagrant - please download from: http://www.vagrantup.com
  • VirtualBox - please download from: https://www.virtualbox.org/
  • At least 4GB disk space

OODT RADiX Vagrant Virtual Machine

Launching this Vagrant VM will provide you with:

  • A pre-configured RADiX installation with a version of OODT of your choosing (including the latest OODT snapshots!)
  • A port-forwarded OPSUI control webapp at http://localhost:8080/opsui that you can quickly use to verify and control OODT
  • More time, because installing OODT is as easy as "vagrant up"
  • A fast way to produce a RADiX project tar-ball, which you can copy and use elsewhere

Steps

  1. Download the latest Apache OODT distribution.
  2. Extract the OODT distribution somewhere on your machine
    # please change ${version} to the version you have
    $ unzip apache-oodt-${version}-src.zip
    $ cd apache-oodt-${version}-src/vagrant/radix/
  3. Customize your RADiX Vagrant distribution for your organization/project:
    1. Open vagrant/env.sh in your favorite editor
    2. Make sure you customize entries for the following variables:
      1. (required) PROJECT_GROUP_ID - The namespace that will be used to create the RADiX distribution of OODT (e.g. com.mycompany.myorg)
      2. (required) PROJECT_ARTIFACT_ID - The specific name of the RADiX distribution project (e.g. myproject)
      3. (optional) BUILD_FLAGS - Set of build flags that will customize the RADiX deployment Vagrant will build. See more build flag options here.
      4. (optional) OODT_DEPLOYMENT_HOME - The location on the Vagrant Virtual Machine where OODT RADiX will be installed to
      5. (Optional) Change the top line of Vagrantfile that sets the VM_NAME to a name of your choosing. Note, every Vagrant virtual machine must have a unique name.
  4. Install/Launch RADiX OODT
    1. Type vagrant up to launch the Virtual Machine (can take up to 15 minutes the first time you run)
      $ vagrant up
  5. After the above command finished, navigate to the OODT OpsUI on your host machine: http://localhost:8080/opsui

Getting started

To get started with OODT development you will need JDK7+, an IDE(of course we recommend Netbeans as soon as it arrvies in the Apache Incubator, but Intellij and Eclipse are perfectly acceptable! ;) ) and Maven 3 or later is also needed to compile the source code.

The easiest place to checkout the code is from Github: https://github.com/apache/oodt

To compile the code from source simply run `mvn clean install` on the command line from within the checkout directory and the OODT code will start to compile.

To file bugs or find new tasks to work on you can find the OODT issue track on the ASF Jira: http://issues.apache.org