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 2015/04/05 23:20:36 UTC
svn commit: r1671426 - in /uima/sandbox/uima-ducc/trunk:
uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/
uima-ducc-duccdocs/src/site/tex/duccbook/part2/
uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/
Author: burn
Date: Sun Apr 5 21:20:36 2015
New Revision: 1671426
URL: http://svn.apache.org/r1671426
Log:
UIMA-4298 More updates to docs. Make process_executable a reqd option for APs
Modified:
uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java
uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IUiOptions.java
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-monitor.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-perf-stats.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-services.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-unreserve.tex
uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/ducc-uguide.tex
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java?rev=1671426&r1=1671425&r2=1671426&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java Sun Apr 5 21:20:36 2015
@@ -47,7 +47,7 @@ public class DuccManagedReservationSubmi
UiOption.Environment,
UiOption.LogDirectory,
UiOption.AttachConsole,
- UiOption.ProcessExecutable,
+ UiOption.ProcessExecutableRequired,
UiOption.ProcessExecutableArgs,
UiOption.ProcessMemorySize,
UiOption.SchedulingClass,
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IUiOptions.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IUiOptions.java?rev=1671426&r1=1671425&r2=1671426&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IUiOptions.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IUiOptions.java Sun Apr 5 21:20:36 2015
@@ -450,8 +450,16 @@ public interface IUiOptions
public String argname() { return "program name"; }
public String description() { return "The full path to a program to be executed."; }
public String example() { return "/bin/ls"; }
- },
-
+ },
+
+ ProcessExecutableRequired {
+ public String pname() { return JobSpecificationProperties.key_process_executable; }
+ public String argname() { return "program name"; }
+ public String description() { return "The full path to a program to be executed."; }
+ public String example() { return "/bin/ls"; }
+ public boolean required() { return true; }
+ },
+
ProcessExecutableArgs {
public String pname() { return JobSpecificationProperties.key_process_executable_args; }
public String argname() { return "argument list"; }
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=1671426&r1=1671425&r2=1671426&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 Sun Apr 5 21:20:36 2015
@@ -39,7 +39,7 @@
\item[$--$debug ]
Prints internal debugging information, intended for DUCC developers or extended problem determination.
\item[$--$id {[jobid]}]
- The ID is the id of the job to cancel.
+ The ID is the id of the job to cancel. (Required)
\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:
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-monitor.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-monitor.tex?rev=1671426&r1=1671425&r2=1671426&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-monitor.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-monitor.tex Sun Apr 5 21:20:36 2015
@@ -45,7 +45,7 @@
\item[$--$debug ]
Prints internal debugging information, intended for DUCC developers or extended problem determination.
\item[$--$id {[jobid]}]
- The ID is the id of the job to monitor.
+ The ID is the id of the job to monitor. (Required)
\item[$--$help]
Prints the usage text to the console.
\item[$--$quiet]
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-perf-stats.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-perf-stats.tex?rev=1671426&r1=1671425&r2=1671426&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-perf-stats.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-perf-stats.tex Sun Apr 5 21:20:36 2015
@@ -37,8 +37,8 @@
\paragraph{Options:}
\begin{description}
- \item[$--$job id] This specifies the job to report on.
- \item[$--$directory dir] This specifies the job's log directory. (DUCC writes usage information into this
+ \item[$--$job {[id]}] This specifies the job to report on.
+ \item[$--$directory {[dir]}] This specifies the job's log directory. (DUCC writes usage information into this
directory as the job is running.)
\item[$--$report {[summary or workitems or processes]}]
This specifies the type of report:
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=1671426&r1=1671425&r2=1671426&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 Sun Apr 5 21:20:36 2015
@@ -38,10 +38,10 @@
\item[$--$debug ]
Prints internal debugging information, intended for DUCC developers or extended problem determination.
\item[$--$id {[jobid]}]
- The DUCC ID is the id of the process to cancel.
+ The DUCC ID is the id of the process to cancel. (Required)
\item[$--$help]
Prints the usage text to the console.
- \item[$--$reason]
+ \item[$--$reason {[quoted string]}]
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.
If the user is not also a registered administrator this flag is ignored. (This helps to
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=1671426&r1=1671425&r2=1671426&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 Sun Apr 5 21:20:36 2015
@@ -60,11 +60,14 @@
\item[$--$debug ] Prints internal debugging information, intended for DUCC developers or
extended problem determination.
- \item[$--$environment {[env vars]}] Blank-delimited list of environment variable
- assignments for the process. Example:
- \begin{verbatim}
---environment TERM=xterm DISPLAY=:1.0
- \end{verbatim}
+ \item[$--$environment {[env vars]}] Blank-delimited list of environment variables and variable
+ assignments.
+ Entries will be copied from the user's environment if just the variable name is
+ specified, optionally with a final '*' for those with the same prefix.
+ If specified, this is used for all DUCC processes in the job. Example:
+\begin{verbatim}
+--environment TERM=xterm DISPLAY=:1.0 LANG UIMA_*
+\end{verbatim}
\begin{sloppypar}
Additional entries may be copied from the user's environment based on the setting of
@@ -94,7 +97,7 @@
not be directly specified.
\item[$--$process\_executable {[program name]}] This is the full path to a program to be
- executed.
+ executed. (Required)
\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
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=1671426&r1=1671425&r2=1671426&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 Sun Apr 5 21:20:36 2015
@@ -55,7 +55,7 @@
\item[$--$_memory\_size {[integer]}]
This specifies the amount of memory the reserved machine must support. After rounding
- up it must match the total usable memory on the machine.
+ up it must match the total usable memory on the machine. (Required)
\item[$--$scheduling\_class {[classname]}]
This specifies the name of the scheduling class the RM will use to determine the resource
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=1671426&r1=1671425&r2=1671426&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 Sun Apr 5 21:20:36 2015
@@ -113,9 +113,9 @@
\item[$--$autostart {[true or false]}] This indicates whether to register the service as
an autostarted service. If not specified, the default is {\em false}.
- \item[$--$classpath] The CLASSPATH used for the service, if the service is a
- \hyperref[sec:services.types]{UIMA-AS services}. If not specified, the CLASSPATH used
- by the {\em ducc\_services} command is used.
+ \item[$--$classpath {[path-string]}] The CLASSPATH used for the service, if the service is a
+ \hyperref[sec:services.types]{UIMA-AS services}. If not specified, the CLASSPATH of the
+ process invoking this request is used.
\item[$--$debug ]
Enable debugging messages. This is primarily for debugging DUCC itself.
@@ -126,9 +126,9 @@
Note: When used as a CLI option, the description string must usually be quoted to protect
it from the shell.
- \item[$--$environment {[env vars]}] Blank-delimited list of environment variable
+ \item[$--$environment {[env vars]}] Blank-delimited list of environment variables and variable
assignments for the service.
- Entries may be copied from the user's environment if just the variable name is
+ Entries will be copied from the user's environment if just the variable name is
specified, optionally with a final '*' for those with the same prefix. Example:
\begin{verbatim}
--environment TERM=xterm DISPLAY=:1.0 LANG UIMA_*
@@ -147,7 +147,7 @@ ducc.submit.environment.propagated
\item[$--$instances {[n]}] This specifies the number of instances to start when the service
is started. If not specified, the default is 1.
- Each instance has the DUCC_SERVICE_INSTANCE environment variable set to a unique sequence
+ Each instance has the DUCC\_SERVICE\_INSTANCE environment variable set to a unique sequence
number, starting from 0.
If an instabce is restarted it will be assigned the same number.
@@ -298,7 +298,7 @@ ducc.submit.environment.propagated
specified, the Agent's classpath is used (which will generally be incorrect.)
\end{sloppypar}
- \item[$--$service\_ping\_dolog {[boolean]}] If specified, write pinger stdout and stderr
+ \item[$--$service\_ping\_dolog {[true or false]}] If specified, write pinger stdout and stderr
messages to a log, else suppress the log. See \hyperref[sec:service.pingers]{Service Pingers}
for details.
@@ -469,7 +469,7 @@ ducc_services --ignore_references UIMA-A
\subsection{ducc\_services --modify options}
The modify function dynamically updates some of the attributes of a registered service. All
service options as described under {\em $--$register} other than the {\em service\_endpoint}
- and {\em process\_DD} may be modified wihtout re-registering the service. In most cases the
+ and {\em process\_descriptor\_DD} may be modified wihtout re-registering the service. In most cases the
service will need to be stopped and restarted for the update to apply.
The modify option is of the following form:
@@ -507,7 +507,7 @@ ducc_services --modify UIMA-AS:Service23
\item service\_ping\_dolog
\end{itemize}
- \subsection{ducc\_services --query Options}
+ \subsection{ducc\_services --query options}
The query function returns details about all known services of all types and classes, including
the DUCC ids of the service instances (for submitted and registered services), the DUCC ids of
the jobs using each service, and a summary of each service's queue and performance statistics,
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex?rev=1671426&r1=1671425&r2=1671426&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex Sun Apr 5 21:20:36 2015
@@ -55,9 +55,9 @@
If $--$wait\_for\_completion is not specified this option is ignored.
- \item[$--$classpath] The CLASSPATH used for the job. If specified, this is used
- for both the Job Driver and each Job Process. If not specified the CLASSPATH found by the underlying
- {\tt DuccJobSubmit.main()} method is used.
+ \item[$--$classpath {[path-string]}] The CLASSPATH used for the job. If specified, this is used
+ for both the Job Driver and each Job Process. If not specified, the CLASSPATH of the
+ process invoking this request is used.
\item[$--$debug] Enable debugging messages. This is primarily for debugging DUCC itself.
@@ -72,7 +72,7 @@
\item[$--$driver\_descriptor\_CR {[descriptor.xml]} ] This is the XML descriptor for the
Collection Reader. This
descriptor is a resource that is searched for in the filesystem or Java classpath as described
- in the ~\hyperref[par:cli.submit.notes]{notes below}.
+ in the ~\hyperref[par:cli.submit.notes]{notes below}. (Required)
\item[$--$driver\_descriptor\_CR\_overrides {[list]} ]
This is the Job Driver collection reader configuration overrides. They are specified as
@@ -113,9 +113,9 @@
Note: When used as a CLI option, the list must usually be
quoted to protect it from the shell.
- \item[$--$environment {[env vars]}] Blank-delimited list of environment variable
- assignments.
- Entries may be copied from the user's environment if just the variable name is
+ \item[$--$environment {[env vars]}] Blank-delimited list of environment variables and
+ variable assignments.
+ Entries will be copied from the user's environment if just the variable name is
specified, optionally with a final '*' for those with the same prefix.
If specified, this is used for all DUCC processes in the job. Example:
\begin{verbatim}
Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-unreserve.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-unreserve.tex?rev=1671426&r1=1671425&r2=1671426&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-unreserve.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-unreserve.tex Sun Apr 5 21:20:36 2015
@@ -38,7 +38,7 @@
\item[$--$debug ]
Prints internal debugging information, intended for DUCC developers or extended problem determination.
\item[$--$id {[jobid]}]
- The ID is the id of the reservation to cancel.
+ The ID is the id of the reservation to cancel. (Required)
\item[$--$help]
Prints the usage text to the console.
\item[$--$role\_administrator] The command is being issued in the role of a DUCC administrator.
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=1671426&r1=1671425&r2=1671426&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 Sun Apr 5 21:20:36 2015
@@ -126,12 +126,13 @@ ducc_job_submit --specification 1.job --
\begin{description}
\item[ducc\_submit] Submit a job for execution.
\item[ducc\_cancel] Cancel a job in progress.
- \item[ducc\_reserve] Request a reservation of full or partial machines.
+ \item[ducc\_reserve] Request a reservation of a full machine.
\item[ducc\_unreserve] Cancel a reservation.
\item[ducc\_monitor] Monitor the progress of a job that is already submitted.
\item[ducc\_process\_submit] Submit an arbitrary process (managed reservation) for execution.
\item[ducc\_process\_cancel] Cancel an arbitrary process.
- \item[ducc\_services] Register, unregister, start, stop, modify, and query a service.
+ \item[ducc\_services] Register, unregister, start, stop, modify, disable, enable,
+ ignore references, observe references, 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