You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by ch...@apache.org on 2013/09/19 18:34:29 UTC
svn commit: r1524778 - in
/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2:
cli/viaducc.tex ducc-uguide.tex
Author: challngr
Date: Thu Sep 19 16:34:29 2013
New Revision: 1524778
URL: http://svn.apache.org/r1524778
Log:
UIMA-2682 Add viaducc and java_viaducc documentation.
Added:
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/viaducc.tex
Modified:
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/ducc-uguide.tex
Added: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/viaducc.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/viaducc.tex?rev=1524778&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/viaducc.tex (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/viaducc.tex Thu Sep 19 16:34:29 2013
@@ -0,0 +1,59 @@
+% Create well-known link to this spot for HTML version
+\ifpdf
+\else
+\HCode{<a name='DUCC_VIADUCC'></a>}
+\fi
+ \section{viaducc and java\_viaducc}
+ \label{sec:cli.viaducc}
+
+ \paragraph{Description:}
+ Viaducc is a small script wrapper around the \hyperref[sec:cli.ducc-process-submit]{\em
+ ducc\_process\_submit } CLI to facilitate execution of Eclipse workspaces directly in DUCC,
+ and to provide a simple interface to submit arbitrary processes.
+
+ When run as the command ``viaducc'', the arguments are bundled into the form expected by
+ \hyperref[sec:cli.ducc-process-submit]{\em ducc\_process\_submit } and submits the command
+ to DUCC.
+
+ When run as the command ``java\_viaducc'', the arguments are assumed to be a Java classname
+ and its arguments. This is passed for execution by DUCC via DUCC's default JRE, or
+ optionally, a specific JRE supplied by the user.
+
+ If ``java\_viaducc'' is installed as a symbolic link from the local JRE/bin directory to the
+ ``viaducc'' command in the DUCC runtime/bin directory, it may be specified as an alternative
+ to the ``java'' command in an eclipse launcher. The remote stdin and stdout of the deployed
+ DUCC process are redirected to your Eclipse console. This provides essentially transparent
+ execution of code in your Eclipse workspaces in DUCC-managed resources.
+
+ \paragraph{Usage:}
+\begin{verbatim}
+ viaducc [defines] [command and parameters]"
+\end{verbatim}
+ or
+\begin{verbatim}
+ java_viaducc [defines] [java-class and parameters]"
+\end{verbatim}
+
+ The ``defines'' are described below. The ``command and parameters'' are either any command
+ (with full path) and it's arguments, or a Java class (with a ``main'') and its arguments (including
+ the classpath if necessary.)
+
+ \paragraph{Defines}
+
+ The arguments are specified in the syntax of Java ``-D'' system properties, to be more consistent
+ with execution under Eclipse.
+ \begin{description}
+ \item[-DDUCC\_MEMORY\_SIZE] This specifies the memory required, in GB. If not specified, the
+ smallest memory quanta configured for the scheduler is used.
+ \item[-DDUCC\_CLASS] This is the scheduling class to submit the process to. It should generally
+ be a non-preemptable class. If not specified, it defaults to class ``fixed''.
+ \item[-DDUCC\_ENVIRONMENT] This species additional environment parameters to pass to the job.
+ It should specify a quoted string of blank-delimeted K=V environment values. For example:
+\begin{verbatim}
+ -DDUCC_ENVIRONMENT="DUCC_RLIMIT_NOFILE=1000 V1=V2 A=B"
+\end{verbatim}
+ \item[-DJAVA\_BIN] This species the exact ``java'' command to use, for ``java\_viaducc''. it
+ must be a full path to some JRE that is known to be installed on all the DUCC nodes. If not
+ specified, the JRE used to run ducc is uses.
+ \end{description}
+
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=1524778&r1=1524777&r2=1524778&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 Thu Sep 19 16:34:29 2013
@@ -44,7 +44,7 @@ ducc_job_submit --specification 1.job --
The DUCC CLI parameters are now described in detail.
- \paragraph{The DUCC Job Descriptor}
+ \subsection{The DUCC Job Descriptor}
The DUCC Job Descriptor includes properties to enable automated management and scale-out
over large computing clusters. The job descriptor includes
\begin{itemize}
@@ -57,8 +57,38 @@ ducc_job_submit --specification 1.job --
\item Debugging and monitoring requirements and preferences
\end{itemize}
+ \subsection{Operating System Limit Support}
+ The CLI supports specification of operating system limits applied to the various job processes.
+ To specify a limit, pass the name of the limit and its value in the {\em environment} specified
+ in the job. Limits are named with the string ``DUCC\_RLIMIT\_name'' where ``name'' is the name of
+ a specific limit. Supported limits include:
+ \begin{itemize}
+ \item DUCC\_RLIMIT\_CORE
+ \item DUCC\_RLIMIT\_CPU
+ \item DUCC\_RLIMIT\_DATA
+ \item DUCC\_RLIMIT\_FSIZE
+ \item DUCC\_RLIMIT\_MEMLOCK
+ \item DUCC\_RLIMIT\_NOFILE
+ \item DUCC\_RLIMIT\_NPROC
+ \item DUCC\_RLIMIT\_RSS
+ \item DUCC\_RLIMIT\_STACK
+ \item DUCC\_RLIMIT\_AS
+ \item DUCC\_RLIMIT\_LOCKS
+ \item DUCC\_RLIMIT\_SIGPENDING
+ \item DUCC\_RLIMIT\_MSGQUEUE
+ \item DUCC\_RLIMIT\_NICE
+ \item DUCC\_RLIMIT\_STACK
+ \item DUCC\_RLIMIT\_RTPRIO
+ \end{itemize}
+ See the Linux documentation for details on the meanings of these limits and their values.
- \paragraph{Command Line Forms}
+ For example, to set the maximum number of open files allowed in any job process, specify
+ an environment similar to this when submitting the job:
+\begin{verbatim}
+ ducc_job_submit .... --environment="DUCC_RLIMT_NOFILE=1024" ...
+\end{verbatim}
+
+ \subsection{Command Line Forms}
The Command Line Interface is provided in several forms:
\begin{enumerate}
@@ -70,7 +100,7 @@ ducc_job_submit --specification 1.job --
silently. When invoking a command's {\tt class} directly, the java {\tt CLASSPATH}
must include the uima-ducc-cli.jar, as illustrated in the wrapper scripts.
- \paragraph{Provided Commands}
+ \subsection{DUCC Commands}
The following commands are provided:
\begin{description}
\item[ducc\_submit] Submit a job for execution.
@@ -83,6 +113,8 @@ ducc_job_submit --specification 1.job --
\item[ducc\_services] Register, unregister, start, stop, modify, and query a service.
\item[ducc\_view\_perf] Fetch performance data from the log and history files for analysis
by spreadsheets, etc.
+ \item[viaducc] This is a script wrapper to facilitate execution of Eclipse workspaces as
+ DUCC jobs as well as general execution of arbitrary processes in DUCC-managed resources.
\end{description}
The next section describes these commands in detail.
@@ -100,6 +132,7 @@ ducc_job_submit --specification 1.job --
\input{part2/cli/ducc-process-cancel.tex}
\input{part2/cli/ducc-services.tex}
\input{part2/cli/ducc-perf-stats.tex}
+ \input{part2/cli/viaducc.tex}
% Create well-known link to this spot for HTML version