services/crunch-dispatch-slurm/crunch-dispatch-slurm.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package main
   6
   7 // Dispatcher service for Crunch that submits containers to the slurm queue.
   8
   9 import (
  10         "bytes"
  11         "context"
  12         "flag"
  13         "fmt"
  14         "log"
  15         "math"
  16         "os"
  17         "regexp"
  18         "strings"
  19         "time"
  20
  21         "git.arvados.org/arvados.git/lib/config"
  22         "git.arvados.org/arvados.git/lib/dispatchcloud"
  23         "git.arvados.org/arvados.git/sdk/go/arvados"
  24         "git.arvados.org/arvados.git/sdk/go/arvadosclient"
  25         "git.arvados.org/arvados.git/sdk/go/dispatch"
  26         "github.com/coreos/go-systemd/daemon"
  27         "github.com/ghodss/yaml"
  28         "github.com/sirupsen/logrus"
  29 )
  30
  31 type logger interface {
  32         dispatch.Logger
  33         Fatalf(string, ...interface{})
  34 }
  35
  36 const initialNiceValue int64 = 10000
  37
  38 var (
  39         version = "dev"
  40 )
  41
  42 type Dispatcher struct {
  43         *dispatch.Dispatcher
  44         logger  logrus.FieldLogger
  45         cluster *arvados.Cluster
  46         sqCheck *SqueueChecker
  47         slurm   Slurm
  48
  49         Client arvados.Client
  50 }
  51
  52 func main() {
  53         logger := logrus.StandardLogger()
  54         if os.Getenv("DEBUG") != "" {
  55                 logger.SetLevel(logrus.DebugLevel)
  56         }
  57         logger.Formatter = &logrus.JSONFormatter{
  58                 TimestampFormat: "2006-01-02T15:04:05.000000000Z07:00",
  59         }
  60         disp := &Dispatcher{logger: logger}
  61         err := disp.Run(os.Args[0], os.Args[1:])
  62         if err != nil {
  63                 logrus.Fatalf("%s", err)
  64         }
  65 }
  66
  67 func (disp *Dispatcher) Run(prog string, args []string) error {
  68         if err := disp.configure(prog, args); err != nil {
  69                 return err
  70         }
  71         disp.setup()
  72         return disp.run()
  73 }
  74
  75 // configure() loads config files. Tests skip this.
  76 func (disp *Dispatcher) configure(prog string, args []string) error {
  77         if disp.logger == nil {
  78                 disp.logger = logrus.StandardLogger()
  79         }
  80         flags := flag.NewFlagSet(prog, flag.ExitOnError)
  81         flags.Usage = func() { usage(flags) }
  82
  83         loader := config.NewLoader(nil, disp.logger)
  84         loader.SetupFlags(flags)
  85
  86         dumpConfig := flag.Bool(
  87                 "dump-config",
  88                 false,
  89                 "write current configuration to stdout and exit")
  90         getVersion := flags.Bool(
  91                 "version",
  92                 false,
  93                 "Print version information and exit.")
  94
  95         args = loader.MungeLegacyConfigArgs(logrus.StandardLogger(), args, "-legacy-crunch-dispatch-slurm-config")
  96
  97         // Parse args; omit the first arg which is the command name
  98         err := flags.Parse(args)
  99
 100         if err == flag.ErrHelp {
 101                 return nil
 102         }
 103
 104         // Print version information if requested
 105         if *getVersion {
 106                 fmt.Printf("crunch-dispatch-slurm %s\n", version)
 107                 return nil
 108         }
 109
 110         disp.logger.Printf("crunch-dispatch-slurm %s started", version)
 111
 112         cfg, err := loader.Load()
 113         if err != nil {
 114                 return err
 115         }
 116
 117         if disp.cluster, err = cfg.GetCluster(""); err != nil {
 118                 return fmt.Errorf("config error: %s", err)
 119         }
 120
 121         disp.Client.APIHost = disp.cluster.Services.Controller.ExternalURL.Host
 122         disp.Client.AuthToken = disp.cluster.SystemRootToken
 123         disp.Client.Insecure = disp.cluster.TLS.Insecure
 124
 125         if disp.Client.APIHost != "" || disp.Client.AuthToken != "" {
 126                 // Copy real configs into env vars so [a]
 127                 // MakeArvadosClient() uses them, and [b] they get
 128                 // propagated to crunch-run via SLURM.
 129                 os.Setenv("ARVADOS_API_HOST", disp.Client.APIHost)
 130                 os.Setenv("ARVADOS_API_TOKEN", disp.Client.AuthToken)
 131                 os.Setenv("ARVADOS_API_HOST_INSECURE", "")
 132                 if disp.Client.Insecure {
 133                         os.Setenv("ARVADOS_API_HOST_INSECURE", "1")
 134                 }
 135                 os.Setenv("ARVADOS_EXTERNAL_CLIENT", "")
 136                 for k, v := range disp.cluster.Containers.SLURM.SbatchEnvironmentVariables {
 137                         os.Setenv(k, v)
 138                 }
 139         } else {
 140                 disp.logger.Warnf("Client credentials missing from config, so falling back on environment variables (deprecated).")
 141         }
 142
 143         if *dumpConfig {
 144                 out, err := yaml.Marshal(cfg)
 145                 if err != nil {
 146                         return err
 147                 }
 148                 _, err = os.Stdout.Write(out)
 149                 if err != nil {
 150                         return err
 151                 }
 152         }
 153
 154         return nil
 155 }
 156
 157 // setup() initializes private fields after configure().
 158 func (disp *Dispatcher) setup() {
 159         arv, err := arvadosclient.MakeArvadosClient()
 160         if err != nil {
 161                 disp.logger.Fatalf("Error making Arvados client: %v", err)
 162         }
 163         arv.Retries = 25
 164
 165         disp.slurm = NewSlurmCLI()
 166         disp.sqCheck = &SqueueChecker{
 167                 Logger:         disp.logger,
 168                 Period:         time.Duration(disp.cluster.Containers.CloudVMs.PollInterval),
 169                 PrioritySpread: disp.cluster.Containers.SLURM.PrioritySpread,
 170                 Slurm:          disp.slurm,
 171         }
 172         disp.Dispatcher = &dispatch.Dispatcher{
 173                 Arv:            arv,
 174                 Logger:         disp.logger,
 175                 BatchSize:      disp.cluster.API.MaxItemsPerResponse,
 176                 RunContainer:   disp.runContainer,
 177                 PollPeriod:     time.Duration(disp.cluster.Containers.CloudVMs.PollInterval),
 178                 MinRetryPeriod: time.Duration(disp.cluster.Containers.MinRetryPeriod),
 179         }
 180 }
 181
 182 func (disp *Dispatcher) run() error {
 183         defer disp.sqCheck.Stop()
 184
 185         if disp.cluster != nil && len(disp.cluster.InstanceTypes) > 0 {
 186                 go SlurmNodeTypeFeatureKludge(disp.cluster)
 187         }
 188
 189         if _, err := daemon.SdNotify(false, "READY=1"); err != nil {
 190                 log.Printf("Error notifying init daemon: %v", err)
 191         }
 192         go disp.checkSqueueForOrphans()
 193         return disp.Dispatcher.Run(context.Background())
 194 }
 195
 196 var containerUuidPattern = regexp.MustCompile(`^[a-z0-9]{5}-dz642-[a-z0-9]{15}$`)
 197
 198 // Check the next squeue report, and invoke TrackContainer for all the
 199 // containers in the report. This gives us a chance to cancel slurm
 200 // jobs started by a previous dispatch process that never released
 201 // their slurm allocations even though their container states are
 202 // Cancelled or Complete. See https://dev.arvados.org/issues/10979
 203 func (disp *Dispatcher) checkSqueueForOrphans() {
 204         for _, uuid := range disp.sqCheck.All() {
 205                 if !containerUuidPattern.MatchString(uuid) {
 206                         continue
 207                 }
 208                 err := disp.TrackContainer(uuid)
 209                 if err != nil {
 210                         log.Printf("checkSqueueForOrphans: TrackContainer(%s): %s", uuid, err)
 211                 }
 212         }
 213 }
 214
 215 func (disp *Dispatcher) slurmConstraintArgs(container arvados.Container) []string {
 216         mem := int64(math.Ceil(float64(container.RuntimeConstraints.RAM+
 217                 container.RuntimeConstraints.KeepCacheRAM+
 218                 int64(disp.cluster.Containers.ReserveExtraRAM)) / float64(1048576)))
 219
 220         disk := dispatchcloud.EstimateScratchSpace(&container)
 221         disk = int64(math.Ceil(float64(disk) / float64(1048576)))
 222         return []string{
 223                 fmt.Sprintf("--mem=%d", mem),
 224                 fmt.Sprintf("--cpus-per-task=%d", container.RuntimeConstraints.VCPUs),
 225                 fmt.Sprintf("--tmp=%d", disk),
 226         }
 227 }
 228
 229 func (disp *Dispatcher) sbatchArgs(container arvados.Container) ([]string, error) {
 230         var args []string
 231         args = append(args, disp.cluster.Containers.SLURM.SbatchArgumentsList...)
 232         args = append(args, "--job-name="+container.UUID, fmt.Sprintf("--nice=%d", initialNiceValue), "--no-requeue")
 233
 234         if disp.cluster == nil {
 235                 // no instance types configured
 236                 args = append(args, disp.slurmConstraintArgs(container)...)
 237         } else if it, err := dispatchcloud.ChooseInstanceType(disp.cluster, &container); err == dispatchcloud.ErrInstanceTypesNotConfigured {
 238                 // ditto
 239                 args = append(args, disp.slurmConstraintArgs(container)...)
 240         } else if err != nil {
 241                 return nil, err
 242         } else {
 243                 // use instancetype constraint instead of slurm mem/cpu/tmp specs
 244                 args = append(args, "--constraint=instancetype="+it.Name)
 245         }
 246
 247         if len(container.SchedulingParameters.Partitions) > 0 {
 248                 args = append(args, "--partition="+strings.Join(container.SchedulingParameters.Partitions, ","))
 249         }
 250
 251         return args, nil
 252 }
 253
 254 func (disp *Dispatcher) submit(container arvados.Container, crunchRunCommand []string) error {
 255         // append() here avoids modifying crunchRunCommand's
 256         // underlying array, which is shared with other goroutines.
 257         crArgs := append([]string(nil), crunchRunCommand...)
 258         crArgs = append(crArgs, container.UUID)
 259         crScript := strings.NewReader(execScript(crArgs))
 260
 261         sbArgs, err := disp.sbatchArgs(container)
 262         if err != nil {
 263                 return err
 264         }
 265         log.Printf("running sbatch %+q", sbArgs)
 266         return disp.slurm.Batch(crScript, sbArgs)
 267 }
 268
 269 // Submit a container to the slurm queue (or resume monitoring if it's
 270 // already in the queue).  Cancel the slurm job if the container's
 271 // priority changes to zero or its state indicates it's no longer
 272 // running.
 273 func (disp *Dispatcher) runContainer(_ *dispatch.Dispatcher, ctr arvados.Container, status <-chan arvados.Container) {
 274         ctx, cancel := context.WithCancel(context.Background())
 275         defer cancel()
 276
 277         if ctr.State == dispatch.Locked && !disp.sqCheck.HasUUID(ctr.UUID) {
 278                 log.Printf("Submitting container %s to slurm", ctr.UUID)
 279                 cmd := []string{disp.cluster.Containers.CrunchRunCommand}
 280                 cmd = append(cmd, disp.cluster.Containers.CrunchRunArgumentsList...)
 281                 if err := disp.submit(ctr, cmd); err != nil {
 282                         var text string
 283                         if err, ok := err.(dispatchcloud.ConstraintsNotSatisfiableError); ok {
 284                                 var logBuf bytes.Buffer
 285                                 fmt.Fprintf(&logBuf, "cannot run container %s: %s\n", ctr.UUID, err)
 286                                 if len(err.AvailableTypes) == 0 {
 287                                         fmt.Fprint(&logBuf, "No instance types are configured.\n")
 288                                 } else {
 289                                         fmt.Fprint(&logBuf, "Available instance types:\n")
 290                                         for _, t := range err.AvailableTypes {
 291                                                 fmt.Fprintf(&logBuf,
 292                                                         "Type %q: %d VCPUs, %d RAM, %d Scratch, %f Price\n",
 293                                                         t.Name, t.VCPUs, t.RAM, t.Scratch, t.Price,
 294                                                 )
 295                                         }
 296                                 }
 297                                 text = logBuf.String()
 298                                 disp.UpdateState(ctr.UUID, dispatch.Cancelled)
 299                         } else {
 300                                 text = fmt.Sprintf("Error submitting container %s to slurm: %s", ctr.UUID, err)
 301                         }
 302                         log.Print(text)
 303
 304                         lr := arvadosclient.Dict{"log": arvadosclient.Dict{
 305                                 "object_uuid": ctr.UUID,
 306                                 "event_type":  "dispatch",
 307                                 "properties":  map[string]string{"text": text}}}
 308                         disp.Arv.Create("logs", lr, nil)
 309
 310                         disp.Unlock(ctr.UUID)
 311                         return
 312                 }
 313         }
 314
 315         log.Printf("Start monitoring container %v in state %q", ctr.UUID, ctr.State)
 316         defer log.Printf("Done monitoring container %s", ctr.UUID)
 317
 318         // If the container disappears from the slurm queue, there is
 319         // no point in waiting for further dispatch updates: just
 320         // clean up and return.
 321         go func(uuid string) {
 322                 for ctx.Err() == nil && disp.sqCheck.HasUUID(uuid) {
 323                 }
 324                 cancel()
 325         }(ctr.UUID)
 326
 327         for {
 328                 select {
 329                 case <-ctx.Done():
 330                         // Disappeared from squeue
 331                         if err := disp.Arv.Get("containers", ctr.UUID, nil, &ctr); err != nil {
 332                                 log.Printf("error getting final container state for %s: %s", ctr.UUID, err)
 333                         }
 334                         switch ctr.State {
 335                         case dispatch.Running:
 336                                 disp.UpdateState(ctr.UUID, dispatch.Cancelled)
 337                         case dispatch.Locked:
 338                                 disp.Unlock(ctr.UUID)
 339                         }
 340                         return
 341                 case updated, ok := <-status:
 342                         if !ok {
 343                                 log.Printf("container %s is done: cancel slurm job", ctr.UUID)
 344                                 disp.scancel(ctr)
 345                         } else if updated.Priority == 0 {
 346                                 log.Printf("container %s has state %q, priority %d: cancel slurm job", ctr.UUID, updated.State, updated.Priority)
 347                                 disp.scancel(ctr)
 348                         } else {
 349                                 p := int64(updated.Priority)
 350                                 if p <= 1000 {
 351                                         // API is providing
 352                                         // user-assigned priority. If
 353                                         // ctrs have equal priority,
 354                                         // run the older one first.
 355                                         p = int64(p)<<50 - (updated.CreatedAt.UnixNano() >> 14)
 356                                 }
 357                                 disp.sqCheck.SetPriority(ctr.UUID, p)
 358                         }
 359                 }
 360         }
 361 }
 362 func (disp *Dispatcher) scancel(ctr arvados.Container) {
 363         err := disp.slurm.Cancel(ctr.UUID)
 364         if err != nil {
 365                 log.Printf("scancel: %s", err)
 366                 time.Sleep(time.Second)
 367         } else if disp.sqCheck.HasUUID(ctr.UUID) {
 368                 log.Printf("container %s is still in squeue after scancel", ctr.UUID)
 369                 time.Sleep(time.Second)
 370         }
 371 }