Merge pull request 'cluster: introduce Machine.Inactive flag' (#38)

Reviewed-on: #38

cmd/jpictl/config.go

@@ -12,6 +12,14 @@ const (
 	// DefaultConfigFile is read if -f/--config-file isn't specified.
 	// If it doesn't exist, m/ will be scanned
 	DefaultConfigFile = "cloud.yaml"
+
+	// DefaultClusterDir is the directory we will scan and write
+	// unless something else is indicated
+	DefaultClusterDir = "m"
+
+	// DefaultDomain indicates the domain to use unless
+	// something else is specified
+	DefaultDomain = "jpi.cloud"
 )
 
 // Config describes the repository
@@ -22,27 +30,34 @@ type Config struct {
 	ConfigFile string
 }
 
+var forceScan bool
+
 var cfg = &Config{
-	Base:   "m",
+	Base:   DefaultClusterDir,
-	Domain: "jpi.cloud",
+	Domain: DefaultDomain,
 }
 
 // LoadZones loads all zones and machines in the config directory
 // or file
 func (cfg *Config) LoadZones(resolve bool) (*cluster.Cluster, error) {
-	// try config file first
+	var zones *cluster.Cluster
-	zones, err := cluster.NewFromConfig(cfg.ConfigFile,
+	var err error
-		cluster.ResolvePublicAddresses(resolve),
-		cluster.WithLogger(log),
-	)
 
-	switch {
+	if !forceScan {
-	case err == nil:
+		// try config file first
-		// file was good
+		zones, err = cluster.NewFromConfig(cfg.ConfigFile,
-		return zones, nil
+			cluster.ResolvePublicAddresses(resolve),
-	case !os.IsNotExist(err) || cfg.ConfigFile != DefaultConfigFile:
+			cluster.WithLogger(log),
-		// file was bad
+		)
-		return nil, core.Wrap(err, "NewFromConfig(%q)", cfg.ConfigFile)
+
+		switch {
+		case err == nil:
+			// file was good
+			return zones, nil
+		case !os.IsNotExist(err) || cfg.ConfigFile != DefaultConfigFile:
+			// file was bad
+			return nil, core.Wrap(err, "NewFromConfig(%q)", cfg.ConfigFile)
+		}
 	}
 
 	// default file doesn't exist. scan instead.
@@ -53,7 +68,15 @@ func (cfg *Config) LoadZones(resolve bool) (*cluster.Cluster, error) {
 }
 
 func init() {
-	rootCmd.PersistentFlags().
+	flags := rootCmd.PersistentFlags()
-		StringVarP(&cfg.ConfigFile, "config-file", "f",
+
-			DefaultConfigFile, "config file (JSON or YAML)")
+	flags.StringVarP(&cfg.Base, "scan-dir", "d",
+		DefaultClusterDir, "directory to scan for cluster data")
+	flags.StringVarP(&cfg.Domain, "domain", "D",
+		DefaultDomain, "domain to use for scanned data")
+	flags.StringVarP(&cfg.ConfigFile, "config-file", "f",
+		DefaultConfigFile, "config file (JSON or YAML)")
+
+	flags.BoolVarP(&forceScan, "force-scan", "S",
+		false, "ignore config file and scan the directory instead")
 }

cmd/jpictl/dns.go

@@ -52,7 +52,7 @@ func populateDNSManager(mgr *dns.Manager, m *cluster.Cluster) error {
 
 	m.ForEachZone(func(z *cluster.Zone) bool {
 		z.ForEachMachine(func(p *cluster.Machine) bool {
-			err = mgr.AddHost(ctx, z.Name, p.ID, true, p.PublicAddresses...)
+			err = mgr.AddHost(ctx, z.Name, p.ID, p.IsActive(), p.PublicAddresses...)
 			return err != nil
 		})
 

cmd/jpictl/log.go

@@ -3,9 +3,13 @@ package main
 import (
 	"fmt"
 
+	"darvaza.org/sidecar/pkg/logger/zerolog"
 	"darvaza.org/slog"
+	"github.com/spf13/cobra"
 )
 
+var log = zerolog.New(nil, slog.Error)
+
 // fatal is a convenience wrapper for slog.Logger.Fatal().Print()
 func fatal(err error, msg string, args ...any) {
 	l := log.Fatal()
@@ -19,3 +23,20 @@ func fatal(err error, msg string, args ...any) {
 
 	panic("unreachable")
 }
+
+var verbosity int
+
+// setVerbosity replaces the global logger using the
+// verbosity level specified via -v flags
+func setVerbosity(_ *cobra.Command, _ []string) {
+	desired := int8(slog.Error) + int8(verbosity)
+	if desired > 6 {
+		desired = 6
+	}
+	log = zerolog.New(nil, slog.LogLevel(desired))
+}
+
+func init() {
+	rootCmd.PersistentFlags().CountVarP(&verbosity, "verbosity", "v",
+		"increase the verbosity level to Warn, Info or Debug")
+}

cmd/jpictl/main.go

@@ -2,8 +2,6 @@
 package main
 
 import (
-	"darvaza.org/sidecar/pkg/logger/zerolog"
-	"darvaza.org/slog"
 	"github.com/spf13/cobra"
 )
 
@@ -13,9 +11,7 @@ const (
 )
 
 var (
-	log       = zerolog.New(nil, slog.Error)
+	rootCmd = &cobra.Command{
-	verbosity int
-	rootCmd   = &cobra.Command{
 		Use:   CmdName,
 		Short: "control tool for jpi.cloud",
 	}
@@ -26,16 +22,3 @@ func main() {
 		fatal(err, "")
 	}
 }
-
-func init() {
-	rootCmd.PersistentFlags().CountVarP(&verbosity, "verbosity", "v",
-		"increase the verbosity level to Warn, Info or Debug")
-}
-
-func setVerbosity(_ *cobra.Command, _ []string) {
-	desired := int8(slog.Error) + int8(verbosity)
-	if desired > 6 {
-		desired = 6
-	}
-	log = zerolog.New(nil, slog.LogLevel(desired))
-}

pkg/cluster/cluster_file.go

@@ -1,9 +1,12 @@
 package cluster
 
 import (
+	"bufio"
+	"bytes"
 	"fmt"
 	"io"
 	"os"
+	"strings"
 
 	fs "github.com/hack-pad/hackpadfs"
 )
@@ -40,6 +43,21 @@ func (m *Cluster) openWriter(name string, flags int, args ...any) (io.WriteClose
 	panic("unreachable")
 }
 
+// RemoveFile deletes a file from the cluster's config directory
+func (m *Cluster) RemoveFile(name string, args ...any) error {
+	if len(args) > 0 {
+		name = fmt.Sprintf(name, args...)
+	}
+
+	err := fs.Remove(m.dir, name)
+	switch {
+	case os.IsNotExist(err):
+		return nil
+	default:
+		return err
+	}
+}
+
 // ReadFile reads a file from the cluster's config directory
 func (m *Cluster) ReadFile(name string, args ...any) ([]byte, error) {
 	if len(args) > 0 {
@@ -48,3 +66,50 @@ func (m *Cluster) ReadFile(name string, args ...any) ([]byte, error) {
 
 	return fs.ReadFile(m.dir, name)
 }
+
+// ReadLines reads a file from the cluster's config directory,
+// split by lines, trimmed, and accepting `#` to comment lines out.
+func (m *Cluster) ReadLines(name string, args ...any) ([]string, error) {
+	var out []string
+
+	data, err := m.ReadFile(name, args...)
+	if err != nil {
+		return nil, err
+	}
+
+	sc := bufio.NewScanner(bytes.NewReader(data))
+	for sc.Scan() {
+		s := strings.TrimSpace(sc.Text())
+		switch {
+		case s == "", strings.HasPrefix(s, "#"):
+			// ignore
+		default:
+			// accepted
+			out = append(out, s)
+		}
+	}
+
+	return out, nil
+}
+
+// WriteStringFile writes the given content to a file on the machine's config directory
+func (m *Cluster) WriteStringFile(value string, name string, args ...any) error {
+	f, err := m.CreateTruncFile(name, args...)
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+
+	buf := bytes.NewBufferString(value)
+	_, err = buf.WriteTo(f)
+	return err
+}
+
+// MkdirAll creates directories relative to the cluster's config directory
+func (m *Cluster) MkdirAll(name string, args ...any) error {
+	if len(args) > 0 {
+		name = fmt.Sprintf(name, args...)
+	}
+
+	return fs.MkdirAll(m.dir, name, 0755)
+}

pkg/cluster/cluster_scan.go

@@ -73,6 +73,10 @@ func (m *Cluster) scanMachines(opts *ScanOptions) error {
 		err = p.scan(opts)
 		return err != nil
 	})
+	m.ForEachMachine(func(p *Machine) bool {
+		err = p.scanWrapUp(opts)
+		return err != nil
+	})
 	return err
 }
 

pkg/cluster/machine.go

@@ -15,6 +15,7 @@ type Machine struct {
 	ID   int
 	Name string `json:"-" yaml:"-"`
 
+	Inactive        bool         `json:"inactive,omitempty"     yaml:"inactive,omitempty"`
 	CephMonitor     bool         `json:"ceph_monitor,omitempty" yaml:"ceph_monitor,omitempty"`
 	PublicAddresses []netip.Addr `json:"public,omitempty"       yaml:"public,omitempty"`
 	Rings           []*RingInfo  `json:"rings,omitempty"        yaml:"rings,omitempty"`
@@ -43,6 +44,11 @@ func (m *Machine) FullName() string {
 	return strings.Join(name, ".")
 }
 
+// IsActive indicates the machine is to be included in regions' DNS entries
+func (m *Machine) IsActive() bool {
+	return !m.Inactive
+}
+
 // IsGateway tells if the Machine is a ring0 gateway
 func (m *Machine) IsGateway() bool {
 	_, ok := m.getRingInfo(0)

pkg/cluster/machine_file.go

@@ -1,7 +1,6 @@
 package cluster
 
 import (
-	"bytes"
 	"fmt"
 	"io"
 	"os"
@@ -12,10 +11,9 @@ import (
 
 // OpenFile opens a file on the machine's config directory with the specified flags
 func (m *Machine) OpenFile(name string, flags int, args ...any) (fs.File, error) {
-	base := m.zone.zones.dir
 	fullName := m.getFilename(name, args...)
 
-	return fs.OpenFile(base, fullName, flags, 0644)
+	return m.zone.zones.OpenFile(fullName, flags)
 }
 
 // CreateTruncFile creates or truncates a file on the machine's config directory
@@ -43,37 +41,38 @@ func (m *Machine) openWriter(name string, flags int, args ...any) (io.WriteClose
 
 // RemoveFile deletes a file from the machine's config directory
 func (m *Machine) RemoveFile(name string, args ...any) error {
-	base := m.zone.zones.dir
 	fullName := m.getFilename(name, args...)
-	err := fs.Remove(base, fullName)
 
-	switch {
+	return m.zone.zones.RemoveFile(fullName)
-	case os.IsNotExist(err):
-		return nil
-	default:
-		return err
-	}
 }
 
 // ReadFile reads a file from the machine's config directory
 func (m *Machine) ReadFile(name string, args ...any) ([]byte, error) {
-	base := m.zone.zones.dir
 	fullName := m.getFilename(name, args...)
 
-	return fs.ReadFile(base, fullName)
+	return m.zone.zones.ReadFile(fullName)
+}
+
+// ReadLines reads a file from the machine's config directory,
+// split by lines, trimmed, and accepting `#` to comment lines out.
+func (m *Machine) ReadLines(name string, args ...any) ([]string, error) {
+	fullName := m.getFilename(name, args...)
+
+	return m.zone.zones.ReadLines(fullName)
 }
 
 // WriteStringFile writes the given content to a file on the machine's config directory
 func (m *Machine) WriteStringFile(value string, name string, args ...any) error {
-	f, err := m.CreateTruncFile(name, args...)
+	fullName := m.getFilename(name, args...)
-	if err != nil {
-		return err
-	}
-	defer f.Close()
 
-	buf := bytes.NewBufferString(value)
+	return m.zone.zones.WriteStringFile(value, fullName)
-	_, err = buf.WriteTo(f)
+}
-	return err
+
+// MkdirAll creates directories relative to the machine's config directory
+func (m *Machine) MkdirAll(name string, args ...any) error {
+	fullName := m.getFilename(name, args...)
+
+	return m.zone.zones.MkdirAll(fullName)
 }
 
 func (m *Machine) getFilename(name string, args ...any) string {

pkg/cluster/machine_rings.go

@@ -118,21 +118,31 @@ func (m *Machine) tryApplyWireguardConfig(ring int) error {
 	}
 }
 
-func (m *Machine) applyWireguardConfig(ring int, wg *wireguard.Config) error {
+func (m *Machine) applyWireguardConfigNode(ring int, wg *wireguard.Config) error {
 	addr := wg.GetAddress()
-	zoneID, nodeID, ok := Rings[ring].Decode(addr)
+	if !core.IsZero(addr) {
-	if !ok {
+		zoneID, nodeID, ok := Rings[ring].Decode(addr)
-		return fmt.Errorf("%s: invalid address", addr)
+		if !ok {
-	}
+			return fmt.Errorf("%s: invalid address", addr)
+		}
 
-	if err := m.applyZoneNodeID(zoneID, nodeID); err != nil {
+		if err := m.applyZoneNodeID(zoneID, nodeID); err != nil {
-		return core.Wrap(err, "%s: invalid address", addr)
+			return core.Wrap(err, "%s: invalid address", addr)
+		}
 	}
 
 	if err := m.applyWireguardInterfaceConfig(ring, wg.Interface); err != nil {
 		return core.Wrap(err, "interface")
 	}
 
+	return nil
+}
+
+func (m *Machine) applyWireguardConfig(ring int, wg *wireguard.Config) error {
+	if err := m.applyWireguardConfigNode(ring, wg); err != nil {
+		return err
+	}
+
 	for _, peer := range wg.Peer {
 		err := m.applyWireguardPeerConfig(ring, peer)
 		switch {
@@ -230,6 +240,23 @@ func (m *Machine) applyZoneNodeID(zoneID, nodeID int) error {
 	return nil
 }
 
+func (m *Machine) setRingDefaults(ri *RingInfo) error {
+	if ri.Keys.PrivateKey.IsZero() {
+		m.info().
+			WithField("subsystem", "wireguard").
+			WithField("node", m.Name).
+			WithField("ring", ri.Ring).
+			Print("generating key pair")
+
+		kp, err := wireguard.NewKeyPair()
+		if err != nil {
+			return err
+		}
+		ri.Keys = kp
+	}
+	return nil
+}
+
 // RemoveWireguardConfig deletes wgN.conf from the machine's
 // config directory.
 func (m *Machine) RemoveWireguardConfig(ring int) error {

pkg/cluster/machine_scan.go

@@ -3,6 +3,7 @@ package cluster
 import (
 	"context"
 	"net/netip"
+	"os"
 	"strconv"
 	"strings"
 	"time"
@@ -68,7 +69,8 @@ func (m *Machine) setID() error {
 	return nil
 }
 
-func (m *Machine) scan(opts *ScanOptions) error {
+// scan is called once we know about all zones and machine names
+func (m *Machine) scan(_ *ScanOptions) error {
 	for i := 0; i < RingsCount; i++ {
 		if err := m.tryApplyWireguardConfig(i); err != nil {
 			m.error(err).
@@ -80,6 +82,45 @@ func (m *Machine) scan(opts *ScanOptions) error {
 		}
 	}
 
+	return m.loadInactive()
+}
+
+func (m *Machine) loadInactive() error {
+	data, err := m.ReadLines("region")
+	switch {
+	case os.IsNotExist(err):
+		// no file
+		return nil
+	case err != nil:
+		// read error
+		return err
+	default:
+		// look for "none"
+		for _, r := range data {
+			switch r {
+			case "none":
+				m.Inactive = true
+			default:
+				m.Inactive = false
+			}
+		}
+		return nil
+	}
+}
+
+// scanWrapUp is called once all machines have been scanned
+func (m *Machine) scanWrapUp(opts *ScanOptions) error {
+	for _, ri := range m.Rings {
+		if err := m.setRingDefaults(ri); err != nil {
+			m.error(err).
+				WithField("subsystem", "wireguard").
+				WithField("node", m.Name).
+				WithField("ring", ri.Ring).
+				Print()
+			return err
+		}
+	}
+
 	if !opts.DontResolvePublicAddresses {
 		return m.UpdatePublicAddresses()
 	}

pkg/cluster/regions.go

@@ -32,7 +32,9 @@ func (r *Region) ForEachMachine(fn func(*Machine) bool) {
 		var term bool
 
 		z.ForEachMachine(func(p *Machine) bool {
-			term = fn(p)
+			if p.IsActive() {
+				term = fn(p)
+			}
 			return term
 		})
 
@@ -56,6 +58,7 @@ func (m *Cluster) initRegions(_ *ScanOptions) error {
 
 	// first regions defined by zones
 	m.ForEachZone(func(z *Zone) bool {
+		SortRegions(z.Regions)
 		for _, region := range z.Regions {
 			regions[region] = append(regions[region], z)
 		}
@@ -74,6 +77,7 @@ func (m *Cluster) initRegions(_ *ScanOptions) error {
 		m.finishRegion(r)
 	}
 
+	m.sortRegions()
 	return nil
 }
 

pkg/cluster/regions_utils.go

@@ -0,0 +1,41 @@
+package cluster
+
+import "sort"
+
+// SortRegions sorts regions. first by length those 3-character
+// or shorter, and then by length. It's mostly aimed at
+// supporting ISO-3166 order
+func SortRegions(regions []string) []string {
+	sort.Slice(regions, func(i, j int) bool {
+		r1, r2 := regions[i], regions[j]
+		return regionLess(r1, r2)
+	})
+
+	return regions
+}
+
+func regionLess(r1, r2 string) bool {
+	switch {
+	case len(r1) < 4:
+		switch {
+		case len(r1) < len(r2):
+			return true
+		case len(r1) > len(r2):
+			return false
+		default:
+			return r1 < r2
+		}
+	case len(r2) < 4:
+		return false
+	default:
+		return r1 < r2
+	}
+}
+
+func (m *Cluster) sortRegions() {
+	sort.Slice(m.Regions, func(i, j int) bool {
+		r1 := m.Regions[i].Name
+		r2 := m.Regions[j].Name
+		return regionLess(r1, r2)
+	})
+}

pkg/cluster/rings.go

@@ -41,7 +41,7 @@ func (ri *RingInfo) Merge(alter *RingInfo) error {
 		// can't disable via Merge
 		return fmt.Errorf("invalid %s: %v → %v", "enabled", ri.Enabled, alter.Enabled)
 	case !canMergeKeyPairs(ri.Keys, alter.Keys):
-		// incompatible keypairs
+		// incompatible key pairs
 		return fmt.Errorf("invalid %s: %s ≠ %s", "keys", ri.Keys, alter.Keys)
 	}
 

pkg/cluster/sync.go

@@ -3,6 +3,7 @@ package cluster
 // SyncAll updates all config files
 func (m *Cluster) SyncAll() error {
 	for _, fn := range []func() error{
+		m.SyncMkdirAll,
 		m.SyncAllWireguard,
 		m.SyncAllCeph,
 		m.WriteHosts,
@@ -15,6 +16,20 @@ func (m *Cluster) SyncAll() error {
 	return nil
 }
 
+// SyncMkdirAll creates the directories needed to store files
+// required to represent the cluster.
+func (m *Cluster) SyncMkdirAll() error {
+	err := m.MkdirAll(".")
+	if err == nil {
+		m.ForEachMachine(func(p *Machine) bool {
+			err = p.MkdirAll(".")
+			return err != nil
+		})
+	}
+
+	return err
+}
+
 // SyncAllWireguard updates all wireguard config files
 func (m *Cluster) SyncAllWireguard() error {
 	var err error

pkg/dns/record.go

@@ -11,6 +11,8 @@ import (
 
 	"darvaza.org/core"
 	"github.com/libdns/libdns"
+
+	"git.jpi.io/amery/jpictl/pkg/cluster"
 )
 
 func (mgr *Manager) fqdn(name string) string {
@@ -86,32 +88,6 @@ func lessRecord(a, b libdns.Record) bool {
 	}
 }
 
-// SortRegions sorts regions. first by length those 3-character
-// or shorter, and then by length. It's mostly aimed at
-// supporting ISO-3166 order
-func SortRegions(regions []string) []string {
-	sort.Slice(regions, func(i, j int) bool {
-		r1, r2 := regions[i], regions[j]
-
-		switch {
-		case len(r1) < 4:
-			switch {
-			case len(r1) < len(r2):
-				return true
-			case len(r1) > len(r2):
-				return false
-			default:
-				return r1 < r2
-			}
-		case len(r2) < 4:
-			return false
-		default:
-			return r1 < r2
-		}
-	})
-	return regions
-}
-
 // AddrRecord represents an A or AAAA record
 type AddrRecord struct {
 	Name string
@@ -172,7 +148,17 @@ func (mgr *Manager) genRegionsSorted() []string {
 		regions = append(regions, name)
 	}
 
-	return SortRegions(regions)
+	return cluster.SortRegions(regions)
+}
+
+func (mgr *Manager) genZonesSorted() []string {
+	zones := make([]string, 0, len(mgr.zones))
+	for name := range mgr.zones {
+		zones = append(zones, name)
+	}
+
+	sort.Strings(zones)
+	return zones
 }
 
 func (mgr *Manager) genAllAddrRecords() []AddrRecord {

pkg/dns/write.go

@@ -14,12 +14,13 @@ func (mgr *Manager) WriteTo(w io.Writer) (int64, error) {
 	cache := make(map[string][]netip.Addr)
 
 	// zones
-	for _, z := range mgr.zones {
+	for _, zoneName := range mgr.genZonesSorted() {
+		z := mgr.zones[zoneName]
+
 		mgr.writeZoneHosts(&buf, z)
 
 		// zone alias
 		addrs := mgr.genZoneAddresses(z)
-		zoneName := z.Name
 
 		rr := AddrRecord{
 			Name: mgr.fqdn(zoneName + mgr.suffix),

pkg/wireguard/config.go

@@ -107,6 +107,11 @@ func (ep EndpointAddress) String() string {
 	}
 }
 
+// UnmarshalText loads an endpoint address from text data
+func (ep *EndpointAddress) UnmarshalText(b []byte) error {
+	return ep.FromString(string(b))
+}
+
 // FromString sets the EndpointAddress from a given "[host]:port"
 func (ep *EndpointAddress) FromString(s string) error {
 	host, port, err := core.SplitHostPort(s)
@@ -175,10 +180,12 @@ func (p interfaceConfig) Export() (InterfaceConfig, error) {
 		ListenPort: p.ListenPort,
 	}
 
-	out.PrivateKey, err = PrivateKeyFromBase64(p.PrivateKey)
+	if p.PrivateKey != "" {
-	if err != nil {
+		out.PrivateKey, err = PrivateKeyFromBase64(p.PrivateKey)
-		err = core.Wrap(err, "PrivateKey")
+		if err != nil {
-		return InterfaceConfig{}, err
+			err = core.Wrap(err, "PrivateKey")
+			return InterfaceConfig{}, err
+		}
 	}
 
 	return out, nil

pkg/wireguard/keys.go

@@ -51,6 +51,28 @@ func (pub PublicKey) String() string {
 	}
 }
 
+// UnmarshalText loads the value from base64
+func (key *PrivateKey) UnmarshalText(b []byte) error {
+	v, err := PrivateKeyFromBase64(string(b))
+	if err != nil {
+		return err
+	}
+
+	*key = v
+	return nil
+}
+
+// UnmarshalText loads the value from base64
+func (pub *PublicKey) UnmarshalText(b []byte) error {
+	v, err := PublicKeyFromBase64(string(b))
+	if err != nil {
+		return err
+	}
+
+	*pub = v
+	return nil
+}
+
 // MarshalJSON encodes the key for JSON, omitting empty.
 func (key PrivateKey) MarshalJSON() ([]byte, error) {
 	return encodeKeyJSON(key.String())