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         NodeProfiles       map[string]NodeProfile
  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         Preemptible  bool
  67 }
  68
  69 // GetNodeProfile returns a NodeProfile for the given hostname. An
  70 // error is returned if the appropriate configuration can't be
  71 // determined (e.g., this does not appear to be a system node). If
  72 // node is empty, use the OS-reported hostname.
  73 func (cc *Cluster) GetNodeProfile(node string) (*NodeProfile, error) {
  74         if node == "" {
  75                 hostname, err := os.Hostname()
  76                 if err != nil {
  77                         return nil, err
  78                 }
  79                 node = hostname
  80         }
  81         if cfg, ok := cc.NodeProfiles[node]; ok {
  82                 return &cfg, nil
  83         }
  84         // If node is not listed, but "*" gives a default system node
  85         // config, use the default config.
  86         if cfg, ok := cc.NodeProfiles["*"]; ok {
  87                 return &cfg, nil
  88         }
  89         return nil, fmt.Errorf("config does not provision host %q as a system node", node)
  90 }
  91
  92 type NodeProfile struct {
  93         Controller  SystemServiceInstance `json:"arvados-controller"`
  94         Health      SystemServiceInstance `json:"arvados-health"`
  95         Keepproxy   SystemServiceInstance `json:"keepproxy"`
  96         Keepstore   SystemServiceInstance `json:"keepstore"`
  97         Keepweb     SystemServiceInstance `json:"keep-web"`
  98         Nodemanager SystemServiceInstance `json:"arvados-node-manager"`
  99         RailsAPI    SystemServiceInstance `json:"arvados-api-server"`
 100         Websocket   SystemServiceInstance `json:"arvados-ws"`
 101         Workbench   SystemServiceInstance `json:"arvados-workbench"`
 102 }
 103
 104 type ServiceName string
 105
 106 const (
 107         ServiceNameRailsAPI    ServiceName = "arvados-api-server"
 108         ServiceNameController  ServiceName = "arvados-controller"
 109         ServiceNameNodemanager ServiceName = "arvados-node-manager"
 110         ServiceNameWorkbench   ServiceName = "arvados-workbench"
 111         ServiceNameWebsocket   ServiceName = "arvados-ws"
 112         ServiceNameKeepweb     ServiceName = "keep-web"
 113         ServiceNameKeepproxy   ServiceName = "keepproxy"
 114         ServiceNameKeepstore   ServiceName = "keepstore"
 115 )
 116
 117 // ServicePorts returns the configured listening address (or "" if
 118 // disabled) for each service on the node.
 119 func (np *NodeProfile) ServicePorts() map[ServiceName]string {
 120         return map[ServiceName]string{
 121                 ServiceNameRailsAPI:    np.RailsAPI.Listen,
 122                 ServiceNameController:  np.Controller.Listen,
 123                 ServiceNameNodemanager: np.Nodemanager.Listen,
 124                 ServiceNameWorkbench:   np.Workbench.Listen,
 125                 ServiceNameWebsocket:   np.Websocket.Listen,
 126                 ServiceNameKeepweb:     np.Keepweb.Listen,
 127                 ServiceNameKeepproxy:   np.Keepproxy.Listen,
 128                 ServiceNameKeepstore:   np.Keepstore.Listen,
 129         }
 130 }
 131
 132 type SystemServiceInstance struct {
 133         Listen string
 134         TLS    bool
 135 }