1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
18 "git.curoverse.com/arvados.git/sdk/go/arvados"
19 "github.com/ghodss/yaml"
20 "github.com/imdario/mergo"
21 "github.com/sirupsen/logrus"
24 var ErrNoClustersDefined = errors.New("config does not define any clusters")
28 Logger logrus.FieldLogger
29 SkipDeprecated bool // Don't load legacy/deprecated config keys/files
37 func NewLoader(stdin io.Reader, logger logrus.FieldLogger) *Loader {
38 ldr := &Loader{Stdin: stdin, Logger: logger}
39 ldr.SetupFlags(flag.NewFlagSet("", flag.ContinueOnError))
44 // SetupFlags configures a flagset so arguments like -config X can be
45 // used to change the loader's Path fields.
47 // ldr := NewLoader(os.Stdin, logrus.New())
48 // flagset := flag.NewFlagSet("", flag.ContinueOnError)
49 // ldr.SetupFlags(flagset)
50 // // ldr.Path == "/etc/arvados/config.yml"
51 // flagset.Parse([]string{"-config", "/tmp/c.yaml"})
52 // // ldr.Path == "/tmp/c.yaml"
53 func (ldr *Loader) SetupFlags(flagset *flag.FlagSet) {
54 flagset.StringVar(&ldr.Path, "config", arvados.DefaultConfigFile, "Site configuration `file` (default may be overridden by setting an ARVADOS_CONFIG environment variable)")
55 flagset.StringVar(&ldr.KeepstorePath, "legacy-keepstore-config", defaultKeepstoreConfigPath, "Legacy keepstore configuration `file`")
58 func (ldr *Loader) loadBytes(path string) ([]byte, error) {
60 return ioutil.ReadAll(ldr.Stdin)
62 f, err := os.Open(path)
67 return ioutil.ReadAll(f)
70 func (ldr *Loader) Load() (*arvados.Config, error) {
71 if ldr.configdata == nil {
72 buf, err := ldr.loadBytes(ldr.Path)
79 // Load the config into a dummy map to get the cluster ID
80 // keys, discarding the values; then set up defaults for each
81 // cluster ID; then load the real config on top of the
84 Clusters map[string]struct{}
86 err := yaml.Unmarshal(ldr.configdata, &dummy)
90 if len(dummy.Clusters) == 0 {
91 return nil, ErrNoClustersDefined
94 // We can't merge deep structs here; instead, we unmarshal the
95 // default & loaded config files into generic maps, merge
96 // those, and then json-encode+decode the result into the
97 // config struct type.
98 var merged map[string]interface{}
99 for id := range dummy.Clusters {
100 var src map[string]interface{}
101 err = yaml.Unmarshal(bytes.Replace(DefaultYAML, []byte(" xxxxx:"), []byte(" "+id+":"), -1), &src)
103 return nil, fmt.Errorf("loading defaults for %s: %s", id, err)
105 err = mergo.Merge(&merged, src, mergo.WithOverride)
107 return nil, fmt.Errorf("merging defaults for %s: %s", id, err)
110 var src map[string]interface{}
111 err = yaml.Unmarshal(ldr.configdata, &src)
113 return nil, fmt.Errorf("loading config data: %s", err)
115 ldr.logExtraKeys(merged, src, "")
116 removeSampleKeys(merged)
117 err = mergo.Merge(&merged, src, mergo.WithOverride)
119 return nil, fmt.Errorf("merging config data: %s", err)
122 // map[string]interface{} => json => arvados.Config
123 var cfg arvados.Config
127 errEnc = json.NewEncoder(pw).Encode(merged)
130 err = json.NewDecoder(pr).Decode(&cfg)
135 return nil, fmt.Errorf("transcoding config data: %s", err)
138 if !ldr.SkipDeprecated {
139 err = ldr.applyDeprecatedConfig(&cfg)
143 for _, err := range []error{
144 ldr.loadOldKeepstoreConfig(&cfg),
152 // Check for known mistakes
153 for id, cc := range cfg.Clusters {
154 err = checkKeyConflict(fmt.Sprintf("Clusters.%s.PostgreSQL.Connection", id), cc.PostgreSQL.Connection)
162 func checkKeyConflict(label string, m map[string]string) error {
163 saw := map[string]bool{}
165 k = strings.ToLower(k)
167 return fmt.Errorf("%s: multiple entries for %q (fix by using same capitalization as default/example file)", label, k)
174 func removeSampleKeys(m map[string]interface{}) {
176 for _, v := range m {
177 if v, _ := v.(map[string]interface{}); v != nil {
183 func (ldr *Loader) logExtraKeys(expected, supplied map[string]interface{}, prefix string) {
184 if ldr.Logger == nil {
187 allowed := map[string]interface{}{}
188 for k, v := range expected {
189 allowed[strings.ToLower(k)] = v
191 for k, vsupp := range supplied {
192 vexp, ok := allowed[strings.ToLower(k)]
193 if !ok && expected["SAMPLE"] != nil {
194 vexp = expected["SAMPLE"]
196 ldr.Logger.Warnf("deprecated or unknown config entry: %s%s", prefix, k)
199 if vsupp, ok := vsupp.(map[string]interface{}); !ok {
200 // if vsupp is a map but vexp isn't map, this
201 // will be caught elsewhere; see TestBadType.
203 } else if vexp, ok := vexp.(map[string]interface{}); !ok {
204 ldr.Logger.Warnf("unexpected object in config entry: %s%s", prefix, k)
206 ldr.logExtraKeys(vexp, vsupp, prefix+k+".")