[moira.git] / man / dcm.8

.TH DCM 8 "30 Nov 1988" "Project Athena"
\" RCSID: $Header$
.SH NAME
dcm, startdcm \- build config files from Moira database and update servers
.SH SYNOPSIS
.B dcm
[-d level]
.br
.B startdcm
.SH DESCRIPTION
The
.B dcm
must be run periodically on the Moira server.  It is usually run every
15 minutes by the
.I cron
daemon.  Rather than invoke
.B dcm
directly, cron runs
.B startdcm,
which starts the dcm running in the proper working directory and
captures logging messages.
.PP
The
.B dcm
may be disabled by the presence of the file
.I /etc/nodcm
or by setting the value of
.I dcm_enable
to zero in the Moira database.  Debug mode may be enabled in the dcm by
specifying an integer on the command line or by setting the
environment variable
.B DEBUG.
The command line value will override the environment variable.  Three
bits are currently defined in the debug value: DBG_PLAIN = 01,
DBG_VERBOSE = 02, DBG_TRACE = 04.  Logging is done to standard output.
If critical errors are detected, they are logged to
.B /u1/sms/critical.log
and in a zephyrgram to class
.B Moira
instance
.B DCM
in addition to standard output.
For the
.B dcm
to function properly,
.I root
must both be authorized to access each of the tables by RTI Ingres,
and on the query acls for each of the queries the 
.B dcm
will execute.
.PP
For the actual generation of config files, the
.B dcm
will fork off generator programs of the form
.B /u1/sms/bin/\fIservice\fB.gen.
Each generator takes as an argument the name of the output file to
produce.  Many of them also require working directories in
.B /u1/sms/dcm/\fIservice\fB.
A generator exits with a status code defined in
.I <mr_et.h>.
In particular,
.B MR_NO_CHANGE
is a common exit status if the database hasn't changed since the last
time this generator was run.
.PP
.B startdcm
sets its working directory to the root, disconnects from the terminal
and puts itself in the background.  It then starts
.B /u1/sms/bin/dcm,
and will capture lines the dcm writes to standard output and log them
in
.B /u1/sms/dcm.log
along with a timestamp.
.B startdcm
will also log the exit status of the
.B dcm
if it is non-zero.
.SH FILES
/u1/sms/dcm.log
.br
/u1/sms/critical.log
.br
/u1/sms/dcm/locks/* \- empty files will be created here for advisory locks.
.br
/u1/sms/bin/*.gen \- service file generators will be searched for
here.
.br
/tmp/tkt_dcm \- temporary Kerberos ticket storage.
.br
/etc/srvtab \- The dcm must be able to get Kerberos tickets for "sms"
(null instance).
.SH "SEE ALSO"
The Project Athena Technical Plan section on Moira.
Commit	Line	Data
5834a392	1	.TH DCM 8 "30 Nov 1988" "Project Athena"
	2	\" RCSID: $Header$
	3	.SH NAME
7014af98	4	dcm, startdcm \- build config files from Moira database and update servers
5834a392	5	.SH SYNOPSIS
	6	.B dcm
	7	[-d level]
	8	.br
	9	.B startdcm
	10	.SH DESCRIPTION
	11	The
	12	.B dcm
7014af98	13	must be run periodically on the Moira server. It is usually run every
5834a392	14	15 minutes by the
	15	.I cron
	16	daemon. Rather than invoke
	17	.B dcm
	18	directly, cron runs
	19	.B startdcm,
	20	which starts the dcm running in the proper working directory and
	21	captures logging messages.
	22	.PP
	23	The
	24	.B dcm
	25	may be disabled by the presence of the file
	26	.I /etc/nodcm
	27	or by setting the value of
	28	.I dcm_enable
7014af98	29	to zero in the Moira database. Debug mode may be enabled in the dcm by
5834a392	30	specifying an integer on the command line or by setting the
	31	environment variable
	32	.B DEBUG.
	33	The command line value will override the environment variable. Three
	34	bits are currently defined in the debug value: DBG_PLAIN = 01,
	35	DBG_VERBOSE = 02, DBG_TRACE = 04. Logging is done to standard output.
	36	If critical errors are detected, they are logged to
	37	.B /u1/sms/critical.log
	38	and in a zephyrgram to class
7014af98	39	.B Moira
5834a392	40	instance
	41	.B DCM
	42	in addition to standard output.
8d655ac7	43	For the
	44	.B dcm
	45	to function properly,
	46	.I root
	47	must both be authorized to access each of the tables by RTI Ingres,
	48	and on the query acls for each of the queries the
	49	.B dcm
	50	will execute.
	51	.PP
5834a392	52	For the actual generation of config files, the
5834a392	53	.B dcm
7014af98	54	will fork off generator programs of the form
5834a392	55	.B /u1/sms/bin/\fIservice\fB.gen.
	56	Each generator takes as an argument the name of the output file to
	57	produce. Many of them also require working directories in
	58	.B /u1/sms/dcm/\fIservice\fB.
	59	A generator exits with a status code defined in
7d37e1a9	60	.I <mr_et.h>.
5834a392	61	In particular,
7d37e1a9	62	.B MR_NO_CHANGE
5834a392	63	is a common exit status if the database hasn't changed since the last
	64	time this generator was run.
	65	.PP
	66	.B startdcm
	67	sets its working directory to the root, disconnects from the terminal
	68	and puts itself in the background. It then starts
	69	.B /u1/sms/bin/dcm,
	70	and will capture lines the dcm writes to standard output and log them
	71	in
	72	.B /u1/sms/dcm.log
	73	along with a timestamp.
	74	.B startdcm
	75	will also log the exit status of the
	76	.B dcm
	77	if it is non-zero.
	78	.SH FILES
	79	/u1/sms/dcm.log
	80	.br
	81	/u1/sms/critical.log
	82	.br
	83	/u1/sms/dcm/locks/* \- empty files will be created here for advisory locks.
	84	.br
	85	/u1/sms/bin/*.gen \- service file generators will be searched for
	86	here.
	87	.br
34e7a903	88	/tmp/tkt_dcm \- temporary Kerberos ticket storage.
	89	.br
	90	/etc/srvtab \- The dcm must be able to get Kerberos tickets for "sms"
	91	(null instance).
5834a392	92	.SH "SEE ALSO"
7014af98	93	The Project Athena Technical Plan section on Moira.