1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
|
'\" t
.\" Title: globus-job-manager
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 03/29/2012
.\" Manual: GRAM5 Commands
.\" Source: University of Chicago
.\" Language: English
.\"
.TH "GLOBUS\-JOB\-MANAGER" "8" "03/29/2012" "University of Chicago" "GRAM5 Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
globus-job-manager \- Execute and monitor jobs
.SH "SYNOPSIS"
.HP \w'\fBglobus\-job\-manager\fR\ 'u
\fBglobus\-job\-manager\fR {\-type\ \fILRM\fR} [\-conf\ \fICONFIG_PATH\fR] [\-help] [\-globus\-host\-manufacturer\ \fIMANUFACTURER\fR] [\-globus\-host\-cputype\ \fICPUTYPE\fR] [\-globus\-host\-osname\ \fIOSNAME\fR] [\-globus\-host\-osversion\ \fIOSVERSION\fR] [\-globus\-gatekeeper\-host\ \fIHOST\fR] [\-globus\-gatekeeper\-port\ \fIPORT\fR] [\-globus\-gatekeeper\-subject\ \fISUBJECT\fR] [\-home\ \fIGLOBUS_LOCATION\fR] [\-target\-globus\-location\ \fITARGET_GLOBUS_LOCATION\fR] [\-condor\-arch\ \fIARCH\fR] [\-condor\-os\ \fIOS\fR] [\-history\ \fIHISTORY_DIRECTORY\fR] [\-scratch\-dir\-base\ \fISCRATCH_DIRECTORY\fR] [\-enable\-syslog] [\-stdio\-log\ \fILOG_DIRECTORY\fR] [\-log\-pattern\ \fIPATTERN\fR] [\-log\-levels\ \fILEVELS\fR] [\-state\-file\-dir\ \fISTATE_DIRECTORY\fR] [\-globus\-tcp\-port\-range\ \fIPORT_RANGE\fR] [\-globus\-tcp\-source\-range\ \fISOURCE_RANGE\fR] [\-x509\-cert\-dir\ \fITRUSTED_CERTIFICATE_DIRECTORY\fR] [\-cache\-location\ \fIGASS_CACHE_DIRECTORY\fR] [\-k] [\-extra\-envvars\ \fIVAR=VAL,\&.\&.\&.\fR] [\-seg\-module\ \fISEG_MODULE\fR] [\-audit\-directory\ \fIAUDIT_DIRECTORY\fR] [\-globus\-toolkit\-version\ \fITOOLKIT_VERSION\fR] [\-disable\-streaming] [\-disable\-usagestats] [\-usagestats\-targets\ \fITARGET\fR] [\-service\-tag\ \fISERVICE_TAG\fR]
.SH "DESCRIPTION"
.PP
The
\fBglobus\-job\-manager\fR
program is a servivce which starts and controls GRAM jobs which are executed by a local resource management system, such as LSF or Condor\&. The
\fBglobus\-job\-manager\fR
program is typically started by the
\fBglobus\-gatekeeper\fR
program and not directly by a user\&. It runs until all jobs it is managing have terminated or its delegated credentials have expired\&.
.PP
Typically, users interact with the
\fBglobus\-job\-manager\fR
program via client applications such as
\fBglobusrun\fR,
\fBglobus\-job\-submit\fR, or tools such as CoG jglobus or Condor\-G\&.
.PP
The full set of command\-line options to
\fBglobus\-job\-manager\fR
consists of:
.PP
\fB\-help\fR
.RS 4
Display a help message to standard error and exit
.RE
.PP
\fB\-type \fR\fB\fILRM\fR\fR
.RS 4
Execute jobs using the local resource manager named
\fILRM\fR\&.
.RE
.PP
\fB\-conf \fR\fB\fICONFIG_PATH\fR\fR
.RS 4
Read additional command\-line arguments from the file
\fICONFIG_PATH\fR\&. If present, this must be the first command\-line argument to the
\fBglobus\-job\-manager\fR
program\&.
.RE
.PP
\fB\-globus\-host\-manufacturer \fR\fB\fIMANUFACTURER\fR\fR
.RS 4
Indicate the manufacturer of the system which the jobs will execute on\&. This parameter sets the value of the
\fI$(GLOBUS_HOST_MANUFACTURER)\fR
RSL substitution to
\fIMANUFACTURER\fR
.RE
.PP
\fB\-globus\-host\-cputype \fR\fB\fICPUTYPE\fR\fR
.RS 4
Indicate the CPU type of the system which the jobs will execute on\&. This parameter sets the value of the
\fI$(GLOBUS_HOST_CPUTYPE)\fR
RSL substitution to
\fICPUTYPE\fR
.RE
.PP
\fB\-globus\-host\-osname \fR\fB\fIOSNAME\fR\fR
.RS 4
Indicate the operating system type of the system which the jobs will execute on\&. This parameter sets the value of the
\fI$(GLOBUS_HOST_OSNAME)\fR
RSL substitution to
\fIOSNAME\fR
.RE
.PP
\fB\-globus\-host\-osversion \fR\fB\fIOSVERSION\fR\fR
.RS 4
Indicate the operating system version of the system which the jobs will execute on\&. This parameter sets the value of the
\fI$(GLOBUS_HOST_OSVERSION)\fR
RSL substitution to
\fIOSVERSION\fR
.RE
.PP
\fB\-globus\-gatekeeper\-host \fR\fB\fIHOST\fR\fR
.RS 4
Indicate the host name of the machine which the job was submitted to\&. This parameter sets the value of the
\fI$(GLOBUS_GATEKEEPER_HOST)\fR
RSL substitution to
\fIHOST\fR
.RE
.PP
\fB\-globus\-gatekeeper\-port \fR\fB\fIPORT\fR\fR
.RS 4
Indicate the TCP port number of gatekeeper to which jobs are submitted to\&. This parameter sets the value of the
\fI$(GLOBUS_GATEKEEPER_PORT)\fR
RSL substitution to
\fIPORT\fR
.RE
.PP
\fB\-globus\-gatekeeper\-subject \fR\fB\fISUBJECT\fR\fR
.RS 4
Indicate the X\&.509 identity of the gatekeeper to which jobs are submitted to\&. This parameter sets the value of the
\fI$(GLOBUS_GATEKEEPER_SUBJECT)\fR
RSL substitution to
\fISUBJECT\fR
.RE
.PP
\fB\-home \fR\fB\fIGLOBUS_LOCATION\fR\fR
.RS 4
Indicate the path where the Globus Toolkit(r) is installed on the service node\&. This is used by the job manager to locate its support and configuration files\&.
.RE
.PP
\fB\-target\-globus\-location \fR\fB\fITARGET_GLOBUS_LOCATION\fR\fR
.RS 4
Indicate the path where the Globus Toolkit(r) is installed on the execution host\&. If this is omitted, the value specified as a parameter to
\fB\-home\fR
is used\&. This parameter sets the value of the
\fI$(GLOBUS_LOCATION)\fR
RSL substitution to
\fITARGET_GLOBUS_LOCATION\fR
.RE
.PP
\fB\-history \fR\fB\fIHISTORY_DIRECTORY\fR\fR
.RS 4
Configure the job manager to write job history files to
\fIHISTORY_DIRECTORY\fR\&. These files are described in the FILES section below\&.
.RE
.PP
\fB\-scratch\-dir\-base \fR\fB\fISCRATCH_DIRECTORY\fR\fR
.RS 4
Configure the job manager to use
\fISCRATCH_DIRECTORY\fR
as the default scratch directory root if a relative path is specified in the job RSL\*(Aqs
\fIscratch_dir\fR
attribute\&.
.RE
.PP
\fB\-enable\-syslog\fR
.RS 4
Configure the job manager to write log messages via syslog\&. Logging is further controlled by the argument to the
\fB\-log\-levels\fR
parameter described below\&.
.RE
.PP
\fB\-log\-pattern \fR\fB\fIPATTERN\fR\fR
.RS 4
Configure the job manager to write log messages to files named by the string
\fIPATTERN\fR\&. The
\fIPATTERN\fR
string may contain job\-independent RSL substitutions such as
$(HOME),
$(LOGNAME), etc, as well as the special RSL substition
$(DATE)
which will be resolved at log time to the date in YYYYMMDD form\&.
.RE
.PP
\fB\-stdio\-log \fR\fB\fILOG_DIRECTORY\fR\fR
.RS 4
Configure the job manager to write log messages to files in the
\fILOG_DIRECTORY\fR
directory\&. This is a backward\-compatible parameter, equivalent to
\fI\-log\-pattern \fR\fI\fILOG_DIRECTORY\fR\fR\fI/gram_$(DATE)\&.log\fR\&.
.RE
.PP
\fB\-log\-levels \fR\fB\fILEVELS\fR\fR
.RS 4
Configure the job manager to write log messages of certain levels to syslog and/or log files\&. The available log levels are
FATAL,
ERROR,
WARN,
INFO,
DEBUG, and
TRACE\&. Multiple values can be combined with the
|
character\&. The default value of logging when enabled is
FATAL|ERROR\&.
.RE
.PP
\fB\-state\-file\-dir \fR\fB\fISTATE_DIRECTORY\fR\fR
.RS 4
Configure the job manager to write state files to
\fISTATE_DIRECTORY\fR\&. If not specified, the job manager uses the default of
\fI$GLOBUS_LOCATION\fR/tmp/gram_job_state/\&. This directory must be writable by all users and be on a file system which supports POSIX advisory file locks\&.
.RE
.PP
\fB\-globus\-tcp\-port\-range \fR\fB\fIPORT_RANGE\fR\fR
.RS 4
Configure the job manager to restrict its TCP/IP communication to use ports in the range described by
\fIPORT_RANGE\fR\&. This value is also made available in the job environment via the
\fIGLOBUS_TCP_PORT_RANGE\fR
environment variable\&.
.RE
.PP
\fB\-globus\-tcp\-source\-range \fR\fB\fISOURCE_RANGE\fR\fR
.RS 4
Configure the job manager to restrict its TCP/IP communication to use source ports in the range described by
\fISOURCE_RANGE\fR\&. This value is also made available in the job environment via the
\fIGLOBUS_TCP_SOURCE_RANGE\fR
environment variable\&.
.RE
.PP
\fB\-x509\-cert\-dir \fR\fB\fITRUSTED_CERTIFICATE_DIRECTORY\fR\fR
.RS 4
Configure the job manager to search
\fITRUSTED_CERTIFICATE_DIRECTORY\fR
for its list of trusted CA certificates and their signing policies\&. This value is also made available in the job environment via the
\fIX509_CERT_DIR\fR
environment variable\&.
.RE
.PP
\fB\-cache\-location \fR\fB\fIGASS_CACHE_DIRECTORY\fR\fR
.RS 4
Configure the job manager to use the path
\fIGASS_CACHE_DIRECTORY\fR
for its temporary GASS\-cache files\&. This value is also made available in the job environment via the
\fIGLOBUS_GASS_CACHE_DEFAULT\fR
environment variable\&.
.RE
.PP
\fB\-k\fR
.RS 4
Configure the job manager to assume it is using Kerberos for authentication instead of X\&.509 certificates\&. This disables some certificate\-specific processing in the job manager\&.
.RE
.PP
\fB\-extra\-envvars \fR\fB\fIVAR=VAL,\&.\&.\&.\fR\fR
.RS 4
Configure the job manager to define a set of environment variables in the job environment beyond those defined in the base job environment\&. The format of the parameter to this argument is a comma\-separated sequence of VAR=VAL pairs, where
VAR
is the variable name and
VAL
is the variable\*(Aqs value\&. If the value is not specified, then the value of the variable in the job manager\*(Aqs environment is used\&. This option may be present multiple times on the command\-line or the job manager configuration file to append multiple environment settings\&.
.RE
.PP
\fB\-seg\-module \fR\fB\fISEG_MODULE\fR\fR
.RS 4
Configure the job manager to use the schedule event generator module named by
\fISEG_MODULE\fR
to detect job state changes events from the local resource manager, in place of the less efficient polling operations used in GT2\&. To use this, one instance of the
\fBglobus\-job\-manager\-event\-generator\fR
must be running to process events for the LRM into a generic format that the job manager can parse\&.
.RE
.PP
\fB\-audit\-directory \fR\fB\fIAUDIT_DIRECTORY\fR\fR
.RS 4
Configure the job manager to write audit records to the directory named by
\fIAUDIT_DIRECTORY\fR\&. This records can be loaded into a database using the
\fBglobus\-gram\-audit\fR
program\&.
.RE
.PP
\fB\-globus\-toolkit\-version \fR\fB\fITOOLKIT_VERSION\fR\fR
.RS 4
Configure the job manager to use
\fITOOLKIT_VERSION\fR
as the version for audit and usage stats records\&.
.RE
.PP
\fB\-service\-tag \fR\fB\fISERVICE_TAG\fR\fR
.RS 4
Configure the job manager to use
\fISERVICE_TAG\fR
as a unique identifier to allow multiple GRAM instances to use the same job state directories without interfering with each other\*(Aqs jobs\&. If not set, the value
untagged
will be used\&.
.RE
.PP
\fB\-disable\-streaming\fR
.RS 4
Configure the job manager to disable file streaming\&. This is propagated to the LRM script interface but has no effect in GRAM5\&.
.RE
.PP
\fB\-disable\-usagestats\fR
.RS 4
Disable sending of any usage stats data, even if
\fB\-usagestats\-targets\fR
is present in the configuration\&.
.RE
.PP
\fB\-usagestats\-targets \fR\fB\fITARGET\fR\fR
.RS 4
Send usage packets to a data collection service for analysis\&. The
\fITARGET\fR
string consists of a comma\-separated list of HOST:PORT combinations, each contaiing an optional list of data to send\&. See
\m[blue]\fBUsage Stats Packets\fR\m[]\&\s-2\u[1]\d\s+2
for more information about the tags\&. Special tag strings of
all
(which enables all tags) and
default
may be used, or a sequence of characters for the various tags\&. If this option is not present in the configuration, then the default of usage\-stats\&.globus\&.org:4810 is used\&.
.RE
.PP
\fB\-condor\-arch \fR\fB\fIARCH\fR\fR
.RS 4
Set the architecture specification for condor jobs to be
\fIARCH\fR
in job classified ads generated by the GRAM5 codnor LRM script\&. This is required for the condor LRM but ignored for all others\&.
.RE
.PP
\fB\-condor\-os \fR\fB\fIOS\fR\fR
.RS 4
Set the operating system specification for condor jobs to be
\fIOS\fR
in job classified ads generated by the GRAM5 codnor LRM script\&. This is required for the condor LRM but ignored for all others\&.
.RE
.SH "ENVIRONMENT"
.PP
If the following variables affect the execution of
\fBglobus\-job\-manager\fR
.PP
\fBHOME\fR
.RS 4
User\*(Aqs home directory\&.
.RE
.PP
\fBLOGNAME\fR
.RS 4
User\*(Aqs name\&.
.RE
.PP
\fBJOBMANAGER_SYSLOG_ID\fR
.RS 4
String to prepend to syslog audit messages\&.
.RE
.PP
\fBJOBMANAGER_SYSLOG_FAC\fR
.RS 4
Facility to log syslog audit messages as\&.
.RE
.PP
\fBJOBMANAGER_SYSLOG_LVL\fR
.RS 4
Priority level to use for syslog audit messages\&.
.RE
.PP
\fBGATEKEEPER_JM_ID\fR
.RS 4
Job manager ID to be used in syslog audit records\&.
.RE
.PP
\fBGATEKEEPER_PEER\fR
.RS 4
Peer information to be used in syslog audit records
.RE
.PP
\fBGLOBUS_ID\fR
.RS 4
Credential information to be used in syslog audit records
.RE
.PP
\fBGLOBUS_JOB_MANAGER_SLEEP\fR
.RS 4
Time (in seconds) to sleep when the job manager is started\&. [For debugging purposes only]
.RE
.PP
\fBGRID_SECURITY_HTTP_BODY_FD\fR
.RS 4
File descriptor of an open file which contains the initial job request and to which the initial job reply should be sent\&. This file descriptor is inherited from the
\fBglobus\-gatekeeper\fR\&.
.RE
.PP
\fBX509_USER_PROXY\fR
.RS 4
Path to the X\&.509 user proxy which was delegated by the client to the
\fBglobus\-gatekeeper\fR
program to be used by the job manager\&.
.RE
.PP
\fBGRID_SECURITY_CONTEXT_FD\fR
.RS 4
File descriptor containing an exported security context that the job manager should use to reply to the client which submitted the job\&.
.RE
.PP
\fBGLOBUS_USAGE_TARGETS\fR
.RS 4
Default list of usagestats services to send usage packets to\&.
.RE
.PP
\fBGLOBUS_TCP_PORT_RANGE\fR
.RS 4
Default range of allowed TCP ports to listen on\&. The
\fB\-globus\-tcp\-port\-range\fR
command\-line option overrides this\&.
.RE
.PP
\fBGLOBUS_TCP_SOURCE_RANGE\fR
.RS 4
Default range of allowed TCP ports to bind to\&. The
\fB\-globus\-tcp\-source\-range\fR
command\-line option overrides this\&.
.RE
.SH "FILES"
.PP
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fILRM\fR\&.\fITAG\fR\&.\fIred\fR
.RS 4
Job manager delegated user credential\&.
.RE
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fILRM\fR\&.\fITAG\fR\&.\fIlock\fR
.RS 4
Job manager state lock file\&.
.RE
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fILRM\fR\&.\fITAG\fR\&.\fIpid\fR
.RS 4
Job manager pid file\&.
.RE
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fILRM\fR\&.\fITAG\fR\&.\fIsock\fR
.RS 4
Job manager socket for inter\-job manager communications\&.
.RE
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fIJOB_ID\fR/
.RS 4
Job\-specific state directory\&.
.RE
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fIJOB_ID\fR/stdin
.RS 4
Standard input which has been staged from a remote URL\&.
.RE
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fIJOB_ID\fR/stdout
.RS 4
Standard output which will be staged from a remote URL\&.
.RE
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fIJOB_ID\fR/stderr
.RS 4
Standard error which will be staged from a remote URL\&.
.RE
.PP
\fB$HOME\fR/\&.globus/job/\fIHOSTNAME\fR/\fIJOB_ID\fR/x509_user_proxy
.RS 4
Job\-specific delegated credential\&.
.RE
.PP
\fB$GLOBUS_LOCATION\fR/tmp/gram_job_state/job\&.\fIHOSTNAME\fR\&.\fIJOB_ID\fR
.RS 4
Job state file\&.
.RE
.PP
\fB$GLOBUS_LOCATION\fR/tmp/gram_job_state/job\&.\fIHOSTNAME\fR\&.\fIJOB_ID\fR\&.lock
.RS 4
Job state lock file\&. In most cases this will be a symlink to the job manager lock file\&.
.RE
.PP
\fB$GLOBUS_LOCATION\fR/etc/globus\-job\-manager\&.conf
.RS 4
Default location of the global job manager configuration file\&.
.RE
.PP
\fB$GLOBUS_LOCATION\fR/etc/grid\-services/jobmanager\-\fILRM\fR
.RS 4
Default location of the LRM\-specific gatekeeper configuration file\&.
.RE
.PP
\fB$GLOBUS_LOCATION\fR/etc/globus/gram/job\-\-manager\&.rvf
.RS 4
Default location of the site\-specific job manager RSL validation file\&.
.RE
.PP
\fB$GLOBUS_LOCATION\fR/etc/globus/gram/\fIlrm\fR\&.rvf
.RS 4
Default location of the site\-specific job manager RSL validation file for the named lrm\&.
.RE
.SH "SEE ALSO"
.PP
\fBglobusrun\fR(1),
\fBglobus-gatekeeper\fR(8),
\fBglobus-personal-gatekeeper\fR(1),
\fBglobus-gram-audit\fR(8)
.SH "NOTES"
.IP " 1." 4
Usage Stats Packets
.RS 4
\%http://confluence.globus.org/display/~bester/GRAM5+Usage+Stats+Packets
.RE
|