You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by bu...@apache.org on 2013/12/17 15:15:27 UTC
svn commit: r1551547 - in
/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook: ./
part1/ part2/ part2/cli/ part2/webserver/ part3/ part4/ part4/admin/ part5/
Author: burn
Date: Tue Dec 17 14:15:26 2013
New Revision: 1551547
URL: http://svn.apache.org/r1551547
Log:
UIMA-3439 Combine references to DUCC_HOME and duccruntime. Fix a few typos
Modified:
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/common.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/overview.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/terminology.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-cancel.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-submit.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-services.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/ducc-uguide.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/services.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/webserver/system.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part3/ducc-applications.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/admin/ducc-properties.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/rm.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/sim.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-agent.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-job-driver.tex
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/common.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/common.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/common.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/common.tex Tue Dec 17 14:15:26 2013
@@ -19,8 +19,8 @@
% common macros in a single place
% These are used in the main file, and in the stand-alone wrappers
\newcommand{\distro}{apache-uima-ducc-1.0.0.tgz}
-\newcommand{\duccruntime}{\emph{ducc\_runtime}}
-\newcommand{\ducchome}{\$DUCC\_HOME}
+\newcommand{\duccruntime}{DUCC\_HOME}
+\newcommand{\ducchome}{DUCC\_HOME}
\newcommand{\todo}{{\sc \Large TODO:} }
\newcommand{\note}{{\em Note:} }
\newcommand{\cfbox}[2]{%
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/overview.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/overview.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/overview.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/overview.tex Tue Dec 17 14:15:26 2013
@@ -183,8 +183,8 @@
initialization is successful, the process is terminated and all affected CASs are retried, up to some
configurable threshold.
- \item DUCC insures that processes can successfully initialize before fully scaling out a job,
- to insure a cluster is not overwhelmed with errant processes.
+ \item DUCC ensures that processes can successfully initialize before fully scaling out a job,
+ to ensure a cluster is not overwhelmed with errant processes.
\item Various error conditions encountered while a job is running will prevent the errant job
from continuing scale out, and can result in termination of the job.
@@ -221,7 +221,7 @@
\item Starts, stops, and monitors all processes on behalf of users.
\item Patrols the node for ``foreign'' (non-DUCC) processes, reporting them to the
Web Server, and optionally reaping them.
- \item Insures job processes to not exceed their declared memory requirements
+ \item Ensures job processes do not exceed their declared memory requirements
through the use of Linux Cgroups.
\end{itemize}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/terminology.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/terminology.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/terminology.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part1/terminology.tex Tue Dec 17 14:15:26 2013
@@ -75,7 +75,7 @@
properties of the job (CLASSPATHs, RAM requirements, etc).
\item[Job] A DUCC job consists of the components required to deploy and execute a UIMA pipeline over
- a computing cluster. It consist of a JD to run the Collection Reader, a set of JPs to run the UIMA
+ a computing cluster. It consists of a JD to run the Collection Reader, a set of JPs to run the UIMA
AEs, and a Job Specification to describe how the parts fit together.
\item[Share Quantum] The DUCC scheduler abstracts the nodes in the cluster as a single large
@@ -95,7 +95,7 @@
some classes of work.
\item[Work Items] A DUCC work item is one unit of work to be completed in a single DUCC process. It
- is usually initiated by the submission of a single CAS from the CR to a UIMA service. It could be
+ is usually initiated by the submission of a single CAS from the JD to one of the JPs. It could be
thought of as a single ``question'' to be answered by a UIMA analytic, or a single ``task'' to
complete. Usually each DUCC JP executes many work items per job.
\end{description}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-cancel.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-cancel.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-cancel.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-cancel.tex Tue Dec 17 14:15:26 2013
@@ -37,7 +37,6 @@
\paragraph{Usage:}
\begin{description}
- \item[Executable Jar] java -jar \ducchome/lib/uima-ducc-service-cancel.jar {\em options}
\item[Script wrapper] \ducchome/bin/ducc\_service\_cancel {\em options}
\item[Java Main] java -cp \ducchome/lib/uima-ducc-service-cancel.jar org.apache.uima.ducc.cli.DuccServiceCancel {\em options}
\end{description}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-submit.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-submit.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-submit.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-service-submit.tex Tue Dec 17 14:15:26 2013
@@ -49,7 +49,6 @@
\paragraph{Usage:}
\begin{description}
- \item[Executable Jar] java -jar \ducchome/lib/uima-ducc-sesrvice-submit.jar {\em options}
\item[Script wrapper] \ducchome/bin/ducc\_service\_submit {\em options}
\item[Java Main] java -cp \ducchome/lib/uima-ducc-service-submit.jar org.apache.uima.ducc.cli.DuccServiceSubmit {\em options}
\end{description}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-services.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-services.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-services.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-services.tex Tue Dec 17 14:15:26 2013
@@ -241,14 +241,14 @@
The keywords in the string have the following meaning:
\begin{description}
- \item[queue\_threshold=nn] If the depth of the ActiveMq Queue for the service exceeds
+ \item[queue\_threshold=nn] If the depth of the ActiveMQ queue for the service exceeds
this value for some period of time, the health of the service is marked ``poor''.
If omitted, the value is 0, and no quality measurement is made.
\item[window=ww] This defines a ``window'' over which the queue threshold is measured.
the value is the number of consecutive measurements over which the queue depth must
exceed the threshold. If omitted, the window size is 0.
\item[broker\_jmx\_port=pppp] This is the JMX port for the service's broker. If not
- specified, the default of 1099 is used. This is used to gather ActiveMq statistics
+ specified, the default of 1099 is used. This is used to gather ActiveMQ statistics
for the service.
\item[meta\_timeout=tttt] This is the time, in milliseconds, to wait for a response
to UIMA-AS {\em get-meta}. If not specified, the default is 5000 milliseconds.
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/ducc-uguide.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/ducc-uguide.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/ducc-uguide.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/ducc-uguide.tex Tue Dec 17 14:15:26 2013
@@ -34,16 +34,19 @@
parameters may be saved in a standard Java Properties file, without the leading ``$--$''
characters. Both a properties file and command-line parameters may be passed to each CLI. When
both are present, the parameters on the command line take precedence. Take, for example
- the following simple job properties file, call it {\tt 1.job}.
+ the following simple job properties file, call it {\tt 1.job}, where the environment variable
+ ``DH'' has been set to the location of \ducchome.
\begin{verbatim}
description Test job 1
-classpath ../lib/uima-ducc-examples.jar
+classpath ${DH}/lib/uima-ducc/examples/*
environment AE_INIT_TIME=5 AE_INIT_RANGE=5 LD_LIBRARY_PATH=/a/nother/path
scheduling_class normal
driver_descriptor_CR org.apache.uima.ducc.test.randomsleep.FixedSleepCR
-driver_descriptor_CR_overrides jobfile:1.inputs,compression:10,error_rate:0.0
+driver_descriptor_CR_overrides jobfile=${DH}/lib/examples/simple/1.inputs compression=10
+error_rate=0.0
+
driver_jvm_args -Xmx500M
process_descriptor_AE org.apache.uima.ducc.test.randomsleep.FixedSleepAE
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/services.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/services.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/services.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/services.tex Tue Dec 17 14:15:26 2013
@@ -35,12 +35,12 @@
The DUCC service manager implements several high-level functions:
\begin{itemize}
- \item Insure services are available for jobs before allowing the jobs to start. This is a fail-fast
+ \item Ensure services are available for jobs before allowing the jobs to start. This is a fail-fast
to prevent unnecessary allocation of resources (with potential eviction of healthy processes)
for jobs that can't run, as well as quick feedback to users that something is amiss.
\item Manage the start-up and management of services: allocate resources, spawn the
- processes, manage the pingers, insure the processes stay alive, handle errors, etc.
+ processes, manage the pingers, ensure the processes stay alive, handle errors, etc.
\item Report on the state and availability of services.
\end{itemize}
@@ -77,7 +77,7 @@
The {\em service-type} must be either UIMA-AS or CUSTOM.
- The {\em unique id and contact information} is any string needed to insure the service is
+ The {\em unique id and contact information} is any string needed to ensure the service is
uniquely named. This string is passed to the service pinger and may contain
information for the pinger to contact the service. For UIMA-AS services, service endpoint is
inferred by the CLI by inspection of the UIMA-AS service's DD XML descriptor. The UIMA-AS
@@ -112,7 +112,7 @@
service registry for all service that are marked for automatic start-up. If registered for autostart,
the DUCC Service Manager submits the registered number of instances
on behalf of the registering user. If an instance should die, DUCC automatically restarts
- the instance. Short of massive failures, DUCC will insure the service is always running
+ the instance. Short of massive failures, DUCC will ensure the service is always running
and immediately ready for use with no manual intervention.
\item[On-Demand Services] An on-demand service is a registered service that is started only
@@ -327,7 +327,7 @@ public class CustomPing
\paragraph{1. Establish compile CLASSPATH} One DUCC jar is required in the CLASSPATH to build your pinger:
\begin{verbatim}
- $DUCC_HOME/lib/uima-ducc-cli.jar
+ \$HOME/ducc_runtime/lib/uima-ducc-cli.jar
\end{verbatim}
This provides the definition for the {\em AServicePing} and {\em ServiceStatistics} classes.
@@ -378,6 +378,6 @@ public class CustomPing
look in your log directory, as most problems with pingers are reflected there. As a last resort, you can
inspect the the Service Manager's log in
\begin{verbatim}
- $DUCC_HOME/logs/sm.log
+ \$HOME/ducc_runtime/logs/sm.log
\end{verbatim}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/webserver/system.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/webserver/system.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/webserver/system.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/webserver/system.tex Tue Dec 17 14:15:26 2013
@@ -75,7 +75,7 @@ The columns shown on this page include
All DUCC daemons broadcast a heartbeat containing process state. If the Status
is {\em down}, either the daemon is not functioning, or something is preventing
- state from reaching the web server via DUCC's ActiveMq instance.
+ state from reaching the web server via DUCC's ActiveMQ instance.
\item[Daemon Name] \hfill \\
This is the name of the process.
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part3/ducc-applications.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part3/ducc-applications.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part3/ducc-applications.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part3/ducc-applications.tex Tue Dec 17 14:15:26 2013
@@ -270,17 +270,17 @@ For this and the following sample progra
Copy to this directory the example job specification files:
\begin{verbatim}
- cp $DUCC_HOME/examples/descriptors/org/apache/uima/ducc/sampleapps/*.job .
+ cp $HOME/ducc_runtime/examples/descriptors/org/apache/uima/ducc/sampleapps/*.job .
\end{verbatim}
Copy a UIMA logger configuration file that supresses tons of output from OpenNLP:
\begin{verbatim}
- cp $DUCC_HOME/examples/descriptors/org/apache/uima/ducc/sampleapps/ConsoleLogger.properties .
+ cp $HOME/ducc_runtime/examples/descriptors/org/apache/uima/ducc/sampleapps/ConsoleLogger.properties .
\end{verbatim}
Copy the executable code and resources for the DUCC sample application components:
\begin{verbatim}
- cp $DUCC_HOME/examples/lib/uima-ducc-examples.jar .
+ cp $HOME/ducc_runtime/examples/lib/uima-ducc-examples.jar .
\end{verbatim}
For reference the source code for DUCC sample applications is in ducc\_runtime/examples/src,
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/admin/ducc-properties.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/admin/ducc-properties.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/admin/ducc-properties.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/admin/ducc-properties.tex Tue Dec 17 14:15:26 2013
@@ -64,7 +64,7 @@
\end{description}
\item[ducc.broker.automanage] \hfill \\
- If set to ``true'', DUCC will start and stop the ActiveMq broker as part of its normal start/stop
+ If set to ``true'', DUCC will start and stop the ActiveMQ broker as part of its normal start/stop
scripting.
\begin{description}
\item[Default] true
@@ -72,27 +72,27 @@
\end{description}
\item[ducc.broker.home] \hfill \\
- For DUCC auto-managed brokers only, this names the location where ActiveMq is installed
+ For DUCC auto-managed brokers only, this names the location where ActiveMQ is installed
installed.
- Note that the DUCC installation includes a default ActiveMq.
+ Note that the DUCC installation includes a default ActiveMQ.
\begin{description}
\item[Default] \duccruntime/activemq
\item[Type] Tuning
\end{description}
\item[ducc.broker.memory.options] \hfill \\
- For DUCC auto-managed brokers only, this names the ActiveMq configuration file. The configuration
+ For DUCC auto-managed brokers only, this names the ActiveMQ configuration file. The configuration
file is assumed to reside in the directory specified by {\em ducc.broker.home}, so the path must be relative
to that location.
\begin{description}
- \item[Default] conf/activemq-nojournal5.xml
+ \item[Default] conf/activemq-ducc.xml
\item[Type] Tuning
\end{description}
\item[ducc.broker.decoration] \hfill \\
- The property is used by the DUCC Job Driver processes to modify the ActiveMq broker URL
+ The property is used by the DUCC Job Driver processes to modify the ActiveMQ broker URL
when connecting to the Job Processes.
The supplied default is used to disable broker connection timeouts. From the ActiveMQ
@@ -119,14 +119,14 @@
will not work.
\begin{description}
\item[Default] \$\{ducc.head\}. The default is defined in the ducc property, {\em ducc.head}.
- If you want to run the ActiveMq broker on the ``ducc head'', this parameter need not
+ If you want to run the ActiveMQ broker on the ``ducc head'', this parameter need not
be changed.
\item[Type] Local
\end{description}
\item[ducc.broker.jmx.port] \hfill \\
This is the port used to make JMX connections to the broker. This should only
- be changed by administrators familiar with ActiveMq configuration.
+ be changed by administrators familiar with ActiveMQ configuration.
\begin{description}
\item[Default] 1100
\item[Type] Local
@@ -144,7 +144,7 @@
This is the internal name of the broker, used to locate Broker's MBean in JMX Registry.
It is NOT related to any node name. When using the ActiveMQ distribution supplied with
DUCC it should always be set to "localhost". The default should be changed only by
- administrators familiar with ActiveMq configuration.
+ administrators familiar with ActiveMQ configuration.
\begin{description}
\item[Default] localhost
\item[Type] Local
@@ -170,7 +170,7 @@
\item[ducc.broker.server.url.decoration] \hfill \\
- For DUCC auto-managed brokers only, this configures ActiveMq Server url decoration.
+ For DUCC auto-managed brokers only, this configures ActiveMQ Server url decoration.
\begin{description}
\item[Default] transport.soWriteTimeout=45000
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex Tue Dec 17 14:15:26 2013
@@ -104,10 +104,10 @@ More detailed one-time setup instruction
\section{Building from Source}
-To build from source, insure you have
+To build from source, ensure you have
Subversion and Maven installed. Extract the source from the SVN repository named above.
-Then change directory into
+Then from your extract directory into
the root directory (usually current-directory>/trunk), and run the command
\begin{verbatim}
mvn install
@@ -175,11 +175,11 @@ workloads.
tar -zxf <distribution.file>
\end{verbatim}
- This creates a directory with a name of the form ``apache-uima-ducc-<version>''.
+ This creates a directory with a name of the form ``apache-uima-ducc-[version]''.
This directory contains the full DUCC runtime which
you may use ``in place'' but it is highly recommended that you move it
- into a standard location; for example, ducc's HOME directory:
+ into a standard location; for example, under ducc's HOME directory:
\begin{verbatim}
mv apache-uima-ducc-1.0.0 $HOME/ducc_runtime
\end{verbatim}
@@ -187,7 +187,7 @@ mv apache-uima-ducc-1.0.0 $HOME/ducc_run
We refer to this directory, regardless of its location, as \duccruntime. For simplicity,
the examples in this document assume it has been moved to ducc's \$HOME/ducc\_runtime.
- \item Change directories into the admin sub-directory of \duccruntime:
+ \item Change directories into the admin sub-directory of \duccruntime:
\begin{verbatim}
cd $HOME/ducc_runtime/admin
\end{verbatim}
@@ -222,7 +222,7 @@ The post-installation script performs th
\item Sets up the default https keystore for the webserver.
\item Installs the DUCC documentation ``ducc book'' into the DUCC webserver root.
\item Builds and installs the C program, ``ducc\_ling'', into the default location.
- \item Insures that the (supplied) ActiveMQ broker is runnable.
+ \item Ensures that the (supplied) ActiveMQ broker is runnable.
\end{enumerate}
\section{Initial System Verification}
@@ -241,7 +241,7 @@ To run the verification, issue these com
\item Finally, start ducc: ./start\_ducc -s
\end{enumerate}
- Start\_ducc will perform a number of consistency checks and print the versions of the components.
+ Start\_ducc will first perform a number of consistency checks.
It then starts the ActiveMQ broker, the DUCC control processes, and a single DUCC agent on the
local node. Note that ``single user mode'' (-s) is specified for this first start. This inhibits
the checks on the permissions on ducc\_ling (described \hyperref[sec:duccling]{below}).
@@ -251,36 +251,35 @@ To run the verification, issue these com
\begin{verbatim}
ENV: Java is configured as: /share/jdk1.6/bin/java
ENV: java full version "1.6.0_14-b08"
+ENV: Threading enabled: True
MEM: memory is 15 gB
-ENV: system is Linux version 2.6.32-220.el6.x86_64 (mockbuild@x86-004.build.bos.redhat.com)
-ENF: (gcc version 4.4.5 20110214 (Red Hat 4.4.5-6) (GCC) ) #1 SMP Wed Nov 9 08:03:13 EST 2011
-broker host ducchead.biz.org
-[] INFO: Loading '/home/ducc/.activemqrc'
-[] INFO: Using java '/share/jdk1.6/bin/java'
-[] INFO: Starting - inspect logfiles specified in logging.properties and log4j.properties
- to get details
-[] INFO: pidfile created : '/home/ducc/ducc_runtime/activemq/data/activemq-ducchead.biz.org.pid'
- (pid '14138')
-[] Started AMQ broker
-Waiting for broker 0
-Waiting for broker 1
-ActiveMQ is found on configured host and port: ducchead.biz.org:61616
+ENV: system is Linux
+allnodes /home/ducc/apache_ducc_runtime/resources/ducc.nodes
+Class definition file is ducc.mixed.classes
+OK: Class and node definitions validated.
+OK: Class configuration checked
+Starting broker on ducchead.biz.org
+Waiting for broker ..... 0
+Waiting for broker ..... 1
+ActiveMQ broker is found on configured host and port: ducchead.biz.org:61618
+Starting 1 agents
+********** Starting agents from file /home/ducc/ducc_runtime/resources/ducc.nodes
Starting warm
-local Starting rm
-ducchead.biz.org PID 14198
-local Starting pm
-ducchead.biz.org PID 14223
-local Starting sm
-ducchead.biz.org PID 14248
-local Starting or
-ducchead.biz.org PID 14275
+Waiting for Completion
+ducchead.biz.org Starting rm
+ PID 14198
+ducchead.biz.org Starting pm
+ PID 14223
+ducchead.biz.org Starting sm
+ PID 14248
+ducchead.biz.org Starting or
+ PID 14275
ducchead.biz.org Starting ws
-ducchead.biz.org PID 14300
-********** Starting agents from file /home/ducc/ducc_runtime/resources/ducc.nodes
+ PID 14300
ducchead.biz.org
ducc_ling OK
DUCC Agent started PID 14325
-bash-4.1$
+All threads returned
\end{verbatim}
Now open a browser and go to the DUCC webserver's url, http://$<$hostname$>$:42133 where $<$hostname$>$ is
@@ -305,7 +304,7 @@ bash-4.1$
items completed grow from 0 to 15. Finally, the job will move into Completing and then
Completed..
- DUCC creates a log directory in your HOME directory under
+ Since this example does not specify a log directory DUCC will create a log directory in your HOME directory under
\begin{verbatim}
$HOME/ducc/logs/job-id
\end{verbatim}
@@ -331,7 +330,7 @@ $HOME/ducc/logs/job-id
\section{Logs}
The DUCC system logs are written to the directory
\begin{verbatim}
- ducc_runtime/logs
+ $HOME/ducc_runtime/logs
\end{verbatim}
In that directory are found logs for each of the DUCC components plus one for each node DUCC is
@@ -388,7 +387,7 @@ $HOME/ducc/logs/job-id
example, one could install it to /local/ducc/bin on local disk on every system.
To install ducc\_ling (these instructions assume it is installed into /local/ducc/bin):
- As ducc, insure ducc\_ling is built correctly for your architecture:
+ As ducc, ensure ducc\_ling is built correctly for your architecture:
\begin{enumerate}
\item cd \duccruntime/duccling/src
\item make clean all
@@ -523,7 +522,7 @@ ducc.agent.launcher.ducc_spawn_path=/loc
To add additional nodes to the ducc cluster, DUCC needs to know what nodes to start its Agent
processes on. These nodes are listed in the file
\begin{verbatim}
-ducc_runtime/resources/ducc.nodes.
+$HOME/ducc_runtime/resources/ducc.nodes.
\end{verbatim}
During initial installation, this file was initialized with the node DUCC is installed on.
@@ -533,7 +532,7 @@ ducc_runtime/resources/ducc.nodes.
\section{Full DUCC Verification}
This is identical to initial verification, with the one difference that the job ``1.job'' should be
-submitted as any user other than ducc. Watch the webserver and insure that you see the job execute
+submitted as any user other than ducc. Watch the webserver and check that the job executes
under the correct identity. Once this completes, DUCC is installed and verified.
\section{Enable DUCC webserver login}
@@ -582,12 +581,12 @@ Red Hat Enterprise Linux Workstation rel
org.apache.uima.ducc.common.authentication.IAuthenticationManager
2. create a jar file comprising your authentication class
3. put the jar file in a location accessible by the DUCC webserver, such as
- ~ducc/runtime/SNAPSHOT/ducc_runtime/webserver/lib/authentication
+ ~$HOME/ducc_runtime/lib/authentication
4. put any authentication dependency jar files there as well
5. edit ducc.properties
6. add the following:
ducc.local.jars = authentication/*
- ducc.authentication.implementer=<your.authenticaor.class.Name>
+ ducc.authentication.implementer=<your.authenticator.class.Name>
7. locate: ducc.ws.login.enabled = false
8. modify: ducc.ws.login.enabled = true
9. save
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/rm.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/rm.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/rm.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/rm.tex Tue Dec 17 14:15:26 2013
@@ -224,7 +224,7 @@
from its associated nodepool, or from any of the subpools which divide the associated nodepool.
The scheduler attempts to fully exhaust resources in the associated nodepool before allocating
within the subpools, and during eviction, attempts to first evict from the subpools. The
- scheduler insures that the nodepool mechanism does not disrupt fair-share allocation.
+ scheduler ensures that the nodepool mechanism does not disrupt fair-share allocation.
More information on nodepools and their configuration can be \hyperref[subsec:nodepools]{found here}.
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/sim.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/sim.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/sim.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/sim.tex Tue Dec 17 14:15:26 2013
@@ -75,7 +75,7 @@
expose the interesting problems is usually not practical.
DUCC's design divorces all the DUCC processes from specific IP
- addresses or node names. ActiveMq is used as a nameserver and
+ addresses or node names. ActiveMQ is used as a nameserver and
packet router so that all messages can be delivered by name,
irrespective of the physical hardware the destination process
may reside upon.
@@ -188,7 +188,7 @@ agentn.79 = 6
To establish test mode:
\begin{enumerate}
- \item Insure that {\em ducc.properties} is configured to point to a non-privileged
+ \item Ensure that {\em ducc.properties} is configured to point to a non-privileged
version of {\em ducc\_ling}. Specifically, configure this line in {\em ducc.properties}
\begin{verbatim}
ducc.agent.launcher.ducc_spawn_path=/home/ducctest/duccling.dir/amd64/ducc_ling
@@ -627,8 +627,8 @@ prepare [config-file]
\begin{sloppypar}
\item Create a node configuration. A sample configuration to generate
52 simulated nodes, and which assumes the
- physical machines for the simulation are called {\em sys290, sys291, sys292}
- and {\em sys293} is supplied in \duccruntime/examples/systemtest. Change
+ physical machines for the simulation are called {\em sys290, sys291, sys292, sys293}
+ and {\em sys534} is supplied in \duccruntime/examples/systemtest. Change
the node names to the names of real machines, making any other adjustments
needed.
\end{sloppypar}
@@ -655,20 +655,20 @@ prepare [config-file]
\item Generate the job set. For example, to generate the job set for the
15-minute run,
\begin{verbatim}
- cd $DUCC_HOME/examples/systemtest
+ cd $HOME/ducc_runtime/examples/systemtest
./prepare mega-15-min/jobs.prepare
\end{verbatim}
\item Start the simulated cluster (Assuming your simulated node file is called
{\em 52.simulated.nodes}:
\begin{verbatim}
- cd $DUCC_HOME/examples/systemtest
+ cd $HOME/ducc_runtime/examples/systemtest
./start_sim -c all -n 52.simulated.nodes
\end{verbatim}
- \item Use the webserver (or for advanced users, log files work also), to insure
+ \item Use the webserver (or for advanced users, log files), to ensure
everything came up and the job driver node has been assigned.
\item Start the run:
\begin{verbatim}
- cd $DUCC_HOME/examples/systemtest
+ cd $HOME/ducc_runtime/examples/systemtest
./runducc -d mega-15-min -b job.ctl
\end{verbatim}
\end{enumerate}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-agent.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-agent.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-agent.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-agent.tex Tue Dec 17 14:15:26 2013
@@ -55,7 +55,7 @@
It also receives publications which it interprets to control
processes deployed thereon.
It also monitors activity on the \varNodeMachineComputer~and
- insures that only sanctioned processes are running.
+ ensures that only sanctioned processes are running.
The \varAgent~is normally launched at \varDUCC~system
start-up time.
@@ -274,4 +274,4 @@
\item Process Lifecycle
\item Process Metrics
\end{itemize}
-
\ No newline at end of file
+
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-job-driver.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-job-driver.tex?rev=1551547&r1=1551546&r2=1551547&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-job-driver.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part5/ducc-pops-component-job-driver.tex Tue Dec 17 14:15:26 2013
@@ -137,7 +137,7 @@
\item{\varCAS~Limbo}
\begin{description}
\item Manage incomplete \varWorkItems.
- This module insures that \varWorkItems~are not simultaneously processed
+ This module ensures that \varWorkItems~are not simultaneously processed
by multiple \varUIMA~pipelines.
It does not release \varWorkItems~for retry processing elsewhere until
confirmation is received that the previous attempt has been terminated.