lib/config/load.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package config
   6
   7 import (
   8         "bytes"
   9         "crypto/sha256"
  10         _ "embed"
  11         "encoding/json"
  12         "errors"
  13         "flag"
  14         "fmt"
  15         "io"
  16         "io/ioutil"
  17         "os"
  18         "regexp"
  19         "runtime"
  20         "strconv"
  21         "strings"
  22         "time"
  23
  24         "git.arvados.org/arvados.git/sdk/go/arvados"
  25         "github.com/ghodss/yaml"
  26         "github.com/imdario/mergo"
  27         "github.com/prometheus/client_golang/prometheus"
  28         "github.com/sirupsen/logrus"
  29         "golang.org/x/crypto/ssh"
  30         "golang.org/x/sys/unix"
  31 )
  32
  33 //go:embed config.default.yml
  34 var DefaultYAML []byte
  35
  36 var ErrNoClustersDefined = errors.New("config does not define any clusters")
  37
  38 type Loader struct {
  39         Stdin          io.Reader
  40         Logger         logrus.FieldLogger
  41         SkipDeprecated bool // Don't load deprecated config keys
  42         SkipLegacy     bool // Don't load legacy config files
  43         SkipAPICalls   bool // Don't do checks that call RailsAPI/controller
  44
  45         Path                    string
  46         KeepstorePath           string
  47         KeepWebPath             string
  48         CrunchDispatchSlurmPath string
  49         WebsocketPath           string
  50         KeepproxyPath           string
  51         KeepBalancePath         string
  52
  53         configdata []byte
  54         // UTC time for configdata: either the modtime of the file we
  55         // read configdata from, or the time when we read configdata
  56         // from a pipe.
  57         sourceTimestamp time.Time
  58         // UTC time when configdata was read.
  59         loadTimestamp time.Time
  60 }
  61
  62 // NewLoader returns a new Loader with Stdin and Logger set to the
  63 // given values, and all config paths set to their default values.
  64 func NewLoader(stdin io.Reader, logger logrus.FieldLogger) *Loader {
  65         ldr := &Loader{Stdin: stdin, Logger: logger}
  66         // Calling SetupFlags on a throwaway FlagSet has the side
  67         // effect of assigning default values to the configurable
  68         // fields.
  69         ldr.SetupFlags(flag.NewFlagSet("", flag.ContinueOnError))
  70         return ldr
  71 }
  72
  73 // SetupFlags configures a flagset so arguments like -config X can be
  74 // used to change the loader's Path fields.
  75 //
  76 //      ldr := NewLoader(os.Stdin, logrus.New())
  77 //      flagset := flag.NewFlagSet("", flag.ContinueOnError)
  78 //      ldr.SetupFlags(flagset)
  79 //      // ldr.Path == "/etc/arvados/config.yml"
  80 //      flagset.Parse([]string{"-config", "/tmp/c.yaml"})
  81 //      // ldr.Path == "/tmp/c.yaml"
  82 func (ldr *Loader) SetupFlags(flagset *flag.FlagSet) {
  83         flagset.StringVar(&ldr.Path, "config", arvados.DefaultConfigFile, "Site configuration `file` (default may be overridden by setting an ARVADOS_CONFIG environment variable)")
  84         if !ldr.SkipLegacy {
  85                 flagset.StringVar(&ldr.KeepstorePath, "legacy-keepstore-config", defaultKeepstoreConfigPath, "Legacy keepstore configuration `file`")
  86                 flagset.StringVar(&ldr.KeepWebPath, "legacy-keepweb-config", defaultKeepWebConfigPath, "Legacy keep-web configuration `file`")
  87                 flagset.StringVar(&ldr.CrunchDispatchSlurmPath, "legacy-crunch-dispatch-slurm-config", defaultCrunchDispatchSlurmConfigPath, "Legacy crunch-dispatch-slurm configuration `file`")
  88                 flagset.StringVar(&ldr.WebsocketPath, "legacy-ws-config", defaultWebsocketConfigPath, "Legacy arvados-ws configuration `file`")
  89                 flagset.StringVar(&ldr.KeepproxyPath, "legacy-keepproxy-config", defaultKeepproxyConfigPath, "Legacy keepproxy configuration `file`")
  90                 flagset.StringVar(&ldr.KeepBalancePath, "legacy-keepbalance-config", defaultKeepBalanceConfigPath, "Legacy keep-balance configuration `file`")
  91                 flagset.BoolVar(&ldr.SkipLegacy, "skip-legacy", false, "Don't load legacy config files")
  92         }
  93 }
  94
  95 // MungeLegacyConfigArgs checks args for a -config flag whose argument
  96 // is a regular file (or a symlink to one), but doesn't have a
  97 // top-level "Clusters" key and therefore isn't a valid cluster
  98 // configuration file. If it finds such a flag, it replaces -config
  99 // with legacyConfigArg (e.g., "-legacy-keepstore-config").
 100 //
 101 // This is used by programs that still need to accept "-config" as a
 102 // way to specify a per-component config file until their config has
 103 // been migrated.
 104 //
 105 // If any errors are encountered while reading or parsing a config
 106 // file, the given args are not munged. We presume the same errors
 107 // will be encountered again and reported later on when trying to load
 108 // cluster configuration from the same file, regardless of which
 109 // struct we end up using.
 110 func (ldr *Loader) MungeLegacyConfigArgs(lgr logrus.FieldLogger, args []string, legacyConfigArg string) []string {
 111         munged := append([]string(nil), args...)
 112         for i := 0; i < len(args); i++ {
 113                 if !strings.HasPrefix(args[i], "-") || strings.SplitN(strings.TrimPrefix(args[i], "-"), "=", 2)[0] != "config" {
 114                         continue
 115                 }
 116                 var operand string
 117                 if strings.Contains(args[i], "=") {
 118                         operand = strings.SplitN(args[i], "=", 2)[1]
 119                 } else if i+1 < len(args) && !strings.HasPrefix(args[i+1], "-") {
 120                         i++
 121                         operand = args[i]
 122                 } else {
 123                         continue
 124                 }
 125                 if fi, err := os.Stat(operand); err != nil || !fi.Mode().IsRegular() {
 126                         continue
 127                 }
 128                 f, err := os.Open(operand)
 129                 if err != nil {
 130                         continue
 131                 }
 132                 defer f.Close()
 133                 buf, err := ioutil.ReadAll(f)
 134                 if err != nil {
 135                         continue
 136                 }
 137                 var cfg arvados.Config
 138                 err = yaml.Unmarshal(buf, &cfg)
 139                 if err != nil {
 140                         continue
 141                 }
 142                 if len(cfg.Clusters) == 0 {
 143                         lgr.Warnf("%s is not a cluster config file -- interpreting %s as %s (please migrate your config!)", operand, "-config", legacyConfigArg)
 144                         if operand == args[i] {
 145                                 munged[i-1] = legacyConfigArg
 146                         } else {
 147                                 munged[i] = legacyConfigArg + "=" + operand
 148                         }
 149                 }
 150         }
 151
 152         // Disable legacy config loading for components other than the
 153         // one that was specified
 154         if legacyConfigArg != "-legacy-keepstore-config" {
 155                 ldr.KeepstorePath = ""
 156         }
 157         if legacyConfigArg != "-legacy-crunch-dispatch-slurm-config" {
 158                 ldr.CrunchDispatchSlurmPath = ""
 159         }
 160         if legacyConfigArg != "-legacy-ws-config" {
 161                 ldr.WebsocketPath = ""
 162         }
 163         if legacyConfigArg != "-legacy-keepweb-config" {
 164                 ldr.KeepWebPath = ""
 165         }
 166         if legacyConfigArg != "-legacy-keepproxy-config" {
 167                 ldr.KeepproxyPath = ""
 168         }
 169         if legacyConfigArg != "-legacy-keepbalance-config" {
 170                 ldr.KeepBalancePath = ""
 171         }
 172
 173         return munged
 174 }
 175
 176 func (ldr *Loader) loadBytes(path string) (buf []byte, sourceTime, loadTime time.Time, err error) {
 177         loadTime = time.Now().UTC()
 178         if path == "-" {
 179                 buf, err = ioutil.ReadAll(ldr.Stdin)
 180                 sourceTime = loadTime
 181                 return
 182         }
 183         f, err := os.Open(path)
 184         if err != nil {
 185                 return
 186         }
 187         defer f.Close()
 188         fi, err := f.Stat()
 189         if err != nil {
 190                 return
 191         }
 192         sourceTime = fi.ModTime().UTC()
 193         buf, err = ioutil.ReadAll(f)
 194         return
 195 }
 196
 197 func (ldr *Loader) Load() (*arvados.Config, error) {
 198         if ldr.configdata == nil {
 199                 buf, sourceTime, loadTime, err := ldr.loadBytes(ldr.Path)
 200                 if err != nil {
 201                         return nil, err
 202                 }
 203                 ldr.configdata = buf
 204                 ldr.sourceTimestamp = sourceTime
 205                 ldr.loadTimestamp = loadTime
 206         }
 207
 208         // FIXME: We should reject YAML if the same key is used twice
 209         // in a map/object, like {foo: bar, foo: baz}. Maybe we'll get
 210         // this fixed free when we upgrade ghodss/yaml to a version
 211         // that uses go-yaml v3.
 212
 213         // Load the config into a dummy map to get the cluster ID
 214         // keys, discarding the values; then set up defaults for each
 215         // cluster ID; then load the real config on top of the
 216         // defaults.
 217         var dummy struct {
 218                 Clusters map[string]struct{}
 219         }
 220         err := yaml.Unmarshal(ldr.configdata, &dummy)
 221         if err != nil {
 222                 return nil, err
 223         }
 224         if len(dummy.Clusters) == 0 {
 225                 return nil, ErrNoClustersDefined
 226         }
 227
 228         // We can't merge deep structs here; instead, we unmarshal the
 229         // default & loaded config files into generic maps, merge
 230         // those, and then json-encode+decode the result into the
 231         // config struct type.
 232         var merged map[string]interface{}
 233         for id := range dummy.Clusters {
 234                 var src map[string]interface{}
 235                 err = yaml.Unmarshal(bytes.Replace(DefaultYAML, []byte(" xxxxx:"), []byte(" "+id+":"), -1), &src)
 236                 if err != nil {
 237                         return nil, fmt.Errorf("loading defaults for %s: %s", id, err)
 238                 }
 239                 err = mergo.Merge(&merged, src, mergo.WithOverride)
 240                 if err != nil {
 241                         return nil, fmt.Errorf("merging defaults for %s: %s", id, err)
 242                 }
 243         }
 244         var src map[string]interface{}
 245         err = yaml.Unmarshal(ldr.configdata, &src)
 246         if err != nil {
 247                 return nil, fmt.Errorf("loading config data: %s", err)
 248         }
 249         ldr.logExtraKeys(merged, src, "")
 250         removeSampleKeys(merged)
 251         // We merge the loaded config into the default, overriding any existing keys.
 252         // Make sure we do not override a default with a key that has a 'null' value.
 253         removeNullKeys(src)
 254         err = mergo.Merge(&merged, src, mergo.WithOverride)
 255         if err != nil {
 256                 return nil, fmt.Errorf("merging config data: %s", err)
 257         }
 258
 259         // map[string]interface{} => json => arvados.Config
 260         var cfg arvados.Config
 261         var errEnc error
 262         pr, pw := io.Pipe()
 263         go func() {
 264                 errEnc = json.NewEncoder(pw).Encode(merged)
 265                 pw.Close()
 266         }()
 267         err = json.NewDecoder(pr).Decode(&cfg)
 268         if errEnc != nil {
 269                 err = errEnc
 270         }
 271         if err != nil {
 272                 return nil, fmt.Errorf("transcoding config data: %s", err)
 273         }
 274
 275         var loadFuncs []func(*arvados.Config) error
 276         if !ldr.SkipDeprecated {
 277                 loadFuncs = append(loadFuncs,
 278                         ldr.applyDeprecatedConfig,
 279                         ldr.applyDeprecatedVolumeDriverParameters,
 280                 )
 281         }
 282         if !ldr.SkipLegacy {
 283                 // legacy file is required when either:
 284                 // * a non-default location was specified
 285                 // * no primary config was loaded, and this is the
 286                 // legacy config file for the current component
 287                 loadFuncs = append(loadFuncs,
 288                         ldr.loadOldEnvironmentVariables,
 289                         ldr.loadOldKeepstoreConfig,
 290                         ldr.loadOldKeepWebConfig,
 291                         ldr.loadOldCrunchDispatchSlurmConfig,
 292                         ldr.loadOldWebsocketConfig,
 293                         ldr.loadOldKeepproxyConfig,
 294                         ldr.loadOldKeepBalanceConfig,
 295                 )
 296         }
 297         loadFuncs = append(loadFuncs,
 298                 ldr.setImplicitStorageClasses,
 299                 ldr.setLoopbackInstanceType,
 300         )
 301         for _, f := range loadFuncs {
 302                 err = f(&cfg)
 303                 if err != nil {
 304                         return nil, err
 305                 }
 306         }
 307
 308         // Preprocess/automate some configs
 309         for id, cc := range cfg.Clusters {
 310                 ldr.autofillPreemptible("Clusters."+id, &cc)
 311
 312                 if strings.Count(cc.Users.AnonymousUserToken, "/") == 3 {
 313                         // V2 token, strip it to just a secret
 314                         tmp := strings.Split(cc.Users.AnonymousUserToken, "/")
 315                         cc.Users.AnonymousUserToken = tmp[2]
 316                 }
 317
 318                 cfg.Clusters[id] = cc
 319         }
 320
 321         // Check for known mistakes
 322         for id, cc := range cfg.Clusters {
 323                 for remote := range cc.RemoteClusters {
 324                         if remote == "*" || remote == "SAMPLE" {
 325                                 continue
 326                         }
 327                         err = ldr.checkClusterID(fmt.Sprintf("Clusters.%s.RemoteClusters.%s", id, remote), remote, true)
 328                         if err != nil {
 329                                 return nil, err
 330                         }
 331                 }
 332                 for _, err = range []error{
 333                         ldr.checkClusterID(fmt.Sprintf("Clusters.%s", id), id, false),
 334                         ldr.checkClusterID(fmt.Sprintf("Clusters.%s.Login.LoginCluster", id), cc.Login.LoginCluster, true),
 335                         ldr.checkToken(fmt.Sprintf("Clusters.%s.ManagementToken", id), cc.ManagementToken, true, false),
 336                         ldr.checkToken(fmt.Sprintf("Clusters.%s.SystemRootToken", id), cc.SystemRootToken, true, false),
 337                         ldr.checkToken(fmt.Sprintf("Clusters.%s.Users.AnonymousUserToken", id), cc.Users.AnonymousUserToken, false, true),
 338                         ldr.checkToken(fmt.Sprintf("Clusters.%s.Collections.BlobSigningKey", id), cc.Collections.BlobSigningKey, true, false),
 339                         checkKeyConflict(fmt.Sprintf("Clusters.%s.PostgreSQL.Connection", id), cc.PostgreSQL.Connection),
 340                         ldr.checkEnum("Containers.LocalKeepLogsToContainerLog", cc.Containers.LocalKeepLogsToContainerLog, "none", "all", "errors"),
 341                         ldr.checkEmptyKeepstores(cc),
 342                         ldr.checkUnlistedKeepstores(cc),
 343                         ldr.checkLocalKeepBlobBuffers(cc),
 344                         ldr.checkStorageClasses(cc),
 345                         ldr.checkCUDAVersions(cc),
 346                         // TODO: check non-empty Rendezvous on
 347                         // services other than Keepstore
 348                 } {
 349                         if err != nil {
 350                                 return nil, err
 351                         }
 352                 }
 353         }
 354         cfg.SourceTimestamp = ldr.sourceTimestamp
 355         cfg.SourceSHA256 = fmt.Sprintf("%x", sha256.Sum256(ldr.configdata))
 356         return &cfg, nil
 357 }
 358
 359 var acceptableClusterIDRe = regexp.MustCompile(`^[a-z0-9]{5}$`)
 360
 361 func (ldr *Loader) checkClusterID(label, clusterID string, emptyStringOk bool) error {
 362         if emptyStringOk && clusterID == "" {
 363                 return nil
 364         } else if !acceptableClusterIDRe.MatchString(clusterID) {
 365                 return fmt.Errorf("%s: cluster ID should be 5 lowercase alphanumeric characters", label)
 366         }
 367         return nil
 368 }
 369
 370 var acceptableTokenRe = regexp.MustCompile(`^[a-zA-Z0-9]+$`)
 371 var acceptableTokenLength = 32
 372
 373 func (ldr *Loader) checkToken(label, token string, mandatory bool, acceptV2 bool) error {
 374         if len(token) == 0 {
 375                 if !mandatory {
 376                         // when a token is not mandatory, the acceptable length and content is only checked if its length is non-zero
 377                         return nil
 378                 } else {
 379                         if ldr.Logger != nil {
 380                                 ldr.Logger.Warnf("%s: secret token is not set (use %d+ random characters from a-z, A-Z, 0-9)", label, acceptableTokenLength)
 381                         }
 382                 }
 383         } else if !acceptableTokenRe.MatchString(token) {
 384                 if !acceptV2 {
 385                         return fmt.Errorf("%s: unacceptable characters in token (only a-z, A-Z, 0-9 are acceptable)", label)
 386                 }
 387                 // Test for a proper V2 token
 388                 tmp := strings.SplitN(token, "/", 3)
 389                 if len(tmp) != 3 {
 390                         return fmt.Errorf("%s: unacceptable characters in token (only a-z, A-Z, 0-9 are acceptable)", label)
 391                 }
 392                 if !strings.HasPrefix(token, "v2/") {
 393                         return fmt.Errorf("%s: unacceptable characters in token (only a-z, A-Z, 0-9 are acceptable)", label)
 394                 }
 395                 if !acceptableTokenRe.MatchString(tmp[2]) {
 396                         return fmt.Errorf("%s: unacceptable characters in V2 token secret (only a-z, A-Z, 0-9 are acceptable)", label)
 397                 }
 398                 if len(tmp[2]) < acceptableTokenLength {
 399                         ldr.Logger.Warnf("%s: secret is too short (should be at least %d characters)", label, acceptableTokenLength)
 400                 }
 401         } else if len(token) < acceptableTokenLength {
 402                 if ldr.Logger != nil {
 403                         ldr.Logger.Warnf("%s: token is too short (should be at least %d characters)", label, acceptableTokenLength)
 404                 }
 405         }
 406         return nil
 407 }
 408
 409 func (ldr *Loader) checkEnum(label, value string, accepted ...string) error {
 410         for _, s := range accepted {
 411                 if s == value {
 412                         return nil
 413                 }
 414         }
 415         return fmt.Errorf("%s: unacceptable value %q: must be one of %q", label, value, accepted)
 416 }
 417
 418 func (ldr *Loader) setLoopbackInstanceType(cfg *arvados.Config) error {
 419         for id, cc := range cfg.Clusters {
 420                 if !cc.Containers.CloudVMs.Enable || cc.Containers.CloudVMs.Driver != "loopback" {
 421                         continue
 422                 }
 423                 if len(cc.InstanceTypes) == 1 {
 424                         continue
 425                 }
 426                 if len(cc.InstanceTypes) > 1 {
 427                         return fmt.Errorf("Clusters.%s.InstanceTypes: cannot use multiple InstanceTypes with loopback driver", id)
 428                 }
 429                 // No InstanceTypes configured. Fill in implicit
 430                 // default.
 431                 hostram, err := getHostRAM()
 432                 if err != nil {
 433                         return err
 434                 }
 435                 scratch, err := getFilesystemSize(os.TempDir())
 436                 if err != nil {
 437                         return err
 438                 }
 439                 cc.InstanceTypes = arvados.InstanceTypeMap{"localhost": {
 440                         Name:            "localhost",
 441                         ProviderType:    "localhost",
 442                         VCPUs:           runtime.NumCPU(),
 443                         RAM:             hostram,
 444                         Scratch:         scratch,
 445                         IncludedScratch: scratch,
 446                         Price:           1.0,
 447                 }}
 448                 cfg.Clusters[id] = cc
 449         }
 450         return nil
 451 }
 452
 453 func getFilesystemSize(path string) (arvados.ByteSize, error) {
 454         var stat unix.Statfs_t
 455         err := unix.Statfs(path, &stat)
 456         if err != nil {
 457                 return 0, err
 458         }
 459         return arvados.ByteSize(stat.Blocks * uint64(stat.Bsize)), nil
 460 }
 461
 462 var reMemTotal = regexp.MustCompile(`(^|\n)MemTotal: *(\d+) kB\n`)
 463
 464 func getHostRAM() (arvados.ByteSize, error) {
 465         buf, err := os.ReadFile("/proc/meminfo")
 466         if err != nil {
 467                 return 0, err
 468         }
 469         m := reMemTotal.FindSubmatch(buf)
 470         if m == nil {
 471                 return 0, errors.New("error parsing /proc/meminfo: no MemTotal")
 472         }
 473         kb, err := strconv.ParseInt(string(m[2]), 10, 64)
 474         if err != nil {
 475                 return 0, fmt.Errorf("error parsing /proc/meminfo: %q: %w", m[2], err)
 476         }
 477         return arvados.ByteSize(kb) * 1024, nil
 478 }
 479
 480 func (ldr *Loader) setImplicitStorageClasses(cfg *arvados.Config) error {
 481 cluster:
 482         for id, cc := range cfg.Clusters {
 483                 if len(cc.StorageClasses) > 0 {
 484                         continue cluster
 485                 }
 486                 for _, vol := range cc.Volumes {
 487                         if len(vol.StorageClasses) > 0 {
 488                                 continue cluster
 489                         }
 490                 }
 491                 // No explicit StorageClasses config info at all; fill
 492                 // in implicit defaults.
 493                 for id, vol := range cc.Volumes {
 494                         vol.StorageClasses = map[string]bool{"default": true}
 495                         cc.Volumes[id] = vol
 496                 }
 497                 cc.StorageClasses = map[string]arvados.StorageClassConfig{"default": {Default: true}}
 498                 cfg.Clusters[id] = cc
 499         }
 500         return nil
 501 }
 502
 503 func (ldr *Loader) checkLocalKeepBlobBuffers(cc arvados.Cluster) error {
 504         kbb := cc.Containers.LocalKeepBlobBuffersPerVCPU
 505         if kbb == 0 {
 506                 return nil
 507         }
 508         for uuid, vol := range cc.Volumes {
 509                 if len(vol.AccessViaHosts) > 0 {
 510                         ldr.Logger.Warnf("LocalKeepBlobBuffersPerVCPU is %d but will not be used because at least one volume (%s) uses AccessViaHosts -- suggest changing to 0", kbb, uuid)
 511                         return nil
 512                 }
 513                 if !vol.ReadOnly && vol.Replication < cc.Collections.DefaultReplication {
 514                         ldr.Logger.Warnf("LocalKeepBlobBuffersPerVCPU is %d but will not be used because at least one volume (%s) has lower replication than DefaultReplication (%d < %d) -- suggest changing to 0", kbb, uuid, vol.Replication, cc.Collections.DefaultReplication)
 515                         return nil
 516                 }
 517         }
 518         return nil
 519 }
 520
 521 func (ldr *Loader) checkStorageClasses(cc arvados.Cluster) error {
 522         classOnVolume := map[string]bool{}
 523         for volid, vol := range cc.Volumes {
 524                 if len(vol.StorageClasses) == 0 {
 525                         return fmt.Errorf("%s: volume has no StorageClasses listed", volid)
 526                 }
 527                 for classid := range vol.StorageClasses {
 528                         if _, ok := cc.StorageClasses[classid]; !ok {
 529                                 return fmt.Errorf("%s: volume refers to storage class %q that is not defined in StorageClasses", volid, classid)
 530                         }
 531                         classOnVolume[classid] = true
 532                 }
 533         }
 534         haveDefault := false
 535         for classid, sc := range cc.StorageClasses {
 536                 if !classOnVolume[classid] && len(cc.Volumes) > 0 {
 537                         ldr.Logger.Warnf("there are no volumes providing storage class %q", classid)
 538                 }
 539                 if sc.Default {
 540                         haveDefault = true
 541                 }
 542         }
 543         if !haveDefault {
 544                 return fmt.Errorf("there is no default storage class (at least one entry in StorageClasses must have Default: true)")
 545         }
 546         return nil
 547 }
 548
 549 func (ldr *Loader) checkCUDAVersions(cc arvados.Cluster) error {
 550         for _, it := range cc.InstanceTypes {
 551                 if it.CUDA.DeviceCount == 0 {
 552                         continue
 553                 }
 554
 555                 _, err := strconv.ParseFloat(it.CUDA.DriverVersion, 64)
 556                 if err != nil {
 557                         return fmt.Errorf("InstanceType %q has invalid CUDA.DriverVersion %q, expected format X.Y (%v)", it.Name, it.CUDA.DriverVersion, err)
 558                 }
 559                 _, err = strconv.ParseFloat(it.CUDA.HardwareCapability, 64)
 560                 if err != nil {
 561                         return fmt.Errorf("InstanceType %q has invalid CUDA.HardwareCapability %q, expected format X.Y (%v)", it.Name, it.CUDA.HardwareCapability, err)
 562                 }
 563         }
 564         return nil
 565 }
 566
 567 func checkKeyConflict(label string, m map[string]string) error {
 568         saw := map[string]bool{}
 569         for k := range m {
 570                 k = strings.ToLower(k)
 571                 if saw[k] {
 572                         return fmt.Errorf("%s: multiple entries for %q (fix by using same capitalization as default/example file)", label, k)
 573                 }
 574                 saw[k] = true
 575         }
 576         return nil
 577 }
 578
 579 func removeNullKeys(m map[string]interface{}) {
 580         for k, v := range m {
 581                 if v == nil {
 582                         delete(m, k)
 583                 }
 584                 if v, _ := v.(map[string]interface{}); v != nil {
 585                         removeNullKeys(v)
 586                 }
 587         }
 588 }
 589
 590 func removeSampleKeys(m map[string]interface{}) {
 591         delete(m, "SAMPLE")
 592         for _, v := range m {
 593                 if v, _ := v.(map[string]interface{}); v != nil {
 594                         removeSampleKeys(v)
 595                 }
 596         }
 597 }
 598
 599 func (ldr *Loader) logExtraKeys(expected, supplied map[string]interface{}, prefix string) {
 600         if ldr.Logger == nil {
 601                 return
 602         }
 603         for k, vsupp := range supplied {
 604                 if k == "SAMPLE" {
 605                         // entry will be dropped in removeSampleKeys anyway
 606                         continue
 607                 }
 608                 vexp, ok := expected[k]
 609                 if expected["SAMPLE"] != nil {
 610                         // use the SAMPLE entry's keys as the
 611                         // "expected" map when checking vsupp
 612                         // recursively.
 613                         vexp = expected["SAMPLE"]
 614                 } else if !ok {
 615                         // check for a case-insensitive match
 616                         hint := ""
 617                         for ek := range expected {
 618                                 if strings.EqualFold(k, ek) {
 619                                         hint = " (perhaps you meant " + ek + "?)"
 620                                         // If we don't delete this, it
 621                                         // will end up getting merged,
 622                                         // unpredictably
 623                                         // merging/overriding the
 624                                         // default.
 625                                         delete(supplied, k)
 626                                         break
 627                                 }
 628                         }
 629                         ldr.Logger.Warnf("deprecated or unknown config entry: %s%s%s", prefix, k, hint)
 630                         continue
 631                 }
 632                 if vsupp, ok := vsupp.(map[string]interface{}); !ok {
 633                         // if vsupp is a map but vexp isn't map, this
 634                         // will be caught elsewhere; see TestBadType.
 635                         continue
 636                 } else if vexp, ok := vexp.(map[string]interface{}); !ok {
 637                         ldr.Logger.Warnf("unexpected object in config entry: %s%s", prefix, k)
 638                 } else {
 639                         ldr.logExtraKeys(vexp, vsupp, prefix+k+".")
 640                 }
 641         }
 642 }
 643
 644 func (ldr *Loader) autofillPreemptible(label string, cc *arvados.Cluster) {
 645         if factor := cc.Containers.PreemptiblePriceFactor; factor > 0 {
 646                 for name, it := range cc.InstanceTypes {
 647                         if !it.Preemptible {
 648                                 it.Preemptible = true
 649                                 it.Price = it.Price * factor
 650                                 it.Name = name + ".preemptible"
 651                                 if it2, exists := cc.InstanceTypes[it.Name]; exists && it2 != it {
 652                                         ldr.Logger.Warnf("%s.InstanceTypes[%s]: already exists, so not automatically adding a preemptible variant of %s", label, it.Name, name)
 653                                         continue
 654                                 }
 655                                 cc.InstanceTypes[it.Name] = it
 656                         }
 657                 }
 658         }
 659
 660 }
 661
 662 // RegisterMetrics registers metrics showing the timestamp and content
 663 // hash of the currently loaded config.
 664 //
 665 // Must not be called more than once for a given registry. Must not be
 666 // called before Load(). Metrics are not updated by subsequent calls
 667 // to Load().
 668 func (ldr *Loader) RegisterMetrics(reg *prometheus.Registry) {
 669         hash := fmt.Sprintf("%x", sha256.Sum256(ldr.configdata))
 670         vec := prometheus.NewGaugeVec(prometheus.GaugeOpts{
 671                 Namespace: "arvados",
 672                 Subsystem: "config",
 673                 Name:      "source_timestamp_seconds",
 674                 Help:      "Timestamp of config file when it was loaded.",
 675         }, []string{"sha256"})
 676         vec.WithLabelValues(hash).Set(float64(ldr.sourceTimestamp.UnixNano()) / 1e9)
 677         reg.MustRegister(vec)
 678
 679         vec = prometheus.NewGaugeVec(prometheus.GaugeOpts{
 680                 Namespace: "arvados",
 681                 Subsystem: "config",
 682                 Name:      "load_timestamp_seconds",
 683                 Help:      "Time when config file was loaded.",
 684         }, []string{"sha256"})
 685         vec.WithLabelValues(hash).Set(float64(ldr.loadTimestamp.UnixNano()) / 1e9)
 686         reg.MustRegister(vec)
 687 }
 688
 689 // Load an SSH private key from the given confvalue, which is either
 690 // the literal key or an absolute path to a file containing the key.
 691 func LoadSSHKey(confvalue string) (ssh.Signer, error) {
 692         if fnm := strings.TrimPrefix(confvalue, "file://"); fnm != confvalue && strings.HasPrefix(fnm, "/") {
 693                 keydata, err := os.ReadFile(fnm)
 694                 if err != nil {
 695                         return nil, err
 696                 }
 697                 return ssh.ParsePrivateKey(keydata)
 698         } else {
 699                 return ssh.ParsePrivateKey([]byte(confvalue))
 700         }
 701 }