// Copyright (c) HashiCorp, Inc. // SPDX-License-Identifier: MPL-2.0 package agent import ( "flag" "fmt" "io" "log" "os" "os/signal" "path/filepath" "reflect" "sort" "strconv" "strings" "syscall" "time" metrics "github.com/armon/go-metrics" "github.com/armon/go-metrics/circonus" "github.com/armon/go-metrics/datadog" "github.com/armon/go-metrics/prometheus" checkpoint "github.com/hashicorp/go-checkpoint" discover "github.com/hashicorp/go-discover" hclog "github.com/hashicorp/go-hclog" gsyslog "github.com/hashicorp/go-syslog" "github.com/hashicorp/logutils" "github.com/hashicorp/nomad/helper" flaghelper "github.com/hashicorp/nomad/helper/flags" gatedwriter "github.com/hashicorp/nomad/helper/gated-writer" "github.com/hashicorp/nomad/helper/logging" "github.com/hashicorp/nomad/helper/winsvc" "github.com/hashicorp/nomad/nomad/structs" "github.com/hashicorp/nomad/nomad/structs/config" "github.com/hashicorp/nomad/version" "github.com/mitchellh/cli" "github.com/posener/complete" ) // gracefulTimeout controls how long we wait before forcefully terminating const gracefulTimeout = 5 * time.Second // Command is a Command implementation that runs a Nomad agent. // The command will not end unless a shutdown message is sent on the // ShutdownCh. If two messages are sent on the ShutdownCh it will forcibly // exit. type Command struct { Version *version.VersionInfo Ui cli.Ui ShutdownCh <-chan struct{} args []string agent *Agent httpServers []*HTTPServer logFilter *logutils.LevelFilter logOutput io.Writer retryJoinErrCh chan struct{} } func (c *Command) readConfig() *Config { var dev *devModeConfig var configPath []string var servers string var meta []string // Make a new, empty config. cmdConfig := &Config{ Client: &ClientConfig{}, Consul: &config.ConsulConfig{}, Ports: &Ports{}, Server: &ServerConfig{ ServerJoin: &ServerJoin{}, }, Vault: &config.VaultConfig{}, ACL: &ACLConfig{}, Audit: &config.AuditConfig{}, } flags := flag.NewFlagSet("agent", flag.ContinueOnError) flags.Usage = func() { c.Ui.Error(c.Help()) } // Role options var devMode bool var devConnectMode bool flags.BoolVar(&devMode, "dev", false, "") flags.BoolVar(&devConnectMode, "dev-connect", false, "") flags.BoolVar(&cmdConfig.Server.Enabled, "server", false, "") flags.BoolVar(&cmdConfig.Client.Enabled, "client", false, "") // Server-only options flags.IntVar(&cmdConfig.Server.BootstrapExpect, "bootstrap-expect", 0, "") flags.StringVar(&cmdConfig.Server.EncryptKey, "encrypt", "", "gossip encryption key") flags.IntVar(&cmdConfig.Server.RaftProtocol, "raft-protocol", 0, "") flags.BoolVar(&cmdConfig.Server.RejoinAfterLeave, "rejoin", false, "") flags.Var((*flaghelper.StringFlag)(&cmdConfig.Server.ServerJoin.StartJoin), "join", "") flags.Var((*flaghelper.StringFlag)(&cmdConfig.Server.ServerJoin.RetryJoin), "retry-join", "") flags.IntVar(&cmdConfig.Server.ServerJoin.RetryMaxAttempts, "retry-max", 0, "") flags.Var((flaghelper.FuncDurationVar)(func(d time.Duration) error { cmdConfig.Server.ServerJoin.RetryInterval = d return nil }), "retry-interval", "") // Client-only options flags.StringVar(&cmdConfig.Client.StateDir, "state-dir", "", "") flags.StringVar(&cmdConfig.Client.AllocDir, "alloc-dir", "", "") flags.StringVar(&cmdConfig.Client.NodeClass, "node-class", "", "") flags.StringVar(&cmdConfig.Client.NodePool, "node-pool", "", "") flags.StringVar(&servers, "servers", "", "") flags.Var((*flaghelper.StringFlag)(&meta), "meta", "") flags.StringVar(&cmdConfig.Client.NetworkInterface, "network-interface", "", "") flags.IntVar(&cmdConfig.Client.NetworkSpeed, "network-speed", 0, "") // General options flags.Var((*flaghelper.StringFlag)(&configPath), "config", "config") flags.StringVar(&cmdConfig.BindAddr, "bind", "", "") flags.StringVar(&cmdConfig.Region, "region", "", "") flags.StringVar(&cmdConfig.DataDir, "data-dir", "", "") flags.StringVar(&cmdConfig.PluginDir, "plugin-dir", "", "") flags.StringVar(&cmdConfig.Datacenter, "dc", "", "") flags.StringVar(&cmdConfig.LogLevel, "log-level", "", "") flags.BoolVar(&cmdConfig.LogJson, "log-json", false, "") flags.BoolVar(&cmdConfig.LogIncludeLocation, "log-include-location", false, "") flags.StringVar(&cmdConfig.NodeName, "node", "", "") // Consul options flags.StringVar(&cmdConfig.Consul.Auth, "consul-auth", "", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Consul.AutoAdvertise = &b return nil }), "consul-auto-advertise", "") flags.StringVar(&cmdConfig.Consul.CAFile, "consul-ca-file", "", "") flags.StringVar(&cmdConfig.Consul.CertFile, "consul-cert-file", "", "") flags.StringVar(&cmdConfig.Consul.KeyFile, "consul-key-file", "", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Consul.ChecksUseAdvertise = &b return nil }), "consul-checks-use-advertise", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Consul.ClientAutoJoin = &b return nil }), "consul-client-auto-join", "") flags.StringVar(&cmdConfig.Consul.ClientServiceName, "consul-client-service-name", "", "") flags.StringVar(&cmdConfig.Consul.ClientHTTPCheckName, "consul-client-http-check-name", "", "") flags.StringVar(&cmdConfig.Consul.ServerServiceName, "consul-server-service-name", "", "") flags.StringVar(&cmdConfig.Consul.ServerHTTPCheckName, "consul-server-http-check-name", "", "") flags.StringVar(&cmdConfig.Consul.ServerSerfCheckName, "consul-server-serf-check-name", "", "") flags.StringVar(&cmdConfig.Consul.ServerRPCCheckName, "consul-server-rpc-check-name", "", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Consul.ServerAutoJoin = &b return nil }), "consul-server-auto-join", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Consul.EnableSSL = &b return nil }), "consul-ssl", "") flags.StringVar(&cmdConfig.Consul.Token, "consul-token", "", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Consul.VerifySSL = &b return nil }), "consul-verify-ssl", "") flags.StringVar(&cmdConfig.Consul.Addr, "consul-address", "", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Consul.AllowUnauthenticated = &b return nil }), "consul-allow-unauthenticated", "") // Vault options flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Vault.Enabled = &b return nil }), "vault-enabled", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Vault.AllowUnauthenticated = &b return nil }), "vault-allow-unauthenticated", "") flags.StringVar(&cmdConfig.Vault.Token, "vault-token", "", "") flags.StringVar(&cmdConfig.Vault.Addr, "vault-address", "", "") flags.StringVar(&cmdConfig.Vault.Namespace, "vault-namespace", "", "") flags.StringVar(&cmdConfig.Vault.Role, "vault-create-from-role", "", "") flags.StringVar(&cmdConfig.Vault.TLSCaFile, "vault-ca-file", "", "") flags.StringVar(&cmdConfig.Vault.TLSCaPath, "vault-ca-path", "", "") flags.StringVar(&cmdConfig.Vault.TLSCertFile, "vault-cert-file", "", "") flags.StringVar(&cmdConfig.Vault.TLSKeyFile, "vault-key-file", "", "") flags.Var((flaghelper.FuncBoolVar)(func(b bool) error { cmdConfig.Vault.TLSSkipVerify = &b return nil }), "vault-tls-skip-verify", "") flags.StringVar(&cmdConfig.Vault.TLSServerName, "vault-tls-server-name", "", "") // ACL options flags.BoolVar(&cmdConfig.ACL.Enabled, "acl-enabled", false, "") flags.StringVar(&cmdConfig.ACL.ReplicationToken, "acl-replication-token", "", "") if err := flags.Parse(c.args); err != nil { return nil } // Split the servers. if servers != "" { cmdConfig.Client.Servers = strings.Split(servers, ",") } // Parse the meta flags. metaLength := len(meta) if metaLength != 0 { cmdConfig.Client.Meta = make(map[string]string, metaLength) for _, kv := range meta { parts := strings.SplitN(kv, "=", 2) if len(parts) != 2 { c.Ui.Error(fmt.Sprintf("Error parsing Client.Meta value: %v", kv)) return nil } cmdConfig.Client.Meta[parts[0]] = parts[1] } } // Load the configuration dev, err := newDevModeConfig(devMode, devConnectMode) if err != nil { c.Ui.Error(err.Error()) return nil } var config *Config if dev != nil { config = DevConfig(dev) } else { config = DefaultConfig() } // Merge in the enterprise overlay config = config.Merge(DefaultEntConfig()) for _, path := range configPath { current, err := LoadConfig(path) if err != nil { c.Ui.Error(fmt.Sprintf( "Error loading configuration from %s: %s", path, err)) return nil } // The user asked us to load some config here but we didn't find any, // so we'll complain but continue. if current == nil || reflect.DeepEqual(current, &Config{}) { c.Ui.Warn(fmt.Sprintf("No configuration loaded from %s", path)) } if config == nil { config = current } else { config = config.Merge(current) } } // Ensure the sub-structs at least exist if config.Client == nil { config.Client = &ClientConfig{} } if config.Server == nil { config.Server = &ServerConfig{} } // Merge any CLI options over config file options config = config.Merge(cmdConfig) // Set the version info config.Version = c.Version // Normalize binds, ports, addresses, and advertise if err := config.normalizeAddrs(); err != nil { c.Ui.Error(err.Error()) return nil } // Check to see if we should read the Vault token from the environment if config.Vault.Token == "" { config.Vault.Token = os.Getenv("VAULT_TOKEN") } // Check to see if we should read the Vault namespace from the environment if config.Vault.Namespace == "" { config.Vault.Namespace = os.Getenv("VAULT_NAMESPACE") } // Default the plugin directory to be under that of the data directory if it // isn't explicitly specified. if config.PluginDir == "" && config.DataDir != "" { config.PluginDir = filepath.Join(config.DataDir, "plugins") } // License configuration options config.Server.LicenseEnv = os.Getenv("NOMAD_LICENSE") if config.Server.LicensePath == "" { config.Server.LicensePath = os.Getenv("NOMAD_LICENSE_PATH") } config.Server.DefaultSchedulerConfig.Canonicalize() if !c.IsValidConfig(config, cmdConfig) { return nil } return config } func (c *Command) IsValidConfig(config, cmdConfig *Config) bool { // Check that the server is running in at least one mode. if !(config.Server.Enabled || config.Client.Enabled) { c.Ui.Error("Must specify either server, client or dev mode for the agent.") return false } // Check that the region does not contain invalid characters if strings.ContainsAny(config.Region, "\000") { c.Ui.Error("Region contains invalid characters") return false } // Check that the datacenter name does not contain invalid characters if strings.ContainsAny(config.Datacenter, "\000*") { c.Ui.Error("Datacenter contains invalid characters (null or '*')") return false } // Set up the TLS configuration properly if we have one. // XXX chelseakomlo: set up a TLSConfig New method which would wrap // constructor-type actions like this. if config.TLSConfig != nil && !config.TLSConfig.IsEmpty() { if err := config.TLSConfig.SetChecksum(); err != nil { c.Ui.Error(fmt.Sprintf("WARNING: Error when parsing TLS configuration: %v", err)) } } if !config.DevMode && (config.TLSConfig == nil || !config.TLSConfig.EnableHTTP || !config.TLSConfig.EnableRPC) { c.Ui.Error("WARNING: mTLS is not configured - Nomad is not secure without mTLS!") } if config.Server.EncryptKey != "" { if _, err := config.Server.EncryptBytes(); err != nil { c.Ui.Error(fmt.Sprintf("Invalid encryption key: %s", err)) return false } keyfile := filepath.Join(config.DataDir, serfKeyring) if _, err := os.Stat(keyfile); err == nil { c.Ui.Warn("WARNING: keyring exists but -encrypt given, using keyring") } } // Verify the paths are absolute. dirs := map[string]string{ "data-dir": config.DataDir, "plugin-dir": config.PluginDir, "alloc-dir": config.Client.AllocDir, "state-dir": config.Client.StateDir, } for k, dir := range dirs { if dir == "" { continue } if !filepath.IsAbs(dir) { c.Ui.Error(fmt.Sprintf("%s must be given as an absolute path: got %v", k, dir)) return false } } if config.Client.Enabled { for k := range config.Client.Meta { if !helper.IsValidInterpVariable(k) { c.Ui.Error(fmt.Sprintf("Invalid Client.Meta key: %v", k)) return false } } } if err := config.Server.DefaultSchedulerConfig.Validate(); err != nil { c.Ui.Error(err.Error()) return false } // Validate node pool name early to prevent agent from starting but the // client failing to register. if pool := config.Client.NodePool; pool != "" { if err := structs.ValidateNodePoolName(pool); err != nil { c.Ui.Error(fmt.Sprintf("Invalid node pool: %v", err)) return false } if pool == structs.NodePoolAll { c.Ui.Error(fmt.Sprintf("Invalid node pool: node is not allowed to register in node pool %q", structs.NodePoolAll)) return false } } for _, volumeConfig := range config.Client.HostVolumes { if volumeConfig.Path == "" { c.Ui.Error("Missing path in host_volume config") return false } } if config.Client.MinDynamicPort < 0 || config.Client.MinDynamicPort > structs.MaxValidPort { c.Ui.Error(fmt.Sprintf("Invalid dynamic port range: min_dynamic_port=%d", config.Client.MinDynamicPort)) return false } if config.Client.MaxDynamicPort < 0 || config.Client.MaxDynamicPort > structs.MaxValidPort { c.Ui.Error(fmt.Sprintf("Invalid dynamic port range: max_dynamic_port=%d", config.Client.MaxDynamicPort)) return false } if config.Client.MinDynamicPort > config.Client.MaxDynamicPort { c.Ui.Error(fmt.Sprintf("Invalid dynamic port range: min_dynamic_port=%d and max_dynamic_port=%d", config.Client.MinDynamicPort, config.Client.MaxDynamicPort)) return false } if config.Client.Reserved == nil { // Coding error; should always be set by DefaultConfig() c.Ui.Error("client.reserved must be initialized. Please report a bug.") return false } if ports := config.Client.Reserved.ReservedPorts; ports != "" { if _, err := structs.ParsePortRanges(ports); err != nil { c.Ui.Error(fmt.Sprintf("reserved.reserved_ports %q invalid: %v", ports, err)) return false } } for _, hn := range config.Client.HostNetworks { // Ensure port range is valid if _, err := structs.ParsePortRanges(hn.ReservedPorts); err != nil { c.Ui.Error(fmt.Sprintf("host_network[%q].reserved_ports %q invalid: %v", hn.Name, hn.ReservedPorts, err)) return false } } if err := config.Client.Artifact.Validate(); err != nil { c.Ui.Error(fmt.Sprintf("client.artifact block invalid: %v", err)) return false } if !config.DevMode { // Ensure that we have the directories we need to run. if config.Server.Enabled && config.DataDir == "" { c.Ui.Error(`Must specify "data_dir" config option or "data-dir" CLI flag`) return false } // The config is valid if the top-level data-dir is set or if both // alloc-dir and state-dir are set. if config.Client.Enabled && config.DataDir == "" { if config.Client.AllocDir == "" || config.Client.StateDir == "" || config.PluginDir == "" { c.Ui.Error("Must specify the state, alloc dir, and plugin dir if data-dir is omitted.") return false } } // Check the bootstrap flags if !config.Server.Enabled && cmdConfig.Server.BootstrapExpect > 0 { // report an error if BootstrapExpect is set in CLI but server is disabled c.Ui.Error("Bootstrap requires server mode to be enabled") return false } if config.Server.Enabled && config.Server.BootstrapExpect == 1 { c.Ui.Error("WARNING: Bootstrap mode enabled! Potentially unsafe operation.") } if config.Server.Enabled && config.Server.BootstrapExpect%2 == 0 { c.Ui.Error("WARNING: Number of bootstrap servers should ideally be set to an odd number.") } } // ProtocolVersion has never been used. Warn if it is set as someone // has probably made a mistake. if config.Server.ProtocolVersion != 0 { c.Ui.Warn("Please remove deprecated protocol_version field from config.") } return true } // SetupLoggers is used to set up the logGate, and our logOutput func SetupLoggers(ui cli.Ui, config *Config) (*logutils.LevelFilter, *gatedwriter.Writer, io.Writer) { // Setup logging. First create the gated log writer, which will // store logs until we're ready to show them. Then create the level // filter, filtering logs of the specified level. logGate := &gatedwriter.Writer{ Writer: &cli.UiWriter{Ui: ui}, } logFilter := LevelFilter() logFilter.MinLevel = logutils.LogLevel(strings.ToUpper(config.LogLevel)) logFilter.Writer = logGate if !ValidateLevelFilter(logFilter.MinLevel, logFilter) { ui.Error(fmt.Sprintf( "Invalid log level: %s. Valid log levels are: %v", logFilter.MinLevel, logFilter.Levels)) return nil, nil, nil } // Create a log writer, and wrap a logOutput around it writers := []io.Writer{logFilter} logLevel := strings.ToUpper(config.LogLevel) logLevelMap := map[string]gsyslog.Priority{ "ERROR": gsyslog.LOG_ERR, "WARN": gsyslog.LOG_WARNING, "INFO": gsyslog.LOG_INFO, "DEBUG": gsyslog.LOG_DEBUG, "TRACE": gsyslog.LOG_DEBUG, } if logLevel == "OFF" { config.EnableSyslog = false } // Check if syslog is enabled if config.EnableSyslog { ui.Output(fmt.Sprintf("Config enable_syslog is `true` with log_level=%v", config.LogLevel)) l, err := gsyslog.NewLogger(logLevelMap[logLevel], config.SyslogFacility, "nomad") if err != nil { ui.Error(fmt.Sprintf("Syslog setup failed: %v", err)) return nil, nil, nil } writers = append(writers, &SyslogWrapper{l, logFilter}) } // Check if file logging is enabled if config.LogFile != "" { dir, fileName := filepath.Split(config.LogFile) // if a path is provided, but has no filename, then a default is used. if fileName == "" { fileName = "nomad.log" } // Try to enter the user specified log rotation duration first var logRotateDuration time.Duration if config.LogRotateDuration != "" { duration, err := time.ParseDuration(config.LogRotateDuration) if err != nil { ui.Error(fmt.Sprintf("Failed to parse log rotation duration: %v", err)) return nil, nil, nil } logRotateDuration = duration } else { // Default to 24 hrs if no rotation period is specified logRotateDuration = 24 * time.Hour } logFile := &logFile{ logFilter: logFilter, fileName: fileName, logPath: dir, duration: logRotateDuration, MaxBytes: config.LogRotateBytes, MaxFiles: config.LogRotateMaxFiles, } writers = append(writers, logFile) } logOutput := io.MultiWriter(writers...) return logFilter, logGate, logOutput } // setupAgent is used to start the agent and various interfaces func (c *Command) setupAgent(config *Config, logger hclog.InterceptLogger, logOutput io.Writer, inmem *metrics.InmemSink) error { c.Ui.Output("Starting Nomad agent...") agent, err := NewAgent(config, logger, logOutput, inmem) if err != nil { // log the error as well, so it appears at the end logger.Error("error starting agent", "error", err) c.Ui.Error(fmt.Sprintf("Error starting agent: %s", err)) return err } c.agent = agent // Setup the HTTP server httpServers, err := NewHTTPServers(agent, config) if err != nil { agent.Shutdown() c.Ui.Error(fmt.Sprintf("Error starting http server: %s", err)) return err } c.httpServers = httpServers // If DisableUpdateCheck is not enabled, set up update checking // (DisableUpdateCheck is false by default) if config.DisableUpdateCheck != nil && !*config.DisableUpdateCheck { version := config.Version.Version if config.Version.VersionPrerelease != "" { version += fmt.Sprintf("-%s", config.Version.VersionPrerelease) } updateParams := &checkpoint.CheckParams{ Product: "nomad", Version: version, } if !config.DisableAnonymousSignature { updateParams.SignatureFile = filepath.Join(config.DataDir, "checkpoint-signature") } // Schedule a periodic check with expected interval of 24 hours checkpoint.CheckInterval(updateParams, 24*time.Hour, c.checkpointResults) // Do an immediate check within the next 30 seconds go func() { time.Sleep(helper.RandomStagger(30 * time.Second)) c.checkpointResults(checkpoint.Check(updateParams)) }() } return nil } // checkpointResults is used to handler periodic results from our update checker func (c *Command) checkpointResults(results *checkpoint.CheckResponse, err error) { if err != nil { c.Ui.Error(fmt.Sprintf("Failed to check for updates: %v", err)) return } if results.Outdated { c.Ui.Error(fmt.Sprintf("Newer Nomad version available: %s (currently running: %s)", results.CurrentVersion, c.Version.VersionNumber())) } for _, alert := range results.Alerts { switch alert.Level { case "info": c.Ui.Info(fmt.Sprintf("Bulletin [%s]: %s (%s)", alert.Level, alert.Message, alert.URL)) default: c.Ui.Error(fmt.Sprintf("Bulletin [%s]: %s (%s)", alert.Level, alert.Message, alert.URL)) } } } func (c *Command) AutocompleteFlags() complete.Flags { configFilePredictor := complete.PredictOr( complete.PredictFiles("*.json"), complete.PredictFiles("*.hcl")) return map[string]complete.Predictor{ "-dev": complete.PredictNothing, "-dev-connect": complete.PredictNothing, "-server": complete.PredictNothing, "-client": complete.PredictNothing, "-bootstrap-expect": complete.PredictAnything, "-encrypt": complete.PredictAnything, "-raft-protocol": complete.PredictAnything, "-rejoin": complete.PredictNothing, "-join": complete.PredictAnything, "-retry-join": complete.PredictAnything, "-retry-max": complete.PredictAnything, "-state-dir": complete.PredictDirs("*"), "-alloc-dir": complete.PredictDirs("*"), "-node-class": complete.PredictAnything, "-node-pool": complete.PredictAnything, "-servers": complete.PredictAnything, "-meta": complete.PredictAnything, "-config": configFilePredictor, "-bind": complete.PredictAnything, "-region": complete.PredictAnything, "-data-dir": complete.PredictDirs("*"), "-plugin-dir": complete.PredictDirs("*"), "-dc": complete.PredictAnything, "-log-level": complete.PredictAnything, "-json-logs": complete.PredictNothing, "-node": complete.PredictAnything, "-consul-auth": complete.PredictAnything, "-consul-auto-advertise": complete.PredictNothing, "-consul-ca-file": complete.PredictAnything, "-consul-cert-file": complete.PredictAnything, "-consul-key-file": complete.PredictAnything, "-consul-checks-use-advertise": complete.PredictNothing, "-consul-client-auto-join": complete.PredictNothing, "-consul-client-service-name": complete.PredictAnything, "-consul-client-http-check-name": complete.PredictAnything, "-consul-server-service-name": complete.PredictAnything, "-consul-server-http-check-name": complete.PredictAnything, "-consul-server-serf-check-name": complete.PredictAnything, "-consul-server-rpc-check-name": complete.PredictAnything, "-consul-server-auto-join": complete.PredictNothing, "-consul-ssl": complete.PredictNothing, "-consul-verify-ssl": complete.PredictNothing, "-consul-address": complete.PredictAnything, "-consul-token": complete.PredictAnything, "-vault-enabled": complete.PredictNothing, "-vault-allow-unauthenticated": complete.PredictNothing, "-vault-token": complete.PredictAnything, "-vault-address": complete.PredictAnything, "-vault-create-from-role": complete.PredictAnything, "-vault-ca-file": complete.PredictAnything, "-vault-ca-path": complete.PredictAnything, "-vault-cert-file": complete.PredictAnything, "-vault-key-file": complete.PredictAnything, "-vault-tls-skip-verify": complete.PredictNothing, "-vault-tls-server-name": complete.PredictAnything, "-acl-enabled": complete.PredictNothing, "-acl-replication-token": complete.PredictAnything, } } func (c *Command) AutocompleteArgs() complete.Predictor { return nil } func (c *Command) Run(args []string) int { c.Ui = &cli.PrefixedUi{ OutputPrefix: "==> ", InfoPrefix: " ", ErrorPrefix: "==> ", Ui: c.Ui, } // Parse our configs c.args = args config := c.readConfig() if config == nil { return 1 } // reset UI to prevent prefixed json output if config.LogJson { c.Ui = &cli.BasicUi{ Reader: os.Stdin, Writer: os.Stdout, ErrorWriter: os.Stderr, } } // Setup the log outputs logFilter, logGate, logOutput := SetupLoggers(c.Ui, config) c.logFilter = logFilter c.logOutput = logOutput if logGate == nil { return 1 } // Create logger logger := hclog.NewInterceptLogger(&hclog.LoggerOptions{ Name: "agent", Level: hclog.LevelFromString(config.LogLevel), Output: logOutput, JSONFormat: config.LogJson, IncludeLocation: config.LogIncludeLocation, }) // Wrap log messages emitted with the 'log' package. // These usually come from external dependencies. log.SetOutput(logger.StandardWriter(&hclog.StandardLoggerOptions{ InferLevels: true, InferLevelsWithTimestamp: true, })) log.SetPrefix("") log.SetFlags(0) // Swap out UI implementation if json logging is enabled if config.LogJson { c.Ui = &logging.HcLogUI{Log: logger} // Don't buffer json logs because they aren't reordered anyway. logGate.Flush() } // Log config files if len(config.Files) > 0 { c.Ui.Output(fmt.Sprintf("Loaded configuration from %s", strings.Join(config.Files, ", "))) } else { c.Ui.Output("No configuration files loaded") } // Initialize the telemetry inmem, err := c.setupTelemetry(config) if err != nil { c.Ui.Error(fmt.Sprintf("Error initializing telemetry: %s", err)) return 1 } // Create the agent if err := c.setupAgent(config, logger, logOutput, inmem); err != nil { logGate.Flush() return 1 } defer func() { c.agent.Shutdown() // Shutdown the http server at the end, to ease debugging if // the agent takes long to shutdown if len(c.httpServers) > 0 { for _, srv := range c.httpServers { srv.Shutdown() } } }() // Join startup nodes if specified if err := c.startupJoin(config); err != nil { c.Ui.Error(err.Error()) return 1 } // Compile agent information for output later info := make(map[string]string) info["version"] = config.Version.VersionNumber() info["client"] = strconv.FormatBool(config.Client.Enabled) info["log level"] = config.LogLevel info["server"] = strconv.FormatBool(config.Server.Enabled) info["region"] = fmt.Sprintf("%s (DC: %s)", config.Region, config.Datacenter) info["bind addrs"] = c.getBindAddrSynopsis() info["advertise addrs"] = c.getAdvertiseAddrSynopsis() if config.Server.Enabled { serverConfig, err := c.agent.serverConfig() if err == nil { info["node id"] = serverConfig.NodeID } } // Sort the keys for output infoKeys := make([]string, 0, len(info)) for key := range info { infoKeys = append(infoKeys, key) } sort.Strings(infoKeys) // Agent configuration output padding := 18 c.Ui.Output("Nomad agent configuration:\n") for _, k := range infoKeys { c.Ui.Info(fmt.Sprintf( "%s%s: %s", strings.Repeat(" ", padding-len(k)), strings.Title(k), info[k])) } c.Ui.Output("") // Output the header that the server has started c.Ui.Output("Nomad agent started! Log data will stream in below:\n") // Enable log streaming logGate.Flush() // Start retry join process if err := c.handleRetryJoin(config); err != nil { c.Ui.Error(err.Error()) return 1 } // Wait for exit return c.handleSignals() } // handleRetryJoin is used to start retry joining if it is configured. func (c *Command) handleRetryJoin(config *Config) error { c.retryJoinErrCh = make(chan struct{}) if config.Server.Enabled && len(config.Server.RetryJoin) != 0 { joiner := retryJoiner{ discover: &discover.Discover{}, errCh: c.retryJoinErrCh, logger: c.agent.logger.Named("joiner"), serverJoin: c.agent.server.Join, serverEnabled: true, } if err := joiner.Validate(config); err != nil { return err } // Remove the duplicate fields if len(config.Server.RetryJoin) != 0 { config.Server.ServerJoin.RetryJoin = config.Server.RetryJoin config.Server.RetryJoin = nil } if config.Server.RetryMaxAttempts != 0 { config.Server.ServerJoin.RetryMaxAttempts = config.Server.RetryMaxAttempts config.Server.RetryMaxAttempts = 0 } if config.Server.RetryInterval != 0 { config.Server.ServerJoin.RetryInterval = config.Server.RetryInterval config.Server.RetryInterval = 0 } c.agent.logger.Warn("using deprecated retry_join fields. Upgrade configuration to use server_join") } if config.Server.Enabled && config.Server.ServerJoin != nil && len(config.Server.ServerJoin.RetryJoin) != 0 { joiner := retryJoiner{ discover: &discover.Discover{}, errCh: c.retryJoinErrCh, logger: c.agent.logger.Named("joiner"), serverJoin: c.agent.server.Join, serverEnabled: true, } if err := joiner.Validate(config); err != nil { return err } go joiner.RetryJoin(config.Server.ServerJoin) } if config.Client.Enabled && config.Client.ServerJoin != nil && len(config.Client.ServerJoin.RetryJoin) != 0 { joiner := retryJoiner{ discover: &discover.Discover{}, errCh: c.retryJoinErrCh, logger: c.agent.logger.Named("joiner"), clientJoin: c.agent.client.SetServers, clientEnabled: true, } if err := joiner.Validate(config); err != nil { return err } go joiner.RetryJoin(config.Client.ServerJoin) } return nil } // handleSignals blocks until we get an exit-causing signal func (c *Command) handleSignals() int { signalCh := make(chan os.Signal, 4) signal.Notify(signalCh, os.Interrupt, syscall.SIGTERM, syscall.SIGHUP, syscall.SIGPIPE) // Wait for a signal WAIT: var sig os.Signal select { case s := <-signalCh: sig = s case <-winsvc.ShutdownChannel(): sig = os.Interrupt case <-c.ShutdownCh: sig = os.Interrupt case <-c.retryJoinErrCh: return 1 } // Skip any SIGPIPE signal and don't try to log it (See issues #1798, #3554) if sig == syscall.SIGPIPE { goto WAIT } c.Ui.Output(fmt.Sprintf("Caught signal: %v", sig)) // Check if this is a SIGHUP if sig == syscall.SIGHUP { c.handleReload() goto WAIT } // Check if we should do a graceful leave graceful := false if sig == os.Interrupt && c.agent.GetConfig().LeaveOnInt { graceful = true } else if sig == syscall.SIGTERM && c.agent.GetConfig().LeaveOnTerm { graceful = true } // Bail fast if not doing a graceful leave if !graceful { return 1 } // Attempt a graceful leave gracefulCh := make(chan struct{}) c.Ui.Output("Gracefully shutting down agent...") go func() { if err := c.agent.Leave(); err != nil { c.Ui.Error(fmt.Sprintf("Error: %s", err)) return } close(gracefulCh) }() // Wait for leave or another signal select { case <-signalCh: return 1 case <-time.After(gracefulTimeout): return 1 case <-gracefulCh: return 0 } } // reloadHTTPServer shuts down the existing HTTP server and restarts it. This // is helpful when reloading the agent configuration. func (c *Command) reloadHTTPServer() error { c.agent.logger.Info("reloading HTTP server with new TLS configuration") for _, srv := range c.httpServers { srv.Shutdown() } httpServers, err := NewHTTPServers(c.agent, c.agent.config) if err != nil { return err } c.httpServers = httpServers return nil } // handleReload is invoked when we should reload our configs, e.g. SIGHUP func (c *Command) handleReload() { c.Ui.Output("Reloading configuration...") newConf := c.readConfig() if newConf == nil { c.Ui.Error("Failed to reload configs") return } // Change the log level minLevel := logutils.LogLevel(strings.ToUpper(newConf.LogLevel)) if ValidateLevelFilter(minLevel, c.logFilter) { c.logFilter.SetMinLevel(minLevel) } else { c.Ui.Error(fmt.Sprintf( "Invalid log level: %s. Valid log levels are: %v", minLevel, c.logFilter.Levels)) // Keep the current log level newConf.LogLevel = c.agent.GetConfig().LogLevel } shouldReloadAgent, shouldReloadHTTP := c.agent.ShouldReload(newConf) if shouldReloadAgent { c.agent.logger.Debug("starting reload of agent config") err := c.agent.Reload(newConf) if err != nil { c.agent.logger.Error("failed to reload the config", "error", err) return } } if s := c.agent.Server(); s != nil { c.agent.logger.Debug("starting reload of server config") sconf, err := convertServerConfig(newConf) if err != nil { c.agent.logger.Error("failed to convert server config", "error", err) return } // Finalize the config to get the agent objects injected in c.agent.finalizeServerConfig(sconf) // Reload the config if err := s.Reload(sconf); err != nil { c.agent.logger.Error("reloading server config failed", "error", err) return } } if client := c.agent.Client(); client != nil { c.agent.logger.Debug("starting reload of client config") clientConfig, err := convertClientConfig(newConf) if err != nil { c.agent.logger.Error("failed to convert client config", "error", err) return } // Finalize the config to get the agent objects injected in if err := c.agent.finalizeClientConfig(clientConfig); err != nil { c.agent.logger.Error("failed to finalize client config", "error", err) return } if err := client.Reload(clientConfig); err != nil { c.agent.logger.Error("reloading client config failed", "error", err) return } } // reload HTTP server after we have reloaded both client and server, in case // we error in either of the above cases. For example, reloading the http // server to a TLS connection could succeed, while reloading the server's rpc // connections could fail. if shouldReloadHTTP { err := c.reloadHTTPServer() if err != nil { c.agent.httpLogger.Error("reloading config failed", "error", err) return } } } // setupTelemetry is used ot setup the telemetry sub-systems func (c *Command) setupTelemetry(config *Config) (*metrics.InmemSink, error) { /* Setup telemetry Aggregate on 10 second intervals for 1 minute. Expose the metrics over stderr when there is a SIGUSR1 received. */ inm := metrics.NewInmemSink(10*time.Second, time.Minute) metrics.DefaultInmemSignal(inm) var telConfig *Telemetry if config.Telemetry == nil { telConfig = &Telemetry{} } else { telConfig = config.Telemetry } metricsConf := metrics.DefaultConfig("nomad") metricsConf.EnableHostname = !telConfig.DisableHostname // Prefer the hostname as a label. metricsConf.EnableHostnameLabel = !telConfig.DisableHostname if telConfig.UseNodeName { metricsConf.HostName = config.NodeName metricsConf.EnableHostname = true } allowedPrefixes, blockedPrefixes, err := telConfig.PrefixFilters() if err != nil { return inm, err } metricsConf.AllowedPrefixes = allowedPrefixes metricsConf.BlockedPrefixes = blockedPrefixes if telConfig.FilterDefault != nil { metricsConf.FilterDefault = *telConfig.FilterDefault } // Configure the statsite sink var fanout metrics.FanoutSink if telConfig.StatsiteAddr != "" { sink, err := metrics.NewStatsiteSink(telConfig.StatsiteAddr) if err != nil { return inm, err } fanout = append(fanout, sink) } // Configure the statsd sink if telConfig.StatsdAddr != "" { sink, err := metrics.NewStatsdSink(telConfig.StatsdAddr) if err != nil { return inm, err } fanout = append(fanout, sink) } // Configure the prometheus sink if telConfig.PrometheusMetrics { promSink, err := prometheus.NewPrometheusSink() if err != nil { return inm, err } fanout = append(fanout, promSink) } // Configure the datadog sink if telConfig.DataDogAddr != "" { sink, err := datadog.NewDogStatsdSink(telConfig.DataDogAddr, config.NodeName) if err != nil { return inm, err } sink.SetTags(telConfig.DataDogTags) fanout = append(fanout, sink) } // Configure the Circonus sink if telConfig.CirconusAPIToken != "" || telConfig.CirconusCheckSubmissionURL != "" { cfg := &circonus.Config{} cfg.Interval = telConfig.CirconusSubmissionInterval cfg.CheckManager.API.TokenKey = telConfig.CirconusAPIToken cfg.CheckManager.API.TokenApp = telConfig.CirconusAPIApp cfg.CheckManager.API.URL = telConfig.CirconusAPIURL cfg.CheckManager.Check.SubmissionURL = telConfig.CirconusCheckSubmissionURL cfg.CheckManager.Check.ID = telConfig.CirconusCheckID cfg.CheckManager.Check.ForceMetricActivation = telConfig.CirconusCheckForceMetricActivation cfg.CheckManager.Check.InstanceID = telConfig.CirconusCheckInstanceID cfg.CheckManager.Check.SearchTag = telConfig.CirconusCheckSearchTag cfg.CheckManager.Check.Tags = telConfig.CirconusCheckTags cfg.CheckManager.Check.DisplayName = telConfig.CirconusCheckDisplayName cfg.CheckManager.Broker.ID = telConfig.CirconusBrokerID cfg.CheckManager.Broker.SelectTag = telConfig.CirconusBrokerSelectTag if cfg.CheckManager.Check.DisplayName == "" { cfg.CheckManager.Check.DisplayName = "Nomad" } if cfg.CheckManager.API.TokenApp == "" { cfg.CheckManager.API.TokenApp = "nomad" } if cfg.CheckManager.Check.SearchTag == "" { cfg.CheckManager.Check.SearchTag = "service:nomad" } sink, err := circonus.NewCirconusSink(cfg) if err != nil { return inm, err } sink.Start() fanout = append(fanout, sink) } // Initialize the global sink if len(fanout) > 0 { fanout = append(fanout, inm) metrics.NewGlobal(metricsConf, fanout) } else { metricsConf.EnableHostname = false metrics.NewGlobal(metricsConf, inm) } return inm, nil } func (c *Command) startupJoin(config *Config) error { // Nothing to do if !config.Server.Enabled { return nil } // Validate both old and new aren't being set old := len(config.Server.StartJoin) var new int if config.Server.ServerJoin != nil { new = len(config.Server.ServerJoin.StartJoin) } if old != 0 && new != 0 { return fmt.Errorf("server_join and start_join cannot both be defined; prefer setting the server_join block") } // Nothing to do if old+new == 0 { return nil } // Combine the lists and join joining := config.Server.StartJoin if new != 0 { joining = append(joining, config.Server.ServerJoin.StartJoin...) } c.Ui.Output("Joining cluster...") n, err := c.agent.server.Join(joining) if err != nil { return err } c.Ui.Output(fmt.Sprintf("Join completed. Synced with %d initial agents", n)) return nil } // getBindAddrSynopsis returns a string that describes the addresses the agent // is bound to. func (c *Command) getBindAddrSynopsis() string { if c == nil || c.agent == nil || c.agent.config == nil || c.agent.config.normalizedAddrs == nil { return "" } b := new(strings.Builder) fmt.Fprintf(b, "HTTP: %s", c.agent.config.normalizedAddrs.HTTP) if c.agent.server != nil { if c.agent.config.normalizedAddrs.RPC != "" { fmt.Fprintf(b, "; RPC: %s", c.agent.config.normalizedAddrs.RPC) } if c.agent.config.normalizedAddrs.Serf != "" { fmt.Fprintf(b, "; Serf: %s", c.agent.config.normalizedAddrs.Serf) } } return b.String() } // getAdvertiseAddrSynopsis returns a string that describes the addresses the agent // is advertising. func (c *Command) getAdvertiseAddrSynopsis() string { if c == nil || c.agent == nil || c.agent.config == nil || c.agent.config.AdvertiseAddrs == nil { return "" } b := new(strings.Builder) fmt.Fprintf(b, "HTTP: %s", c.agent.config.AdvertiseAddrs.HTTP) if c.agent.server != nil { if c.agent.config.AdvertiseAddrs.RPC != "" { fmt.Fprintf(b, "; RPC: %s", c.agent.config.AdvertiseAddrs.RPC) } if c.agent.config.AdvertiseAddrs.Serf != "" { fmt.Fprintf(b, "; Serf: %s", c.agent.config.AdvertiseAddrs.Serf) } } return b.String() } func (c *Command) Synopsis() string { return "Runs a Nomad agent" } func (c *Command) Help() string { helpText := ` Usage: nomad agent [options] Starts the Nomad agent and runs until an interrupt is received. The agent may be a client and/or server. The Nomad agent's configuration primarily comes from the config files used, but a subset of the options may also be passed directly as CLI arguments, listed below. General Options (clients and servers): -bind= The address the agent will bind to for all of its various network services. The individual services that run bind to individual ports on this address. Defaults to the loopback 127.0.0.1. -config= The path to either a single config file or a directory of config files to use for configuring the Nomad agent. This option may be specified multiple times. If multiple config files are used, the values from each will be merged together. During merging, values from files found later in the list are merged over values from previously parsed files. -data-dir= The data directory used to store state and other persistent data. On client machines this is used to house allocation data such as downloaded artifacts used by drivers. On server nodes, the data dir is also used to store the replicated log. -plugin-dir= The plugin directory is used to discover Nomad plugins. If not specified, the plugin directory defaults to be that of /plugins/. -dc= The name of the datacenter this Nomad agent is a member of. By default this is set to "dc1". -log-level= Specify the verbosity level of Nomad's logs. Valid values include DEBUG, INFO, and WARN, in decreasing order of verbosity. The default is INFO. -log-json Output logs in a JSON format. The default is false. -log-include-location Include file and line information in each log line. The default is false. -node= The name of the local agent. This name is used to identify the node in the cluster. The name must be unique per region. The default is the current hostname of the machine. -region= Name of the region the Nomad agent will be a member of. By default this value is set to "global". -dev Start the agent in development mode. This enables a pre-configured dual-role agent (client + server) which is useful for developing or testing Nomad. No other configuration is required to start the agent in this mode, but you may pass an optional comma-separated list of mode configurations: -dev-connect Start the agent in development mode, but bind to a public network interface rather than localhost for using Consul Connect. This mode is supported only on Linux as root. Server Options: -server Enable server mode for the agent. Agents in server mode are clustered together and handle the additional responsibility of leader election, data replication, and scheduling work onto eligible client nodes. -bootstrap-expect= Configures the expected number of servers nodes to wait for before bootstrapping the cluster. Once servers have joined each other, Nomad initiates the bootstrap process. -encrypt= Provides the gossip encryption key -join=
Address of an agent to join at start time. Can be specified multiple times. -raft-protocol= The Raft protocol version to use. Used for enabling certain Autopilot features. Defaults to 2. -retry-join=
Address of an agent to join at start time with retries enabled. Can be specified multiple times. -retry-max= Maximum number of join attempts. Defaults to 0, which will retry indefinitely. -retry-interval= Time to wait between join attempts. -rejoin Ignore a previous leave and attempts to rejoin the cluster. Client Options: -client Enable client mode for the agent. Client mode enables a given node to be evaluated for allocations. If client mode is not enabled, no work will be scheduled to the agent. -state-dir The directory used to store state and other persistent data. If not specified a subdirectory under the "-data-dir" will be used. -alloc-dir The directory used to store allocation data such as downloaded artifacts as well as data produced by tasks. If not specified, a subdirectory under the "-data-dir" will be used. -servers A list of known server addresses to connect to given as "host:port" and delimited by commas. -node-class Mark this node as a member of a node-class. This can be used to label similar node types. -node-pool Register this node in this node pool. If the node pool does not exist it will be created automatically if the node registers in the authoritative region. In non-authoritative regions, the node is kept in the 'initializing' status until the node pool is created and replicated. -meta User specified metadata to associated with the node. Each instance of -meta parses a single KEY=VALUE pair. Repeat the meta flag for each key/value pair to be added. -network-interface Forces the network fingerprinter to use the specified network interface. -network-speed The default speed for network interfaces in MBits if the link speed can not be determined dynamically. ACL Options: -acl-enabled Specifies whether the agent should enable ACLs. -acl-replication-token The replication token for servers to use when replicating from the authoritative region. The token must be a valid management token from the authoritative region. Consul Options: -consul-address= Specifies the address to the local Consul agent, given in the format host:port. Supports Unix sockets with the format: unix:///tmp/consul/consul.sock -consul-auth= Specifies the HTTP Basic Authentication information to use for access to the Consul Agent, given in the format username:password. -consul-auto-advertise Specifies if Nomad should advertise its services in Consul. The services are named according to server_service_name and client_service_name. Nomad servers and clients advertise their respective services, each tagged appropriately with either http or rpc tag. Nomad servers also advertise a serf tagged service. -consul-ca-file= Specifies an optional path to the CA certificate used for Consul communication. This defaults to the system bundle if unspecified. -consul-cert-file= Specifies the path to the certificate used for Consul communication. If this is set then you need to also set key_file. -consul-checks-use-advertise Specifies if Consul heath checks should bind to the advertise address. By default, this is the bind address. -consul-client-auto-join Specifies if the Nomad clients should automatically discover servers in the same region by searching for the Consul service name defined in the server_service_name option. -consul-client-service-name= Specifies the name of the service in Consul for the Nomad clients. -consul-client-http-check-name= Specifies the HTTP health check name in Consul for the Nomad clients. -consul-key-file= Specifies the path to the private key used for Consul communication. If this is set then you need to also set cert_file. -consul-server-service-name= Specifies the name of the service in Consul for the Nomad servers. -consul-server-http-check-name= Specifies the HTTP health check name in Consul for the Nomad servers. -consul-server-serf-check-name= Specifies the Serf health check name in Consul for the Nomad servers. -consul-server-rpc-check-name= Specifies the RPC health check name in Consul for the Nomad servers. -consul-server-auto-join Specifies if the Nomad servers should automatically discover and join other Nomad servers by searching for the Consul service name defined in the server_service_name option. This search only happens if the server does not have a leader. -consul-ssl Specifies if the transport scheme should use HTTPS to communicate with the Consul agent. -consul-token= Specifies the token used to provide a per-request ACL token. -consul-verify-ssl Specifies if SSL peer verification should be used when communicating to the Consul API client over HTTPS. Vault Options: -vault-enabled Whether to enable or disable Vault integration. -vault-address= The address to communicate with Vault. This should be provided with the http:// or https:// prefix. -vault-token= The Vault token used to derive tokens from Vault on behalf of clients. This only needs to be set on Servers. Overrides the Vault token read from the VAULT_TOKEN environment variable. -vault-create-from-role= The role name to create tokens for tasks from. -vault-allow-unauthenticated Whether to allow jobs to be submitted that request Vault Tokens but do not authentication. The flag only applies to Servers. -vault-ca-file= The path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate. -vault-ca-path= The path to a directory of PEM-encoded CA cert files to verify the Vault server certificate. -vault-cert-file= The path to the certificate for Vault communication. -vault-key-file= The path to the private key for Vault communication. -vault-tls-skip-verify= Enables or disables SSL certificate verification. -vault-tls-server-name= Used to set the SNI host when connecting over TLS. ` return strings.TrimSpace(helpText) }