Merge branch 'master' of git.curoverse.com:arvados into 13429-cwl-runner-storage...
[arvados.git] / lib / dispatchcloud / node_size.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package dispatchcloud
6
7 import (
8         "errors"
9         "log"
10         "os/exec"
11         "sort"
12         "strings"
13         "time"
14
15         "git.curoverse.com/arvados.git/sdk/go/arvados"
16 )
17
18 var (
19         ErrInstanceTypesNotConfigured = errors.New("site configuration does not list any instance types")
20         discountConfiguredRAMPercent  = 5
21 )
22
23 // ConstraintsNotSatisfiableError includes a list of available instance types
24 // to be reported back to the user.
25 type ConstraintsNotSatisfiableError struct {
26         error
27         AvailableTypes []arvados.InstanceType
28 }
29
30 // ChooseInstanceType returns the cheapest available
31 // arvados.InstanceType big enough to run ctr.
32 func ChooseInstanceType(cc *arvados.Cluster, ctr *arvados.Container) (best arvados.InstanceType, err error) {
33         if len(cc.InstanceTypes) == 0 {
34                 err = ErrInstanceTypesNotConfigured
35                 return
36         }
37
38         needScratch := int64(0)
39         for _, m := range ctr.Mounts {
40                 if m.Kind == "tmp" {
41                         needScratch += m.Capacity
42                 }
43         }
44
45         needVCPUs := ctr.RuntimeConstraints.VCPUs
46
47         needRAM := ctr.RuntimeConstraints.RAM + ctr.RuntimeConstraints.KeepCacheRAM
48         needRAM = (needRAM * 100) / int64(100-discountConfiguredRAMPercent)
49
50         availableTypes := make([]arvados.InstanceType, len(cc.InstanceTypes))
51         copy(availableTypes, cc.InstanceTypes)
52         sort.Slice(availableTypes, func(a, b int) bool {
53                 return availableTypes[a].Price < availableTypes[b].Price
54         })
55         err = ConstraintsNotSatisfiableError{
56                 errors.New("constraints not satisfiable by any configured instance type"),
57                 availableTypes,
58         }
59         for _, it := range cc.InstanceTypes {
60                 switch {
61                 case err == nil && it.Price > best.Price:
62                 case it.Scratch < needScratch:
63                 case it.RAM < needRAM:
64                 case it.VCPUs < needVCPUs:
65                 case it.Preemptable != ctr.SchedulingParameters.Preemptable:
66                 case it.Price == best.Price && (it.RAM < best.RAM || it.VCPUs < best.VCPUs):
67                         // Equal price, but worse specs
68                 default:
69                         // Lower price || (same price && better specs)
70                         best = it
71                         err = nil
72                 }
73         }
74         return
75 }
76
77 // SlurmNodeTypeFeatureKludge ensures SLURM accepts every instance
78 // type name as a valid feature name, even if no instances of that
79 // type have appeared yet.
80 //
81 // It takes advantage of some SLURM peculiarities:
82 //
83 // (1) A feature is valid after it has been offered by a node, even if
84 // it is no longer offered by any node. So, to make a feature name
85 // valid, we can add it to a dummy node ("compute0"), then remove it.
86 //
87 // (2) To test whether a set of feature names are valid without
88 // actually submitting a job, we can call srun --test-only with the
89 // desired features.
90 //
91 // SlurmNodeTypeFeatureKludge does a test-and-fix operation
92 // immediately, and then periodically, in case slurm restarts and
93 // forgets the list of valid features. It never returns (unless there
94 // are no node types configured, in which case it returns
95 // immediately), so it should generally be invoked with "go".
96 func SlurmNodeTypeFeatureKludge(cc *arvados.Cluster) {
97         if len(cc.InstanceTypes) == 0 {
98                 return
99         }
100         var features []string
101         for _, it := range cc.InstanceTypes {
102                 features = append(features, "instancetype="+it.Name)
103         }
104         for {
105                 slurmKludge(features)
106                 time.Sleep(2 * time.Second)
107         }
108 }
109
110 const slurmDummyNode = "compute0"
111
112 func slurmKludge(features []string) {
113         allFeatures := strings.Join(features, ",")
114
115         cmd := exec.Command("sinfo", "--nodes="+slurmDummyNode, "--format=%f", "--noheader")
116         out, err := cmd.CombinedOutput()
117         if err != nil {
118                 log.Printf("running %q %q: %s (output was %q)", cmd.Path, cmd.Args, err, out)
119                 return
120         }
121         if string(out) == allFeatures+"\n" {
122                 // Already configured correctly, nothing to do.
123                 return
124         }
125
126         log.Printf("configuring node %q with all node type features", slurmDummyNode)
127         cmd = exec.Command("scontrol", "update", "NodeName="+slurmDummyNode, "Features="+allFeatures)
128         log.Printf("running: %q %q", cmd.Path, cmd.Args)
129         out, err = cmd.CombinedOutput()
130         if err != nil {
131                 log.Printf("error: scontrol: %s (output was %q)", err, out)
132         }
133 }