wip client config validation

client/config/config.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"net"
 	"os"
 	"reflect"
 	"strconv"
@@ -103,6 +104,8 @@ type Config struct {
 
 	// Network speed is the default speed of network interfaces if they can not
 	// be determined dynamically.
+	//
+	// Deprecated since 0.12: https://www.nomadproject.io/docs/upgrade/upgrade-specific#nomad-0-12-0
 	NetworkSpeed int
 
 	// CpuCompute is the default total CPU compute if they can not be determined
@@ -913,3 +916,174 @@ func (c *Config) NomadPluginConfig() *base.AgentConfig {
 		},
 	}
 }
+
+// Validate Client Agent Configuration. Returns a multierror.Error. Fields are
+// refenced by their snake_case/HCL naming convention to match documentation.
+//
+// Must be called on an initialized Config such as generated by DefaultConfig.
+//
+// Many fields that are shared with server agents are not validated here such
+// as:
+//
+//	StateDir
+//	AllocDir
+//	ConsulConfig
+//	VaultConfig
+//	StatsCollectionInterval
+//	TLSConfig
+//	LogLevel
+//
+// NetworkInterface is not validated.
+func (c *Config) Validate() *helper.ValidationResults {
+	results := helper.NewValidationResults()
+
+	if c.Region == "" {
+		results.AppendErrorf("Missing region")
+	} else {
+		//TODO Emit warning if region name is not a valid hostname
+	}
+
+	if n := c.NetworkSpeed; n < 0 {
+		results.AppendErrorf("network_speed must be >= 0 but found: %v", n)
+	}
+
+	if n := c.CpuCompute; n < 0 {
+		results.AppendErrorf("cpu_total_compute must be >= 0 but found: %v", n)
+	}
+
+	if n := c.MemoryMB; n < 0 {
+		results.AppendErrorf("memory_total_mb must be >= 0 but found: %v", n)
+	}
+
+	if n := c.MaxKillTimeout; n < 0 {
+		results.AppendErrorf("max_kill_timeout must be >= 0 but found: %v", n)
+	}
+
+	for i, s := range c.Servers {
+		_, _, err := net.SplitHostPort(s)
+		if err == nil {
+			continue
+		}
+		results.AppendErrorf("servers[%d] invalid: %v", i, err)
+	}
+
+	c.validateNode(results, c.Node)
+
+	if c.MaxDynamicPort > structs.MaxValidPort {
+		results.AppendErrorf("max_dynamic_port must be <= %d but found %d", structs.MaxValidPort, c.MaxDynamicPort)
+	}
+
+	if c.MaxDynamicPort == 0 {
+		results.AppendErrorf("max_dynamic_port must be > 0")
+	}
+
+	if c.MinDynamicPort > structs.MaxValidPort {
+		results.AppendErrorf("min_dynamic_port must be <= %d but found %d", structs.MaxValidPort, c.MinDynamicPort)
+	}
+
+	if c.MinDynamicPort == 0 {
+		results.AppendErrorf("min_dynamic_port must be > 0")
+	}
+
+	if c.MinDynamicPort > c.MaxDynamicPort {
+		results.AppendErrorf("min_dynamic_port (%d) must be < max_dynamic_port (%d)", c.MinDynamicPort, c.MaxDynamicPort)
+	}
+
+	//TODO Validate ChrootEnv
+
+	if c.GCInterval <= 0 {
+		results.AppendErrorf("gc_interval must be > 0 but found %s", c.GCInterval)
+	}
+
+	if c.GCParallelDestroys <= 0 {
+		results.AppendErrorf("gc_parallel_destroys must be > 0 but found %d", c.GCParallelDestroys)
+	}
+
+	if c.GCDiskUsageThreshold <= 0 {
+		results.AppendErrorf("gc_disk_usage_threshold must be > 0 but found %f", c.GCDiskUsageThreshold)
+	}
+
+	if c.GCInodeUsageThreshold <= 0 {
+		results.AppendErrorf("gc_inode_usage_threshold must be > 0 but found %f", c.GCInodeUsageThreshold)
+	}
+
+	if c.GCMaxAllocs <= 0 {
+		results.AppendErrorf("gc_max_allocs must be > 0 but found %d", c.GCMaxAllocs)
+	}
+
+	panic("TODO start at ACLTokenTTL")
+
+	return results
+}
+
+// validateNode validates the subset of structs.Node fields configured for
+// client agents.
+func (c *Config) validateNode(results *helper.ValidationResults, node *structs.Node) {
+	if node == nil {
+		// Node should be statically initialized so a failure here is a coding error.
+		results.AppendErrorf("Node should be initialized. Please report a bug.")
+		return
+	}
+
+	if node.Datacenter == "" {
+		// Datacenter should be statically initialized so a failure here is a coding error.
+		results.AppendErrorf("datacenter must be set.")
+	} else {
+		//TODO Emit warning if Datacenter is not a valid hostname
+	}
+
+	if node.Name == "" {
+		results.AppendErrorf("name must be set.")
+	}
+
+	if _, _, err := net.SplitHostPort(node.HTTPAddr); err != nil {
+		// Should be unreachable due to agent's address normalization,
+		// but doesn't hurt to double check.
+		results.AppendErrorf("http address invalid: %v", err)
+	}
+
+	c.validateNodeReserved(results, node.ReservedResources)
+}
+
+// validateNodeReserved validates the node reserved resources for client
+// agents.
+//
+// Node.Reserved is deprecated but until all references are removed it
+// should be validated.
+func (c *Config) validateNodeReserved(results *helper.ValidationResults, r *structs.NodeReservedResources) {
+	if r == nil {
+		// Coding error so use Go name for field instead of HCL.
+		results.AppendErrorf("Node.ReservedResources must be initialized. Please report a bug")
+		return
+	}
+
+	if r.Cpu.CpuShares < 0 {
+		results.AppendErrorf("reserved.cpu must be >= 0 but found: %d", r.Cpu.CpuShares)
+	}
+
+	if c.CpuCompute > 0 && int64(c.CpuCompute) <= r.Cpu.CpuShares {
+		//TODO Elevate to error post-1.2.x
+		results.AppendWarning("reserved.cpu >= cpu_total_compute: node will be ineligible for new work until fixed (this warning may become a fatal error in the future)")
+	}
+
+	// ReservedCpuCores is validated by the Agent
+
+	if r.Memory.MemoryMB < 0 {
+		results.AppendErrorf("reserved.memory must be >= 0 but found: %d", r.Memory.MemoryMB)
+	}
+
+	if c.MemoryMB > 0 && int64(c.MemoryMB) <= r.Memory.MemoryMB {
+		//TODO Elevate to error post-1.2.x
+		results.AppendWarning("reserved.memory >= memory_total_mb: node will be ineligible for new work until fixed (this warning may become a fatal error in the future)")
+	}
+
+	if r.Disk.DiskMB < 0 {
+		results.AppendErrorf("reserved.disk must be >= 0 but found: %d", r.Disk.DiskMB)
+	}
+
+	if ports := r.Networks.ReservedHostPorts; ports != "" {
+		if _, err := structs.ParsePortRanges(ports); err != nil {
+			results.AppendErrorf("reserved.reserved_ports %q invalid: %w", ports, err)
+		}
+	}
+}