X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/f5764a05d616e8d3c55b94503d5a1f789ac66ea7..7499f61a2912cfdb1a316808fafa6e6ee77ee2e0:/lib/config/cmd.go diff --git a/lib/config/cmd.go b/lib/config/cmd.go index a41e4b0331..347e8519a9 100644 --- a/lib/config/cmd.go +++ b/lib/config/cmd.go @@ -9,13 +9,13 @@ import ( "flag" "fmt" "io" - "io/ioutil" "os" "os/exec" - "git.curoverse.com/arvados.git/sdk/go/arvados" - "git.curoverse.com/arvados.git/sdk/go/ctxlog" + "git.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/ctxlog" "github.com/ghodss/yaml" + "github.com/sirupsen/logrus" ) var DumpCommand dumpCommand @@ -30,9 +30,15 @@ func (dumpCommand) RunCommand(prog string, args []string, stdin io.Reader, stdou } }() + loader := &Loader{ + Stdin: stdin, + Logger: ctxlog.New(stderr, "text", "info"), + } + flags := flag.NewFlagSet("", flag.ContinueOnError) flags.SetOutput(stderr) - configFile := flags.String("config", arvados.DefaultConfigFile, "Site configuration `file`") + loader.SetupFlags(flags) + err = flags.Parse(args) if err == flag.ErrHelp { err = nil @@ -45,8 +51,8 @@ func (dumpCommand) RunCommand(prog string, args []string, stdin io.Reader, stdou flags.Usage() return 2 } - log := ctxlog.New(stderr, "text", "info") - cfg, err := loadFileOrStdin(*configFile, stdin, log) + + cfg, err := loader.Load() if err != nil { return 1 } @@ -67,15 +73,26 @@ type checkCommand struct{} func (checkCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int { var err error + var logbuf = &bytes.Buffer{} defer func() { + io.Copy(stderr, logbuf) if err != nil { fmt.Fprintf(stderr, "%s\n", err) } }() + logger := logrus.New() + logger.Out = logbuf + loader := &Loader{ + Stdin: stdin, + Logger: logger, + } + flags := flag.NewFlagSet("", flag.ContinueOnError) flags.SetOutput(stderr) - configFile := flags.String("config", arvados.DefaultConfigFile, "Site configuration `file`") + loader.SetupFlags(flags) + strict := flags.Bool("strict", true, "Strict validation of configuration file (warnings result in non-zero exit code)") + err = flags.Parse(args) if err == flag.ErrHelp { err = nil @@ -88,23 +105,30 @@ func (checkCommand) RunCommand(prog string, args []string, stdin io.Reader, stdo flags.Usage() return 2 } - log := &plainLogger{w: stderr} - var buf []byte - if *configFile == "-" { - buf, err = ioutil.ReadAll(stdin) - } else { - buf, err = ioutil.ReadFile(*configFile) - } + + // Load the config twice -- once without loading deprecated + // keys/files, once with -- and then compare the two resulting + // configs. This reveals whether the deprecated keys/files + // have any effect on the final configuration. + // + // If they do, show the operator how to update their config + // such that the deprecated keys/files are superfluous and can + // be deleted. + loader.SkipDeprecated = true + loader.SkipLegacy = true + withoutDepr, err := loader.Load() if err != nil { return 1 } - withoutDepr, err := load(bytes.NewBuffer(buf), log, false) + loader.SkipDeprecated = false + loader.SkipLegacy = false + withDepr, err := loader.Load() if err != nil { return 1 } - withDepr, err := load(bytes.NewBuffer(buf), nil, true) - if err != nil { - return 1 + problems := false + if warnAboutProblems(logger, withDepr) { + problems = true } cmd := exec.Command("diff", "-u", "--label", "without-deprecated-configs", "--label", "relying-on-deprecated-configs", "/dev/fd/3", "/dev/fd/4") for _, obj := range []interface{}{withoutDepr, withDepr} { @@ -124,25 +148,54 @@ func (checkCommand) RunCommand(prog string, args []string, stdin io.Reader, stdo if bytes.HasPrefix(diff, []byte("--- ")) { fmt.Fprintln(stdout, "Your configuration is relying on deprecated entries. Suggest making the following changes.") stdout.Write(diff) - return 1 + err = nil + if *strict { + return 1 + } } else if len(diff) > 0 { fmt.Fprintf(stderr, "Unexpected diff output:\n%s", diff) - return 1 + if *strict { + return 1 + } } else if err != nil { return 1 } - if log.used { + if logbuf.Len() > 0 { + if *strict { + return 1 + } + } + + if problems { return 1 } return 0 } -type plainLogger struct { - w io.Writer - used bool +func warnAboutProblems(logger logrus.FieldLogger, cfg *arvados.Config) bool { + warned := false + for id, cc := range cfg.Clusters { + if cc.SystemRootToken == "" { + logger.Warnf("Clusters.%s.SystemRootToken is empty; see https://doc.arvados.org/master/install/install-keepstore.html", id) + warned = true + } + if cc.ManagementToken == "" { + logger.Warnf("Clusters.%s.ManagementToken is empty; see https://doc.arvados.org/admin/management-token.html", id) + warned = true + } + } + return warned } -func (pl *plainLogger) Warnf(format string, args ...interface{}) { - pl.used = true - fmt.Fprintf(pl.w, format+"\n", args...) +var DumpDefaultsCommand defaultsCommand + +type defaultsCommand struct{} + +func (defaultsCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int { + _, err := stdout.Write(DefaultYAML) + if err != nil { + fmt.Fprintln(stderr, err) + return 1 + } + return 0 }