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/06/12 18:34:16 UTC
svn commit: r1492270 - in
/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli:
ducc-cancel.tex ducc-process-cancel.tex ducc-process-submit.tex
ducc-reserve.tex ducc-service-cancel.tex ducc-service-submit.tex
Author: challngr
Date: Wed Jun 12 16:34:16 2013
New Revision: 1492270
URL: http://svn.apache.org/r1492270
Log:
UIMA-2682 Duccbook updates.
Modified:
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-cancel.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-submit.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-reserve.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
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-cancel.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-cancel.tex?rev=1492270&r1=1492269&r2=1492270&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-cancel.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-cancel.tex Wed Jun 12 16:34:16 2013
@@ -19,24 +19,24 @@
\paragraph{Options:}
\begin{description}
- \item[--debug ]
+ \item[$--$debug ]
Prints internal debugging information, intended for DUCC developers or extended problem determination.
- \item[--id {[jobid]}]
+ \item[$--$id {[jobid]}]
The ID is the id of the job to cancel.
- \item[--reason {[quoted string]}]
+ \item[$--$reason {[quoted string]}]
Optional. This specifies the reason the job is canceled for display in the web server. Note that
the shell requires a quoted string. Example:
\begin{verbatim}
ducc_cancel --id 12 --reason "This is a pretty good reason."
\end{verbatim}
- \item[-dpid {[pid]}]
+ \item[$--$dpid {[pid]}]
If specified only this DUCC process will be canceled. If not
specified, then entire job will be canceled. The {\em pid} is the DUCC-assigned process ID of the
process to cancel. This is the ID in the first column of the Web Server's job details page, under
the column labeled ``Id''.
- \item[--help]
+ \item[$--$help]
Prints the usage text to the console.
- \item[--role\_administrator] The command is being issued in the role of a DUCC administrator.
+ \item[$--$role\_administrator] The command is being issued in the role of a DUCC administrator.
If the user is not also a registered administrator this flag is ignored. (This helps to
protect administrators from accidentally canceling jobs they do not own.)
\end{description}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex?rev=1492270&r1=1492269&r2=1492270&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex Wed Jun 12 16:34:16 2013
@@ -6,6 +6,8 @@
\section{ducc\_process\_cancel}
\paragraph{Description:}
+ The cancel CLI is used to cancel a process that has previously been submitted but which has not yet
+ completed.
\paragraph{Usage:}
\begin{description}
@@ -16,15 +18,15 @@
\paragraph{Options:}
\begin{description}
- \item[--debug ]
+ \item[$--$debug ]
Prints internal debugging information, intended for DUCC developers or extended problem determination.
- \item[--id {[jobid]}]
+ \item[$--$id {[jobid]}]
The DUCC ID is the id of the process to cancel.
- \item[--help]
+ \item[$--$help]
Prints the usage text to the console.
- \item[--reason]
+ \item[$--$reason]
Optional. This specifies the reason the process is canceled, for display in the web server.
- \item[--role\_administrator] The command is being issued in the role of a DUCC administrator.
+ \item[$--$role\_administrator] The command is being issued in the role of a DUCC administrator.
If the user is not also a registered administrator this flag is ignored. (This helps to
protect administrators from inadvertantly canceling work they do not own.)
\end{description}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-submit.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-submit.tex?rev=1492270&r1=1492269&r2=1492270&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-submit.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-submit.tex Wed Jun 12 16:34:16 2013
@@ -27,18 +27,18 @@
\paragraph{Options:}
\begin{description}
- \item[--cancel\_on\_interrupt ] Cancel managed reservation on interrupt
- (Ctrl-C). If running with {\em--wait\_for\_completion} and this flag is specified,
+ \item[$--$cancel\_on\_interrupt ] Cancel managed reservation on interrupt
+ (Ctrl-C). If running with {\em $--$wait\_for\_completion} and this flag is specified,
terminating the submit process will result in the remote process being terminated.
- \item[--description {[text]}] The text is any string used to describe the process. It is
+ \item[$--$description {[text]}] The text is any string used to describe the process. It is
displayed in the Web Server. When specified on a command-line the text usually must be
surrounded by quotes to protect it from the shell.
- \item[--debug ] Prints internal debugging information, intended for DUCC developers or
+ \item[$--$debug ] Prints internal debugging information, intended for DUCC developers or
extended problem determination.
- \item[--environment {[env vars]}] Blank-delimited list of environment variables. If
+ \item[$--$environment {[env vars]}] Blank-delimited list of environment variables. If
specified, this is used for all DUCC processes in the job. Example:
\begin{verbatim}
--environment "TERM=xterm DISPLAY=me.org.net:1.0".
@@ -54,9 +54,9 @@
-environment TERM=xterm DISPLAY=:1.0 DUCC_LD_LIBRARY_PATH=/my/own/path
\end{verbatim}
- \item[--help] Prints the usage text to the console.
+ \item[$--$help] Prints the usage text to the console.
- \item[--log\_directory {[path-to-log directory]} ]
+ \item[$--$log\_directory {[path-to-log directory]} ]
This specifies the path to the directory for the user logs. If not specified, the default is the
user's home directory. Example:
@@ -68,32 +68,32 @@
ID of the job. The format of the generated log file names as described
\hyperref[chap:job-logs]{here}.
- Note: Note that --log\_directory specifies only the path to a directory where
+ Note: Note that $--$log\_directory specifies only the path to a directory where
logs are to be stored. In order to manage multiple processes running in multiple
machines DUCC, sub-directory and file names are generated by DUCC and may
not be directly specified.
- \item[--process\_attach\_console] If specified, redirect remote process stdio is
+ \item[$--$process\_attach\_console] If specified, redirect remote process stdio is
redirected the local submitting console.
- \item[--process\_executable {[program name]}] This is the full path to a program to be
+ \item[$--$process\_executable {[program name]}] This is the full path to a program to be
executed.
- \item[--process\_executable\_args {[argument list]}] This is a list of arguments for
+ \item[$--$process\_executable\_args {[argument list]}] This is a list of arguments for
{\em process\_executable}, if any. When specified on a command-line the text usually must be
surrounded by quotes to protect it from the shell.
- \item[--process\_memory\_size {[size]} ] This specifies the maximum amount of RAM in GB to
+ \item[$--$process\_memory\_size {[size]} ] This specifies the maximum amount of RAM in GB to
be allocated to each process. This value is used by the Resource Manager to allocate
resources. if this amount is exceeded by a process the Agent terminates the process with a
ShareSizeExceeded message.
- \item[--scheduling\_class {[classname]} ] This specifies the name of the scheduling class the
+ \item[$--$scheduling\_class {[classname]} ] This specifies the name of the scheduling class the
RM will use to determine the resource allocation for each process. The names of the
classes are installation dependent. If not specified, the default is taken from the global
DUCC configuration ducc.properties.
- \item[--specification, $-$f {[file]} ] All the parameters used to submit a process may be placed
+ \item[$--$specification, $-$f {[file]} ] All the parameters used to submit a process may be placed
in a standard Java properties file. This file may then be used to submit the process
(rather than providing all the parameters directory to submit).
@@ -113,11 +113,11 @@ scheduling_class = fixed
process_memory_size = 15
\end{verbatim}
- \item[--wait\_for\_completion ] If specified, the submit command does not return control to
+ \item[$--$wait\_for\_completion ] If specified, the submit command does not return control to
the console immediately, and instead monitors the DUCC state traffic and prints
information about the process as it progresses.
- \item[--working\_directory ] This specifies the working directory to be set by the Job
+ \item[$--$working\_directory ] This specifies the working directory to be set by the Job
Driver and Job Process processes. If not specified, the current directory is used.
\end{description}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-reserve.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-reserve.tex?rev=1492270&r1=1492269&r2=1492270&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-reserve.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-reserve.tex Wed Jun 12 16:34:16 2013
@@ -27,29 +27,29 @@
\begin{description}
- \item[--debug ]
+ \item[$--$debug ]
Prints internal debugging information, intended for DUCC developers or extended problem determination.
- \item[--description {[text]}]
+ \item[$--$description {[text]}]
The text is any string used to describe the reservation. It is displayed in the Web Server.
- \item[--help ]
+ \item[$--$help ]
Prints the usage text to the console.
- \item[--instance\_memory\_size {[KB|MB|GB|TB]}]]
+ \item[$--$instance\_memory\_size {[KB|MB|GB|TB]}]]
This specifies the amount of memory the reserved machine must supoprt. For full machine
reservations, this is the total memory on the machine. For partial reservations, the machine
may have more memory, but not less than is specified.
- \item[--number\_of\_instances {[integer]}]
+ \item[$--$number\_of\_instances {[integer]}]
This specifies the number of full or partial machine reservations to schedule.
- \item[--scheduling\_class {[classname]}]
+ \item[$--$scheduling\_class {[classname]}]
This specifies the name of the scheuling class the RM will use to determine the resource
allocation for each process. The default DUCC distribution provides class "reserve" for full
machine reservations, and "fixed" for partial machine reservations.
- \item[-f, --specifiecaiton {[file]}]
+ \item[$-$f, $--$specifiecaiton {[file]}]
All the parameters used to request a reservation may be placed in a standard Java
properties file. This file may then be used to submit the request (rather than providing all
the parameters directory to submit).
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=1492270&r1=1492269&r2=1492270&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 Wed Jun 12 16:34:16 2013
@@ -22,13 +22,13 @@
\paragraph{Options:}
\begin{description}
- \item[--debug ]
+ \item[$--$debug ]
Prints internal debugging information, intended for DUCC developers or extended problem determination.
- \item[--id {[jobid]}]
+ \item[$--$id {[jobid]}]
The ID is the id of the service instance to cancel.
- \item[--help]
+ \item[$--$help]
Prints the usage text to the console.
- \item[--role\_administrator] The command is being issued in the role of a DUCC administrator.
+ \item[$--$role\_administrator] The command is being issued in the role of a DUCC administrator.
If the user is not also a registered administrator this flag is ignored. (This helps to
protect administrators from inadvertently canceling work they do not own.)
\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=1492270&r1=1492269&r2=1492270&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 Wed Jun 12 16:34:16 2013
@@ -38,7 +38,7 @@
\hyperref[sec:services.types]{UIMA-AS services}. If not specified, the CLASSPATH used
by the {\em ducc\_service\_submit} command is used.
- \Item[$--$classpath\_order {[UserBeforeDucc | DuccBeforeUser]} ] When DUCC deploys a process,
+ \item[$--$classpath\_order {[UserBeforeDucc | DuccBeforeUser]} ] When DUCC deploys a process,
set the user-supplied classpath before DUCC-supplied classpath, or the reverse. This is
only valid for \hyperref[sec:services.types]{UIMA-AS services}.
@@ -80,7 +80,7 @@
specified, the same JVM used by the Agents is used.
Note: The path must be the full path the the Java executable (not
- simply the JAVA_HOME environment variable.). Example:
+ simply the JAVA\_HOME environment variable.). Example:
\begin{verbatim}
--jvm /share/jdk1.6/bin/java
\end{verbatim}