[RETIRED 2022-12-21] Apache UIMA DUCC — Distributed UIMA Cluster Computing. No longer maintained.

Clone this repo:
  1. 8a13946 No issue: Format README as markdown and add retirement notice by Richard Eckart de Castilho · 4 weeks ago trunk
  2. 9ea161c Merge pull request #7 from apache/infrastructure-ruleset-bot/default-branch-protection by Richard Eckart de Castilho · 4 weeks ago
  3. 3332df8 Set up default protection ruleset for default and release branches by The Apache Software Foundation · 4 weeks ago infrastructure-ruleset-bot/default-branch-protection
  4. fd8cab1 UIMA-6238 DUCC Web Server (WS) should not be contacted on timer in manual mode by Lou DeGenaro · 6 years ago
  5. d3a9d32 UIMA-6197 ducc_watcher should optionally allow SSL certificate validation bypass by Lou DeGenaro · 6 years ago

Apache Distributed UIMA Cluster Computing (DUCC) Version 3.0.0

[!IMPORTANT] This project has been retired.

Apache UIMA DUCC was retired on 21 December 2022 and is no longer actively maintained. The source code remains available for archival and reference purposes, but no new releases, bug fixes, or security updates are planned.

1. Building from the Source Distribution

We use Maven 3.3.3 for building; download this if needed, and set the environment variable MAVEN_OPTS to -Xmx800m -XX:MaxPermSize-256m. To build UIMA-DUCC, install Java SDK 8.

Maven uses JAVA_HOME to locate the java runtime. Before starting the maven build do this:

export JAVA_HOME=<your java dir>

Then build from the directory containing this README by issuing the command:

mvn clean install

This builds everything except the source-release.zip file and DUCC documentation. To build the documentation make sure you have LATEX installed and set the environment variable BUILD_DUCCDOCS=true, or activate the build-duccdocs profile with:

mvn clean install -Pbuild-duccdocs

Please refer to Section 12.3 “Building from Source” of the duccbook document for more information about building ducc documentation.

To build everything including the source-release.zip and documentation, use:

mvn clean install -Papache-release,build-duccdocs

To setup GPG signing see http://uima.apache.org/one-time-release-setup.html.

Look for the result in the two artifacts:

  • target/uima-ducc-[version]-source-release.zip (if run with -Papache-release)
  • target/uima-ducc-[version]-bin.tar.gz

For more details, please see http://uima.apache.org/building-uima.html.

2. Contents of Apache UIMA DUCC binary distribution

The Apache UIMA DUCC binary distribution includes:

Shell scripts

  • admin/start_ducc: starts DUCC
  • admin/stop_ducc: stops DUCC

Documentation

  • docs/d/duccbok.pdf: UIMA-DUCC documentation (PDF Format)
  • docs/d/duccbok.html: UIMA-DUCC documentation (HTML Format)
  • docs/d/installation.pdf: UIMA-DUCC installation guide (PDF Format)
  • docs/d/installation.html: UIMA-DUCC installation guide (HTML Format)

UIMA DUCC Getting Started can be found online here: http://uima.apache.org/doc-uimaducc-whatitam.html

Examples

  • examples/ — contains ducc example source code and resources

Descriptors

  • examples/sampleapps/descriptors/ — contains sample descriptor files

Resources

  • resources/ — contains ducc configuration files

3. Installation and Setup

Please refer to the INSTALL document located in the directory containing this README for installation instructions.

3.1 Supported Platforms

UIMA-DUCC runtime has been tested with Oracle 8 as well as IBM Java 8 on Linux. The cluster of machines DUCC manages must all be running a reasonably current level of Linux; other operating systems are not supported.

4. How to Get Involved

The Apache UIMA project really needs and appreciates any contributions, including documentation help, source code and feedback. If you are interested in contributing, please visit http://uima.apache.org/get-involved.html.

5. How to Report Issues

The Apache UIMA project uses JIRA for issue tracking. Please report any issues you find at http://issues.apache.org/jira/browse/uima.

Crypto Notice

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software:

This distribution includes portions of Apache ActiveMQ, which, in turn, is classified as being controlled under ECCN 5D002.