Merge pull request 'cluster: improve defaults to ease initialisation of new machines' (#31)

Reviewed-on: #31

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_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,30 @@ 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)
 }
 
 // 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

@@ -68,7 +68,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 +81,22 @@ func (m *Machine) scan(opts *ScanOptions) error {
 		}
 	}
 
+	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

@@ -56,6 +56,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 +75,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

@@ -175,10 +175,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