13674: Change InstanceTypes config from array to hash.
[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, 0, len(cc.InstanceTypes))
51         for _, t := range cc.InstanceTypes {
52                 availableTypes = append(availableTypes, t)
53         }
54         sort.Slice(availableTypes, func(a, b int) bool {
55                 return availableTypes[a].Price < availableTypes[b].Price
56         })
57         err = ConstraintsNotSatisfiableError{
58                 errors.New("constraints not satisfiable by any configured instance type"),
59                 availableTypes,
60         }
61         for _, it := range cc.InstanceTypes {
62                 switch {
63                 case err == nil && it.Price > best.Price:
64                 case it.Scratch < needScratch:
65                 case it.RAM < needRAM:
66                 case it.VCPUs < needVCPUs:
67                 case it.Preemptible != ctr.SchedulingParameters.Preemptible:
68                 case it.Price == best.Price && (it.RAM < best.RAM || it.VCPUs < best.VCPUs):
69                         // Equal price, but worse specs
70                 default:
71                         // Lower price || (same price && better specs)
72                         best = it
73                         err = nil
74                 }
75         }
76         return
77 }
78
79 // SlurmNodeTypeFeatureKludge ensures SLURM accepts every instance
80 // type name as a valid feature name, even if no instances of that
81 // type have appeared yet.
82 //
83 // It takes advantage of some SLURM peculiarities:
84 //
85 // (1) A feature is valid after it has been offered by a node, even if
86 // it is no longer offered by any node. So, to make a feature name
87 // valid, we can add it to a dummy node ("compute0"), then remove it.
88 //
89 // (2) To test whether a set of feature names are valid without
90 // actually submitting a job, we can call srun --test-only with the
91 // desired features.
92 //
93 // SlurmNodeTypeFeatureKludge does a test-and-fix operation
94 // immediately, and then periodically, in case slurm restarts and
95 // forgets the list of valid features. It never returns (unless there
96 // are no node types configured, in which case it returns
97 // immediately), so it should generally be invoked with "go".
98 func SlurmNodeTypeFeatureKludge(cc *arvados.Cluster) {
99         if len(cc.InstanceTypes) == 0 {
100                 return
101         }
102         var features []string
103         for _, it := range cc.InstanceTypes {
104                 features = append(features, "instancetype="+it.Name)
105         }
106         for {
107                 slurmKludge(features)
108                 time.Sleep(2 * time.Second)
109         }
110 }
111
112 const slurmDummyNode = "compute0"
113
114 func slurmKludge(features []string) {
115         allFeatures := strings.Join(features, ",")
116
117         cmd := exec.Command("sinfo", "--nodes="+slurmDummyNode, "--format=%f", "--noheader")
118         out, err := cmd.CombinedOutput()
119         if err != nil {
120                 log.Printf("running %q %q: %s (output was %q)", cmd.Path, cmd.Args, err, out)
121                 return
122         }
123         if string(out) == allFeatures+"\n" {
124                 // Already configured correctly, nothing to do.
125                 return
126         }
127
128         log.Printf("configuring node %q with all node type features", slurmDummyNode)
129         cmd = exec.Command("scontrol", "update", "NodeName="+slurmDummyNode, "Features="+allFeatures)
130         log.Printf("running: %q %q", cmd.Path, cmd.Args)
131         out, err = cmd.CombinedOutput()
132         if err != nil {
133                 log.Printf("error: scontrol: %s (output was %q)", err, out)
134         }
135 }