xref: /onnv-gate/usr/src/cmd/bnu/Grades (revision 0:68f95e015346)
1*0Sstevel@tonic-gate#ident	"%Z%%M%	%I%	%E% SMI"	/* from SVR4 bnu:Grades 1.1 */
2*0Sstevel@tonic-gate#
3*0Sstevel@tonic-gate# CDDL HEADER START
4*0Sstevel@tonic-gate#
5*0Sstevel@tonic-gate# The contents of this file are subject to the terms of the
6*0Sstevel@tonic-gate# Common Development and Distribution License, Version 1.0 only
7*0Sstevel@tonic-gate# (the "License").  You may not use this file except in compliance
8*0Sstevel@tonic-gate# with the License.
9*0Sstevel@tonic-gate#
10*0Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
11*0Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
12*0Sstevel@tonic-gate# See the License for the specific language governing permissions
13*0Sstevel@tonic-gate# and limitations under the License.
14*0Sstevel@tonic-gate#
15*0Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
16*0Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
17*0Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
18*0Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
19*0Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
20*0Sstevel@tonic-gate#
21*0Sstevel@tonic-gate# CDDL HEADER END
22*0Sstevel@tonic-gate#
23*0Sstevel@tonic-gate#
24*0Sstevel@tonic-gate#	Grades provides a orderly means of partitioning queued jobs into
25*0Sstevel@tonic-gate#	workloads that compete amongst its own type. Workloads can be partioned
26*0Sstevel@tonic-gate#	according to size of the jobs, on a priority basis or a combination
27*0Sstevel@tonic-gate#	of both. Along with each grades is a list of users or groups that can
28*0Sstevel@tonic-gate#	use the grade, so that only select users can use the job grade.
29*0Sstevel@tonic-gate#	Partitioning of workloads is to be set by the uucp or system administrator.
30*0Sstevel@tonic-gate#
31*0Sstevel@tonic-gate#	Format:
32*0Sstevel@tonic-gate#
33*0Sstevel@tonic-gate#	user_job_grade			an ascii string that defines a
34*0Sstevel@tonic-gate#					grade for a workload partition.
35*0Sstevel@tonic-gate#	system_job_grade		an ascii character, A-Z, a-z,
36*0Sstevel@tonic-gate#					with A having the higest priority
37*0Sstevel@tonic-gate#					and z with the lowest priority.
38*0Sstevel@tonic-gate#	job_size			a number which is the maximum limit
39*0Sstevel@tonic-gate#					of bytes that a job can have to
40*0Sstevel@tonic-gate#					be placed in the queue. There are
41*0Sstevel@tonic-gate#					shorthand expressions that can be used
42*0Sstevel@tonic-gate#					to code the job_size field. K, M, and
43*0Sstevel@tonic-gate#					Any can used and have the meaning kilo-
44*0Sstevel@tonic-gate#					byte, megabyte, and no maximum,
45*0Sstevel@tonic-gate#					respectively. K and M must have an
46*0Sstevel@tonic-gate#					integer prefix.
47*0Sstevel@tonic-gate#	permit_type			a keyword that denotes how to interpret
48*0Sstevel@tonic-gate#					the id_list is contained in this field.
49*0Sstevel@tonic-gate#					User, non-user, group, non-group are
50*0Sstevel@tonic-gate#					the only valid arguments of this field.
51*0Sstevel@tonic-gate#	id_list				a list of login names or group names
52*0Sstevel@tonic-gate#					that are permitted or denied to queue
53*0Sstevel@tonic-gate#					jobs to this job grade. The list is to
54*0Sstevel@tonic-gate#					be seperated by whitespace and terminated
55*0Sstevel@tonic-gate#					by a newline character. The reserved word
56*0Sstevel@tonic-gate#					Any is used permit anyone to queue to
57*0Sstevel@tonic-gate#					a job grade if User is the permit_type.
58*0Sstevel@tonic-gate#
59*0Sstevel@tonic-gate#	Since the user job grade may be bound to more than one system job grade,
60*0Sstevel@tonic-gate#	it is important to note that the Grades file will be searched
61*0Sstevel@tonic-gate#	sequentially for occurences of a user job grade. Since the names of
62*0Sstevel@tonic-gate#	user job grades may not be the same from system to system, we have
63*0Sstevel@tonic-gate#	reserved the names of three job grades so that the user may see some
64*0Sstevel@tonic-gate#	similiarity across different systems.
65*0Sstevel@tonic-gate#
66*0Sstevel@tonic-gate#	If the Grades file does not exist or it is unreadable, then user defined
67*0Sstevel@tonic-gate#	grades will not be allowed on the system.
68*0Sstevel@tonic-gate#
69*0Sstevel@tonic-gatehigh	F	Any	User	Any
70*0Sstevel@tonic-gatemedium	S	Any	User	Any
71*0Sstevel@tonic-gatelow	n	Any	User	Any
72