Commit e9906e5c authored by Paul Rich's avatar Paul Rich
Browse files

Documentation update for Cray Systems.

This was data that needed to be added to the manpages for Cray systems.
parent 37de4f0e
......@@ -503,7 +503,39 @@ command. The default is 300 seconds.
.B bgtype
The type of BlueGene being run on. For BlueGene/Q this should be set to 'bgq'.
.SS "CRAY SECTIONS"
.SS "[alps]"
.TP
.B basil
The path to Cray's apbasil command. The default path is
/opt/cray/default/alps/bin/apbasil
.TP
.B apkill
The path to Cray's apkill command. The default path is
/opt/cray/alps/default/bin/apkill
.TP
.B default_depth
The default processors per node. This should be set to the number of KNL cores
on each node for XC40 systems. The default value is 72.
.SS [alpssystem]
.TP
.B pgroup_startup_timeout
The time to allow for process group startup in seconds. The default is 120
seconds.
.TP
.B save_me_interval
The minimum interval that Cobalt will wait between saving statefiles for this
component, in seconds. By default the interval is 10.0 seconds. Under periods
of high load on the component, the interval between statefiles may be longer.
.TP
.B temp_reservation_time
The default time for the temporary allocation reservation for starting jobs in
seconds. The default is 300 seconds.
.TP
.B update_thread_timeout
The polling interval for state updates from ALPS in seconds. The default is
10 seconds.
.SH "ENVIRONMENT"
.B COBALT_CONFIG_FILES
......
.TH "nodesadm" 8
.TH "nodeadm" 8
.SH "NAME"
nodeadm is the administrative interface for cluster systems.
.SH "SYNOPSIS"
.B nodeadm [-l] [--down part1 part2] [--up part1 part2]
.B nodeadm
.R [options] [list\ of\ nodes]
.SH "DESCRIPTION"
.TP
Allows one to mark resource as being down, or back up if there are schedulable again and it handles queue-resource associations.
Allows one to mark resource as being down, or back up if there are scheduleable
again and it handles queue-resource associations.
.SH "OPTIONS"
.TP
.B \-b\ [list\ of\ nodes]
.B [Cray Only]
Print detailed information for all nodes in the list of node ids.
This will accept hyphenated ranges as well. All ranges are inclusive.
.TP
.B \-d \-\-debug
Turn on communication debugging.
......@@ -22,17 +28,23 @@ Displays the usage and a brief descriptions of the options
.B \-\-version
Displays client revision and Cobalt version
.TP
.B \-\-down
mark nodes as down
.B \-\-down [list\ of\ nodes]
Mark nodes as down
.TP
.B \-\-up
mark nodes as up (even if allocated)
.B \-\-up\ [list\ of\ nodes]
Mark nodes as up. If the node is not in a usuable state or is allocated,
this may cause unexpected behavior.
.TP
.B \-\-queue
set queue associations
.B \-\-queue\ [queue1:queue2:...:queueN]\ [list\ of\ nodes]
Set queue associations. The list of queues to set on a node is ':'-delimited.
.TP
.B \-l \-\-list'
list node states
.SH "NOTES"
.SS "Cray Systems"
On Cray systems nodes are referenced by their integer node id. Nodes may be
specified as a comma-delimited list. Ranges of node id's may be compacted with a
hyphen to an inclusive range, i.e. 1-4 will expand to 1,2,3,4.
.SH "SEE ALSO"
.BR nodelist (1)
......
......@@ -11,7 +11,11 @@ nodelist
List resources on the cluster system.
.SH "OPTIONS"
.TP
.B \-b <list of node ids>
.B [Cray Only]
Print detailed information for all nodes in the list of node ids.
This will accept hyphenated ranges as well. All ranges are inclusive.
.TP
.B \-d \-\-debug
Turn on communication debugging.
......
......@@ -4,73 +4,109 @@ setres \- Create or modify a cobalt scheduler reservation
.SH "SYNOPSIS"
.B setres [modify or create reservation options] partition1 [ partition2 ... partitionN ]
.B setres [id changing options]
.B setres [id changing options]
.SH "DESCRIPTION"
.TP
This program creates or modifies a scheduler reservation.
Creates or modifies a scheduler reservation. Reservation and cycle ids may also
be reset.
.SH "OPTIONS TO MODIFY OR CREATE RESERVATION (partition arguments required)"
.TP
.B \-\-debug
Turn on communication debugging.
.TP
.B \-h \-\-help
Displays the usage and a brief descriptions of the options
.TP
.B \-\-version
Displays client revision and Cobalt version
.TP
.B \-A \-\-project
.SS "RESERVATION CREATION AND MODIFICATION"
At a minimum all reservation creation requires use of the
.B -n, -s
and
.B -d
flags. Partions and nodes must be specified as positional arguments or via the
.B -p
flag.
.TP
.B \-A \-\-project [project\ name]
Set project name
.TP
.B \-D \-\-defer
Defer current (or next) iteration of recurring reservation (must be
used with -m)
.B \-\-allow_passthrough
Allow pass through connection on systems with interconnects that allow
passthrough communication.
.TP
.B \-\-block_passthrough
Block pass through connections on systems with interconnects that allow
passthrough communication.
.TP
.B \-c \-\-cycletime
.B \-c \-\-cycletime [time]
Set the cycle time (in minutes or DD:HH:MM:SS). This is the amount of
time from reservation start until it is automatically renewed. This
can be used to create repeating reservations.
.TP
.B \-d \-\-duration
.B \-d \-\-duration [time]
Set duration (in minutes or HH:MM:SS)
.TP
.B \-D \-\-defer
Defer current (or next) iteration of recurring reservation. This must be used
with the
.B -m
flag.
.TP
.B \-\-debug
Turn on communication debugging.
.TP
.B \-h \-\-help
Displays the usage and a brief descriptions of the options
.TP
.B \-m \-\-modify
Modify an existing reservation, specified with -n.
Modify an existing reservation. The target reservation specified with
.BR -n .
.TP
.B \-n \-\-name
Set reservation name
Set reservation name. Names must be unique for all pending and active
reservations on a system.
.TP
.B \-p \-\-partition
Set use partition. Now optional
Set use partition. Now optional. Paritions/nodes to reserve may be specified as
postional arguments. All nodes/partitoins in a reservation must exist and must
be managed by the system component at the time the reservation is set.
.TP
.B \-q \-\-queue
Set the queue name, if something other than the standard reservation naming convention is desired.
.TP
.B \-s \-\-starttime
Set start time (in format YYYY_MM_DD-HH:MM)
Set the queue name, if something other than the standard reservation naming
convention is desired. Queues may already exist and have jobs in them.
Jobs currently running in a target queue will not be affected by applying a
reservation to the queue. Jobs that are queued in the target queue will not
start until the reservation becomes active. Jobs in a reservations against an
existing queue will be permitted to run on all nodes in that queue.
If a queue isn't specified, a queue R.name will be created where name is the
reservation name specified by the
.B -n
argument.
.TP
.B \-u \-\-user
Set user for reservation. Set to "*" for all users.
.B \-s \-\-starttime [date]
Set start time (supported formats include YYYY-MM-DD-HH:MM or YYYY_MM_DD-HH:MM).
.TP
.B \-\-allow_passthrough
Allow pass through connection
.B \-u \-\-user [list\ of\ users]
Set user(s) for reservation. Set to "*" for all users. User names may be
provided as a ':'-delimited list. User names must be valid on the node where
.BR setres (8)
is running.
.TP
.B \-\-block_passthrough
Block pass through connections
.SH "ID CHANGING OPTIONS (no partition arguments)"
.B \-\-version
Displays client revision and Cobalt version
.SS "ID MODIFICATION OPTIONS"
These options must not be used with the other reservation control options.
.TP
.B \-\-cycle_id
set cycle id
.B \-\-cycle_id [cycleid]
Set cycle id
.TP
.B \-\-force_id
only used with \-\-res_id or \-\-cycle_id options
.B \-\-force_id
Only used with \-\-res_id or \-\-cycle_id options. Will force the id generator
to start with the specified value. Improper use of this option may cause
non-unique reservation ids and cycle ids to occur.
.TP
.B \-\-res_id
reservation id (int)
.B \-\-res_id [resid]
set the reservation id
.SH "NOTES"
On Cray systems nodes are referenced by their integer node id. Nodes may be
specified as a comma-delimited list. Ranges of node id's may be compacted with a
hyphen to an inclusive range, i.e. 1-4 will expand to 1,2,3,4.
.SH "SEE ALSO"
.BR showres (1),
.BR releaseres (8)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment