NAME

       wiki.conf - Slurm configuration file for wiki and wiki2 scheduler plugins

DESCRIPTION

       wiki.conf  is  an  ASCII  file  which  describes  wiki  and wiki2 scheduler specific Slurm
       configuration information.  The file location can be modified at system build  time  using
       the   DEFAULT_SLURM_CONF  parameter  or  at  execution  time  by  setting  the  SLURM_CONF
       environment variable. The file will always  be  located  in  the  same  directory  as  the
       slurm.conf file.

       Parameter  names are case insensitive.  Any text following a "#" in the configuration file
       is treated as a comment through the end of that line.  Changes to the  configuration  file
       take  effect  upon  restart  of  Slurm  daemons,  daemon  receipt of the SIGHUP signal, or
       execution of the command "scontrol reconfigure" unless otherwise noted.

       The overall configuration parameters available include:

       AuthKey
              Authentication key for communications.  This  should  be  no  more  than  a  32-bit
              unsigned integer and match the KEY configured in the moab-private.cnf file (for the
              Moab Scheduler) or the --with-key= value used to configure the Maui Scheduler.

       EHost  Name the computer on which Moab server executes.  It  is  used  in  establishing  a
              communications  path for event notification.  By default EHost will be identical in
              value to the ControlAddr configured in slurm.conf.  Not applicable to wiki  plugin,
              only the wiki2 plugin.

       EHostBackup
              Name  the  computer  on  which  the  backup  Moab  server  executes.  It is used in
              establishing a communications path for event notification.  By default  EHostBackup
              will  be  identical  in  value  to  the  BackupAddr  configured in slurm.conf.  Not
              applicable to wiki plugin, only the wiki2 plugin.

       EPort  Port to be used to notify Moab of events (job submitted to Slurm,  job  terminates,
              etc.).  This numeric value should match EPORT configured in the moab.cnf file.  Not
              applicable to wiki plugin, only the wiki2 plugin.

       ExcludePartitions
              Identifies partitions whose jobs are to be scheduled directly by Slurm rather  than
              Moab/Maui.   This  only effects jobs which are submitted using Slurm commands (i.e.
              srun, salloc or sbatch, NOT msub from Moab).  These jobs will  be  scheduled  on  a
              First-Come-First-Served  basis  directly by Slurm.  Note that Slurm recognizes jobs
              submitted via msub based upon the value FirstJobId configured in  slurm.conf.   Set
              the  values MINJOBID and MAXJOBID in moab.cfg accordingly.  For example MINJOBID=1,
              MAXJOBID=65535 and FirstJobId=65536.  Jobs submitted using msub will  have  job  ID
              values  in  the  range  of  1  and  65535 while jobs submitted directly using Slurm
              commands will have a job ID of 65536 or higher.  Moab/Maui  controls  for  resource
              reservation,  fair share scheduling, etc. will not apply to the initiation of these
              jobs.  While Moab/Maui will not control the initiation of jobs in these partitions,
              it  will  account  for  and  report  the jobs.  If more than one partition is to be
              scheduled directly by Slurm, use a comma separator between their names.   This  may
              provide faster response times than Moab/Maui scheduling.

       HidePartitionJobs
              Identifies  partitions  whose jobs are not to be reported to Moab/Maui.  These jobs
              will not be accounted for or otherwise visible to Moab/Maui.  Any partitions listed
              here  must  also  be listed in ExcludePartitions.  This only effects jobs which are
              submitted using Slurm commands (i.e.  srun, salloc or sbatch, NOT msub from  Moab).
              If  more  than  one  partition  is  to  have its jobs hidden, use a comma separator
              between their names.

       HidePartitionNodes
              Identifies partitions whose nodes are not to be reported to Moab/Maui.  Nodes which
              are  configured  only  in  hidden partitions will not be accounted for or otherwise
              visible to Moab/Maui.  Any partitions included here will normally also be  included
              in  the  ExcludePartitions  and  HidePartitionJobs  parameters.   If  more than one
              partition is to have its jobs hidden, use a comma separator between their names.

       HostFormat
              Controls the format of host lists exchanged between Slurm and  Moab.   The  default
              value is "0".  Not applicable to wiki plugin, only the wiki2 plugin.

              0      No data compression. Each host name is listed individually.

              1      Slurm   hostlist   expressions   are   exchanged   with  task  counts  (e.g.
                     "tux[0-16]*2") in job state information and job initiation requests.

              2      Slurm hostlist expressions are used to report node state information.

       JobAggregationTime
              This is used to avoid notifying Moab of large numbers of events occurring about the
              same  time.   If  an event occurs within this number of seconds since Moab was last
              notified of an event, another notification is not sent.  This should be an  integer
              number  of  seconds.   The  default  value  is  10 seconds.  The value should match
              JOBAGGREGATIONTIME configured in the moab.cnf file.  Not applicable to wiki plugin,
              only the wiki2 plugin.

       JobPriority
              Controls  initial  job  priority.   The default value is "hold".  Not applicable to
              wiki plugin, only the wiki2 plugin.

              run    Job permitted to run directly under Slurm's control

              hold   Hold all incoming jobs until Moab or Maui tell them to run

EXAMPLE

       ##################################################################
       # Slurm's configuration file for sched/wiki plugin
       ##################################################################
       #
       # Hold all incoming jobs until Moab tells them to run
       JobPriority=hold
       # Slurm directly schedules jobs in the debug and test partitions
       ExcludePartitions=debug,test
       #
       # Moab encryption key, matches KEY in moab-private.cfg
       AuthKey=1234
       #
       # Moab event notification port, matches EPORT in moab.cfg
       EPort=15017
       # Moab event notification hosts, where Moab executes
       EHost=tux0
       EHostBackup=tux1
       # Moab event notification throttle, matches JOBAGGREGATIONTIME
       # in moab.cfg (integer value in seconds)
       JobAggregationTime=15

COPYING

       Copyright (C) 2006-2007 The Regents of the University of California.  Produced at Lawrence
       Livermore National Laboratory (cf, DISCLAIMER).  CODE-OCEC-09-009. All rights reserved.

       This   file   is  part  of  Slurm,  a  resource  management  program.   For  details,  see
       <http://slurm.schedmd.com/>.

       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.

       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.

SEE ALSO

       slurm.conf(5)