1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
7 // Dispatcher service for Crunch that submits containers to the slurm queue.
20 "git.arvados.org/arvados.git/lib/config"
21 "git.arvados.org/arvados.git/lib/dispatchcloud"
22 "git.arvados.org/arvados.git/sdk/go/arvados"
23 "git.arvados.org/arvados.git/sdk/go/arvadosclient"
24 "git.arvados.org/arvados.git/sdk/go/dispatch"
25 "github.com/coreos/go-systemd/daemon"
26 "github.com/ghodss/yaml"
27 "github.com/sirupsen/logrus"
30 type logger interface {
32 Fatalf(string, ...interface{})
35 const initialNiceValue int64 = 10000
41 type Dispatcher struct {
43 logger logrus.FieldLogger
44 cluster *arvados.Cluster
45 sqCheck *SqueueChecker
52 logger := logrus.StandardLogger()
53 if os.Getenv("DEBUG") != "" {
54 logger.SetLevel(logrus.DebugLevel)
56 logger.Formatter = &logrus.JSONFormatter{
57 TimestampFormat: "2006-01-02T15:04:05.000000000Z07:00",
59 disp := &Dispatcher{logger: logger}
60 err := disp.Run(os.Args[0], os.Args[1:])
62 logrus.Fatalf("%s", err)
66 func (disp *Dispatcher) Run(prog string, args []string) error {
67 if err := disp.configure(prog, args); err != nil {
74 // configure() loads config files. Tests skip this.
75 func (disp *Dispatcher) configure(prog string, args []string) error {
76 if disp.logger == nil {
77 disp.logger = logrus.StandardLogger()
79 flags := flag.NewFlagSet(prog, flag.ExitOnError)
80 flags.Usage = func() { usage(flags) }
82 loader := config.NewLoader(nil, disp.logger)
83 loader.SetupFlags(flags)
85 dumpConfig := flag.Bool(
88 "write current configuration to stdout and exit")
89 getVersion := flags.Bool(
92 "Print version information and exit.")
94 args = loader.MungeLegacyConfigArgs(disp.logger, args, "-legacy-crunch-dispatch-slurm-config")
95 err := flags.Parse(args)
96 if err == flag.ErrHelp {
98 } else if err != nil {
100 } else if flags.NArg() != 0 {
101 return fmt.Errorf("unrecognized command line arguments: %v", flags.Args())
104 // Print version information if requested
106 fmt.Printf("crunch-dispatch-slurm %s\n", version)
110 disp.logger.Printf("crunch-dispatch-slurm %s started", version)
112 cfg, err := loader.Load()
117 if disp.cluster, err = cfg.GetCluster(""); err != nil {
118 return fmt.Errorf("config error: %s", err)
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
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")
135 os.Setenv("ARVADOS_EXTERNAL_CLIENT", "")
136 for k, v := range disp.cluster.Containers.SLURM.SbatchEnvironmentVariables {
140 disp.logger.Warnf("Client credentials missing from config, so falling back on environment variables (deprecated).")
144 out, err := yaml.Marshal(cfg)
148 _, err = os.Stdout.Write(out)
157 // setup() initializes private fields after configure().
158 func (disp *Dispatcher) setup() {
159 arv, err := arvadosclient.MakeArvadosClient()
161 disp.logger.Fatalf("Error making Arvados client: %v", err)
165 disp.slurm = NewSlurmCLI()
166 disp.sqCheck = &SqueueChecker{
168 Period: time.Duration(disp.cluster.Containers.CloudVMs.PollInterval),
169 PrioritySpread: disp.cluster.Containers.SLURM.PrioritySpread,
172 disp.Dispatcher = &dispatch.Dispatcher{
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),
182 func (disp *Dispatcher) run() error {
183 defer disp.sqCheck.Stop()
185 if disp.cluster != nil && len(disp.cluster.InstanceTypes) > 0 {
186 go SlurmNodeTypeFeatureKludge(disp.cluster)
189 if _, err := daemon.SdNotify(false, "READY=1"); err != nil {
190 log.Printf("Error notifying init daemon: %v", err)
192 go disp.checkSqueueForOrphans()
193 return disp.Dispatcher.Run(context.Background())
196 var containerUuidPattern = regexp.MustCompile(`^[a-z0-9]{5}-dz642-[a-z0-9]{15}$`)
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) || !strings.HasPrefix(uuid, disp.cluster.ClusterID) {
208 err := disp.TrackContainer(uuid)
210 log.Printf("checkSqueueForOrphans: TrackContainer(%s): %s", uuid, err)
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)))
220 disk := dispatchcloud.EstimateScratchSpace(&container)
221 disk = int64(math.Ceil(float64(disk) / float64(1048576)))
223 fmt.Sprintf("--mem=%d", mem),
224 fmt.Sprintf("--cpus-per-task=%d", container.RuntimeConstraints.VCPUs),
225 fmt.Sprintf("--tmp=%d", disk),
229 func (disp *Dispatcher) sbatchArgs(container arvados.Container) ([]string, error) {
231 args = append(args, disp.cluster.Containers.SLURM.SbatchArgumentsList...)
232 args = append(args, "--job-name="+container.UUID, fmt.Sprintf("--nice=%d", initialNiceValue), "--no-requeue")
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 {
239 args = append(args, disp.slurmConstraintArgs(container)...)
240 } else if err != nil {
243 // use instancetype constraint instead of slurm mem/cpu/tmp specs
244 args = append(args, "--constraint=instancetype="+it.Name)
247 if len(container.SchedulingParameters.Partitions) > 0 {
248 args = append(args, "--partition="+strings.Join(container.SchedulingParameters.Partitions, ","))
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, "--runtime-engine="+disp.cluster.Containers.RuntimeEngine)
259 crArgs = append(crArgs, container.UUID)
260 crScript := strings.NewReader(execScript(crArgs))
262 sbArgs, err := disp.sbatchArgs(container)
266 log.Printf("running sbatch %+q", sbArgs)
267 return disp.slurm.Batch(crScript, sbArgs)
270 // Submit a container to the slurm queue (or resume monitoring if it's
271 // already in the queue). Cancel the slurm job if the container's
272 // priority changes to zero or its state indicates it's no longer
274 func (disp *Dispatcher) runContainer(_ *dispatch.Dispatcher, ctr arvados.Container, status <-chan arvados.Container) error {
275 ctx, cancel := context.WithCancel(context.Background())
278 if ctr.State == dispatch.Locked && !disp.sqCheck.HasUUID(ctr.UUID) {
279 log.Printf("Submitting container %s to slurm", ctr.UUID)
280 cmd := []string{disp.cluster.Containers.CrunchRunCommand}
281 cmd = append(cmd, disp.cluster.Containers.CrunchRunArgumentsList...)
282 err := disp.submit(ctr, cmd)
288 log.Printf("Start monitoring container %v in state %q", ctr.UUID, ctr.State)
289 defer log.Printf("Done monitoring container %s", ctr.UUID)
291 // If the container disappears from the slurm queue, there is
292 // no point in waiting for further dispatch updates: just
293 // clean up and return.
294 go func(uuid string) {
295 for ctx.Err() == nil && disp.sqCheck.HasUUID(uuid) {
303 // Disappeared from squeue
304 if err := disp.Arv.Get("containers", ctr.UUID, nil, &ctr); err != nil {
305 log.Printf("error getting final container state for %s: %s", ctr.UUID, err)
308 case dispatch.Running:
309 disp.UpdateState(ctr.UUID, dispatch.Cancelled)
310 case dispatch.Locked:
311 disp.Unlock(ctr.UUID)
314 case updated, ok := <-status:
316 log.Printf("container %s is done: cancel slurm job", ctr.UUID)
318 } else if updated.Priority == 0 {
319 log.Printf("container %s has state %q, priority %d: cancel slurm job", ctr.UUID, updated.State, updated.Priority)
322 p := int64(updated.Priority)
325 // user-assigned priority. If
326 // ctrs have equal priority,
327 // run the older one first.
328 p = int64(p)<<50 - (updated.CreatedAt.UnixNano() >> 14)
330 disp.sqCheck.SetPriority(ctr.UUID, p)
335 func (disp *Dispatcher) scancel(ctr arvados.Container) {
336 err := disp.slurm.Cancel(ctr.UUID)
338 log.Printf("scancel: %s", err)
339 time.Sleep(time.Second)
340 } else if disp.sqCheck.HasUUID(ctr.UUID) {
341 log.Printf("container %s is still in squeue after scancel", ctr.UUID)
342 time.Sleep(time.Second)