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