diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 53359bd66367d8ec354e1d127bb5690500545cda..384491c64be20c05d85b487bfa7c9c31e68c52d3 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -91,6 +91,7 @@ man3_MANS = man3/slurm_hostlist_create.3 \ man5_MANS = man5/bluegene.conf.5 \ man5/slurm.conf.5 \ + man5/slurmdbd.conf.5 \ man5/wiki.conf.5 man8_MANS = man8/slurmctld.8 \ diff --git a/doc/man/Makefile.in b/doc/man/Makefile.in index 3ad5a40de5ff53f8b1fcd127623bf1d18a422544..eeef3ac6449f71594c09e27cf4e610eca04135c0 100644 --- a/doc/man/Makefile.in +++ b/doc/man/Makefile.in @@ -329,6 +329,7 @@ man3_MANS = man3/slurm_hostlist_create.3 \ man5_MANS = man5/bluegene.conf.5 \ man5/slurm.conf.5 \ + man5/slurmdbd.conf.5 \ man5/wiki.conf.5 man8_MANS = man8/slurmctld.8 \ diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5 index 10fa0bd7913b3a4f3580045164b0c0a31623e766..df8f0e22fc52b08b6afe6383e09f873ab7d3f000 100644 --- a/doc/man/man5/slurm.conf.5 +++ b/doc/man/man5/slurm.conf.5 @@ -42,7 +42,7 @@ This may be fine for testing purposes, but "http://www.theether.org/authd/" for more information). "auth/munge" indicates that Chris Dunlap's munge is to be used (this is the best supported authentication mechanism for SLURM, -see "https://computing.llnl.gov/linux/munge/" for more information). +see "http://home.gna.org/munge/" for more information). All SLURM daemons and commands must be terminated prior to changing the value of \fBAuthType\fR and later restarted (SLURM jobs can be preserved). diff --git a/doc/man/man5/slurmdbd.conf.5 b/doc/man/man5/slurmdbd.conf.5 new file mode 100644 index 0000000000000000000000000000000000000000..7d4830be7f5019266c1d686636c486c8afaeb12c --- /dev/null +++ b/doc/man/man5/slurmdbd.conf.5 @@ -0,0 +1,162 @@ +.TH "slurmdbd.conf" "5" "February 2008" "slurmdbd.conf 1.3" "Slurm configuration file" +.SH "NAME" +slurmdbd.conf \- Slurm Database Daemon (SlurmDBD) configuration file + +.SH "DESCRIPTION" +\fB/etc/slurmdbe.conf\fP is an ASCII file which describes Slurm Database +Daemon (SlurmDBD) configuration information. +.LP +The file location can be modified at system build time using the +DEFAULT_SLURM_CONF parameter. +The contents of the file are case insensitive except for the names of nodes +and files. Any text following a "#" in the configuration file is treated +as a comment through the end of that line. +The size of each line in the file is limited to 1024 characters. +Changes to the configuration file take effect upon restart of +SlurmDbd or daemon receipt of the SIGHUP signal unless otherwise noted. +.LP +The overall configuration parameters available include: + +.TP +\fBAuthInfo\fR +Additional information to be used for authentication of communications +with the Slurm control daemon (slurmctld) on each cluster. +The interpretation of this option is specific to the configured \fBAuthType\fR. +In the case of \fIauth/munge\fR, this can be configured to use a Munge daemon +specifically configured to provide authentication between clusters while the +default Munge daemon provides authentication within a cluster. +In that case, this will specify the pathname of the socket to use. +The default value is NULL, which results in the default authentication +mechanism being used. + +.TP +\fBAuthType\fR +Define the authentication method for communications between SLURM +components. +Acceptable values at present include "auth/none", "auth/authd", +and "auth/munge". +The default value is "auth/none", which means the UID included in +communication messages is not verified. +This may be fine for testing purposes, but +\fBdo not use "auth/none" if you desire any security\fR. +"auth/authd" indicates that Brett Chun's authd is to be used (see +"http://www.theether.org/authd/" for more information). +"auth/munge" indicates that LLNL's Munge system is to be used +(this is the best supported authentication mechanism for SLURM, +see "http://home.gna.org/munge/" for more information). +SlurmDbd must be terminated prior to changing the value of \fBAuthType\fR +and later restarted. + +.TP +\fBDbdAddr\fR +Name that \fBDbdHost\fR should be referred to in +establishing a communications path to the Slurm Database Daemon. +This name will be used as an argument to the gethostbyname() +function for identification. For example, "elx0000" might be used +to designate the ethernet address for node "lx0000". +By default the \fBDbdAddr\fR will be identical in value to +\fBDbdHost\fR. +This value must be equal to the \fBSlurmDbdAddr\fR parameter in +the slurm.conf file. + +.TP +\fBDbdHost\fR +The name of the machine where the Slurm Database Daemon is executed. +This should be a node name without the full domain name (e.g. "lx0001"). +This value must be specified. + +.TP +\fBDbdPort\fR +The port number that the Slurm Database Daemon (slurmdbd) listens +to for work. The default value is SLURMDBD_PORT as established at system +build time. If none is explicitly specified, it will be set to 6819. +This value must be equal to the \fBSlurmDbdPort\fR parameter in the +slurm.conf file. + +.TP +\fBDebugLevel\fR +The level of detail to provide the Slurm Database Daemon's logs. +Values from 0 to 7 are legal, with `0' being "quiet" operation and +`7' being insanely verbose. +The default value is 3. + +.TP +\fBLogFile\fR +Fully qualified pathname of a file into which the Slurm Database Daemon's +logs are written. +The default value is none (performs logging via syslog). + +.TP +\fBPidFile\fR +Fully qualified pathname of a file into which the Slurm Database Daemon +may write its process ID. This may be used for automated signal processing. +The default value is "/var/run/slurmdbd.pid". + +.TP +\fBSlurmUser\fR +The name of the user that the \fBslurmctld\fR daemon executes as. +This user must exist on the machine executing the Slurm Database Daemon +and have the same user ID as the hosts on which \fBslurmctld\fR execute. +For security purposes, a user other than "root" is recommended. +The default value is "root". + +.TP +\fBStoragePassword\fR +Define the password used to gain access to the database to store +the job accounting data. + +.TP +\fBStorageUser\fR +Define the name of the user we are going to connect to the database +with to store the job accounting data. + +.SH "EXAMPLE" +.LP +# +.br +# Sample /etc/slurmdbd.conf +.br +# +.br +AuthInfo=/var/run/munge/munge.socket.2 +.br +AuthType=auth/munge +.br +DebugLevel=4 +.br +LogFile=/var/log/slurmdbd.log +.br +PidFile=/var/tmp/jette/slurmdbd.pid +.br +SlurmUser=slurm_mgr +.br +StoragePassword=shazaam +.br +StorageUser=database_mgr + +.SH "COPYING" +Copyright (C) 2008 Lawrence Livermore National Security. +Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). +UCRL\-CODE\-226842. +.LP +This file is part of SLURM, a resource management program. +For details, see <https://computing.llnl.gov/linux/slurm/>. +.LP +SLURM is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2 of the License, or (at your option) +any later version. +.LP +SLURM is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +details. + +.SH "FILES" +/etc/slurmdbd.conf + +.SH "SEE ALSO" +.LP +\fBslurm.conf\fR(5), +\fBslurmctld\fR(8), \fBslurmdbd\fR(8) +\fBsyslog\fR(2)