sdk/go/arvados/config.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 package arvados
   6
   7 import (
   8         "fmt"
   9         "os"
  10
  11         "git.curoverse.com/arvados.git/sdk/go/config"
  12 )
  13
  14 const DefaultConfigFile = "/etc/arvados/config.yml"
  15
  16 type Config struct {
  17         Clusters map[string]Cluster
  18 }
  19
  20 // GetConfig returns the current system config, loading it from
  21 // configFile if needed.
  22 func GetConfig(configFile string) (*Config, error) {
  23         var cfg Config
  24         err := config.LoadFile(&cfg, configFile)
  25         return &cfg, err
  26 }
  27
  28 // GetCluster returns the cluster ID and config for the given
  29 // cluster, or the default/only configured cluster if clusterID is "".
  30 func (sc *Config) GetCluster(clusterID string) (*Cluster, error) {
  31         if clusterID == "" {
  32                 if len(sc.Clusters) == 0 {
  33                         return nil, fmt.Errorf("no clusters configured")
  34                 } else if len(sc.Clusters) > 1 {
  35                         return nil, fmt.Errorf("multiple clusters configured, cannot choose")
  36                 } else {
  37                         for id, cc := range sc.Clusters {
  38                                 cc.ClusterID = id
  39                                 return &cc, nil
  40                         }
  41                 }
  42         }
  43         if cc, ok := sc.Clusters[clusterID]; !ok {
  44                 return nil, fmt.Errorf("cluster %q is not configured", clusterID)
  45         } else {
  46                 cc.ClusterID = clusterID
  47                 return &cc, nil
  48         }
  49 }
  50
  51 type Cluster struct {
  52         ClusterID          string `json:"-"`
  53         ManagementToken    string
  54         SystemNodes        map[string]SystemNode
  55         InstanceTypes      []InstanceType
  56         HTTPRequestTimeout Duration
  57 }
  58
  59 type InstanceType struct {
  60         Name         string
  61         ProviderType string
  62         VCPUs        int
  63         RAM          int64
  64         Scratch      int64
  65         Price        float64
  66 }
  67
  68 // GetThisSystemNode returns a SystemNode for the node we're running
  69 // on right now.
  70 func (cc *Cluster) GetThisSystemNode() (*SystemNode, error) {
  71         return cc.GetSystemNode("")
  72 }
  73
  74 // GetSystemNode returns a SystemNode for the given hostname. An error
  75 // is returned if the appropriate configuration can't be determined
  76 // (e.g., this does not appear to be a system node). If node is empty,
  77 // use the OS-reported hostname.
  78 func (cc *Cluster) GetSystemNode(node string) (*SystemNode, error) {
  79         if node == "" {
  80                 hostname, err := os.Hostname()
  81                 if err != nil {
  82                         return nil, err
  83                 }
  84                 node = hostname
  85         }
  86         if cfg, ok := cc.SystemNodes[node]; ok {
  87                 return &cfg, nil
  88         }
  89         // If node is not listed, but "*" gives a default system node
  90         // config, use the default config.
  91         if cfg, ok := cc.SystemNodes["*"]; ok {
  92                 return &cfg, nil
  93         }
  94         return nil, fmt.Errorf("config does not provision host %q as a system node", node)
  95 }
  96
  97 type SystemNode struct {
  98         Controller  SystemServiceInstance `json:"arvados-controller"`
  99         Health      SystemServiceInstance `json:"arvados-health"`
 100         Keepproxy   SystemServiceInstance `json:"keepproxy"`
 101         Keepstore   SystemServiceInstance `json:"keepstore"`
 102         Keepweb     SystemServiceInstance `json:"keep-web"`
 103         Nodemanager SystemServiceInstance `json:"arvados-node-manager"`
 104         RailsAPI    SystemServiceInstance `json:"arvados-api-server"`
 105         Websocket   SystemServiceInstance `json:"arvados-ws"`
 106         Workbench   SystemServiceInstance `json:"arvados-workbench"`
 107 }
 108
 109 type ServiceName string
 110
 111 const (
 112         ServiceNameRailsAPI    ServiceName = "arvados-api-server"
 113         ServiceNameController  ServiceName = "arvados-controller"
 114         ServiceNameNodemanager ServiceName = "arvados-node-manager"
 115         ServiceNameWorkbench   ServiceName = "arvados-workbench"
 116         ServiceNameWebsocket   ServiceName = "arvados-ws"
 117         ServiceNameKeepweb     ServiceName = "keep-web"
 118         ServiceNameKeepproxy   ServiceName = "keepproxy"
 119         ServiceNameKeepstore   ServiceName = "keepstore"
 120 )
 121
 122 // ServicePorts returns the configured listening address (or "" if
 123 // disabled) for each service on the node.
 124 func (sn *SystemNode) ServicePorts() map[ServiceName]string {
 125         return map[ServiceName]string{
 126                 ServiceNameRailsAPI:    sn.RailsAPI.Listen,
 127                 ServiceNameController:  sn.Controller.Listen,
 128                 ServiceNameNodemanager: sn.Nodemanager.Listen,
 129                 ServiceNameWorkbench:   sn.Workbench.Listen,
 130                 ServiceNameWebsocket:   sn.Websocket.Listen,
 131                 ServiceNameKeepweb:     sn.Keepweb.Listen,
 132                 ServiceNameKeepproxy:   sn.Keepproxy.Listen,
 133                 ServiceNameKeepstore:   sn.Keepstore.Listen,
 134         }
 135 }
 136
 137 type SystemServiceInstance struct {
 138         Listen string
 139         TLS    bool
 140 }