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         RemoteClusters     map[string]RemoteCluster
  58 }
  59
  60 type RemoteCluster struct {
  61         // API endpoint host or host:port; default is {id}.arvadosapi.com
  62         Host string
  63         // Perform a proxy request when a local client requests an
  64         // object belonging to this remote.
  65         Proxy bool
  66         // Scheme, default "https". Can be set to "http" for testing.
  67         Scheme string
  68         // Disable TLS verify. Can be set to true for testing.
  69         Insecure bool
  70 }
  71
  72 type InstanceType struct {
  73         Name         string
  74         ProviderType string
  75         VCPUs        int
  76         RAM          int64
  77         Scratch      int64
  78         Price        float64
  79         Preemptible  bool
  80 }
  81
  82 // GetNodeProfile returns a NodeProfile for the given hostname. An
  83 // error is returned if the appropriate configuration can't be
  84 // determined (e.g., this does not appear to be a system node). If
  85 // node is empty, use the OS-reported hostname.
  86 func (cc *Cluster) GetNodeProfile(node string) (*NodeProfile, error) {
  87         if node == "" {
  88                 hostname, err := os.Hostname()
  89                 if err != nil {
  90                         return nil, err
  91                 }
  92                 node = hostname
  93         }
  94         if cfg, ok := cc.NodeProfiles[node]; ok {
  95                 return &cfg, nil
  96         }
  97         // If node is not listed, but "*" gives a default system node
  98         // config, use the default config.
  99         if cfg, ok := cc.NodeProfiles["*"]; ok {
 100                 return &cfg, nil
 101         }
 102         return nil, fmt.Errorf("config does not provision host %q as a system node", node)
 103 }
 104
 105 type NodeProfile struct {
 106         Controller  SystemServiceInstance `json:"arvados-controller"`
 107         Health      SystemServiceInstance `json:"arvados-health"`
 108         Keepproxy   SystemServiceInstance `json:"keepproxy"`
 109         Keepstore   SystemServiceInstance `json:"keepstore"`
 110         Keepweb     SystemServiceInstance `json:"keep-web"`
 111         Nodemanager SystemServiceInstance `json:"arvados-node-manager"`
 112         RailsAPI    SystemServiceInstance `json:"arvados-api-server"`
 113         Websocket   SystemServiceInstance `json:"arvados-ws"`
 114         Workbench   SystemServiceInstance `json:"arvados-workbench"`
 115 }
 116
 117 type ServiceName string
 118
 119 const (
 120         ServiceNameRailsAPI    ServiceName = "arvados-api-server"
 121         ServiceNameController  ServiceName = "arvados-controller"
 122         ServiceNameNodemanager ServiceName = "arvados-node-manager"
 123         ServiceNameWorkbench   ServiceName = "arvados-workbench"
 124         ServiceNameWebsocket   ServiceName = "arvados-ws"
 125         ServiceNameKeepweb     ServiceName = "keep-web"
 126         ServiceNameKeepproxy   ServiceName = "keepproxy"
 127         ServiceNameKeepstore   ServiceName = "keepstore"
 128 )
 129
 130 // ServicePorts returns the configured listening address (or "" if
 131 // disabled) for each service on the node.
 132 func (np *NodeProfile) ServicePorts() map[ServiceName]string {
 133         return map[ServiceName]string{
 134                 ServiceNameRailsAPI:    np.RailsAPI.Listen,
 135                 ServiceNameController:  np.Controller.Listen,
 136                 ServiceNameNodemanager: np.Nodemanager.Listen,
 137                 ServiceNameWorkbench:   np.Workbench.Listen,
 138                 ServiceNameWebsocket:   np.Websocket.Listen,
 139                 ServiceNameKeepweb:     np.Keepweb.Listen,
 140                 ServiceNameKeepproxy:   np.Keepproxy.Listen,
 141                 ServiceNameKeepstore:   np.Keepstore.Listen,
 142         }
 143 }
 144
 145 type SystemServiceInstance struct {
 146         Listen   string
 147         TLS      bool
 148         Insecure bool
 149 }