jpictl: introduce --config-file/-f as alternative to scanning m/

Signed-off-by: Alejandro Mery <amery@jpi.io>

.vscode/settings.json

@@ -1,11 +1,10 @@
 {
     "cSpell.words": [
-        "asciigoat",
         "ceph",
-        "cyclomatic",
         "darvaza",
         "gofrs",
         "jpictl",
+        "Lookuper",
         "Wrapf",
         "zerolog"
     ]

cmd/jpictl/config.go

@@ -19,19 +19,24 @@ type Config struct {
 	Base   string
 	Domain string
 
-	ConfigFile string
+	ConfigFile *string
 }
 
 var cfg = &Config{
 	Base:   "m",
 	Domain: "jpi.cloud",
+
+	ConfigFile: rootCmd.PersistentFlags().
+		StringP("config-file", "f", DefaultConfigFile, "config file (JSON or YAML)"),
 }
 
 // LoadZones loads all zones and machines in the config directory
 // or file
 func (cfg *Config) LoadZones(resolve bool) (*cluster.Cluster, error) {
+	configFile := *cfg.ConfigFile
+
 	// try config file first
-	zones, err := cluster.NewFromConfig(cfg.ConfigFile,
+	zones, err := cluster.NewFromConfig(configFile,
 		cluster.ResolvePublicAddresses(resolve),
 		cluster.WithLogger(log),
 	)
@@ -40,9 +45,9 @@ func (cfg *Config) LoadZones(resolve bool) (*cluster.Cluster, error) {
 	case err == nil:
 		// file was good
 		return zones, nil
-	case !os.IsNotExist(err) || cfg.ConfigFile != DefaultConfigFile:
+	case !os.IsNotExist(err) || configFile != DefaultConfigFile:
 		// file was bad
-		return nil, core.Wrapf(err, "NewFromConfig(%q)", cfg.ConfigFile)
+		return nil, core.Wrapf(err, "NewFromConfig(%q)", configFile)
 	}
 
 	// default file doesn't exist. scan instead.
@@ -51,9 +56,3 @@ func (cfg *Config) LoadZones(resolve bool) (*cluster.Cluster, error) {
 		cluster.WithLogger(log),
 	)
 }
-
-func init() {
-	rootCmd.PersistentFlags().
-		StringVarP(&cfg.ConfigFile, "config-file", "f",
-			DefaultConfigFile, "config file (JSON or YAML)")
-}

cmd/jpictl/dns.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// Command
+var dnsCmd = &cobra.Command{
+	Use: "dns",
+}
+
+var dnsSyncCmd = &cobra.Command{
+	Use: "sync",
+	RunE: func(_ *cobra.Command, _ []string) error {
+		_, err := cfg.LoadZones(true)
+		return err
+	},
+}
+
+var dnsWriteCmd = &cobra.Command{
+	Use: "write",
+	RunE: func(_ *cobra.Command, _ []string) error {
+		return nil
+	},
+}
+
+var dnsAddCmd = &cobra.Command{
+	Use: "add",
+	RunE: func(_ *cobra.Command, _ []string) error {
+		return nil
+	},
+}
+
+var dnsRemoveCmd = &cobra.Command{
+	Use: "remove",
+	RunE: func(_ *cobra.Command, _ []string) error {
+		return nil
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(dnsCmd)
+
+	dnsCmd.AddCommand(dnsSyncCmd)
+	dnsCmd.AddCommand(dnsWriteCmd)
+	dnsCmd.AddCommand(dnsAddCmd)
+	dnsCmd.AddCommand(dnsRemoveCmd)
+}

cmd/jpictl/dump.go

@@ -45,9 +45,8 @@ const encoding = YAMLEncoding
 
 // Command
 var dumpCmd = &cobra.Command{
-	Use:    "dump",
-	Short:  "generates a text representation of the config",
-	PreRun: setVerbosity,
+	Use:   "dump",
+	Short: "generates a text representation of the config",
 	RunE: func(_ *cobra.Command, _ []string) error {
 		var buf bytes.Buffer
 		var enc Encoder

cmd/jpictl/env.go

@@ -8,9 +8,8 @@ import (
 
 // Command
 var envCmd = &cobra.Command{
-	Use:    "env",
-	Short:  "generates environment variables for shell scripts",
-	PreRun: setVerbosity,
+	Use:   "env",
+	Short: "generates environment variables for shell scripts",
 	RunE: func(_ *cobra.Command, _ []string) error {
 		m, err := cfg.LoadZones(false)
 		if err != nil {

cmd/jpictl/gateway.go

@@ -20,9 +20,8 @@ var gatewayCmd = &cobra.Command{
 
 // gateway set
 var gatewaySetCmd = &cobra.Command{
-	Use:    "set",
-	Short:  "gateway set sets machines as gateways",
-	PreRun: setVerbosity,
+	Use:   "set",
+	Short: "gateway set sets machines as gateways",
 	RunE: func(_ *cobra.Command, args []string) error {
 		m, err := cfg.LoadZones(false)
 		if err != nil {

cmd/jpictl/log.go

@@ -3,9 +3,15 @@ package main
 import (
 	"fmt"
 
+	"darvaza.org/sidecar/pkg/logger/zerolog"
 	"darvaza.org/slog"
 )
 
+// TODO: make log level configurable via flags
+var (
+	log = zerolog.New(nil, slog.Debug)
+)
+
 // fatal is a convenience wrapper for slog.Logger.Fatal().Print()
 func fatal(err error, msg string, args ...any) {
 	l := log.Fatal()

cmd/jpictl/main.go

@@ -2,8 +2,6 @@
 package main
 
 import (
-	"darvaza.org/sidecar/pkg/logger/zerolog"
-	"darvaza.org/slog"
 	"github.com/spf13/cobra"
 )
 
@@ -12,30 +10,13 @@ const (
 	CmdName = "jpictl"
 )
 
-var (
-	log       = zerolog.New(nil, slog.Error)
-	verbosity int
-	rootCmd   = &cobra.Command{
-		Use:   CmdName,
-		Short: "control tool for jpi.cloud",
-	}
-)
+var rootCmd = &cobra.Command{
+	Use:   CmdName,
+	Short: "control tool for jpi.cloud",
+}
 
 func main() {
 	if err := rootCmd.Execute(); err != nil {
 		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 = log.WithLevel(slog.LogLevel(desired))
-}

cmd/jpictl/write.go

@@ -6,9 +6,8 @@ import (
 
 // Command
 var writeCmd = &cobra.Command{
-	Use:    "write",
-	Short:  "rewrites all config files",
-	PreRun: setVerbosity,
+	Use:   "write",
+	Short: "rewrites all config files",
 	RunE: func(_ *cobra.Command, _ []string) error {
 		m, err := cfg.LoadZones(false)
 		if err != nil {

go.mod

@@ -2,8 +2,6 @@ module git.jpi.io/amery/jpictl
 
 go 1.19
 
-replace asciigoat.org/ini => ../../../asciigoat.org/ini
-
 require (
 	asciigoat.org/ini v0.2.5
 	darvaza.org/core v0.9.8
@@ -13,6 +11,8 @@ require (
 	darvaza.org/slog/handlers/discard v0.4.5
 	github.com/gofrs/uuid/v5 v5.0.0
 	github.com/hack-pad/hackpadfs v0.2.1
+	github.com/libdns/cloudflare v0.1.0
+	github.com/libdns/libdns v0.2.1
 	github.com/mgechev/revive v1.3.3
 	github.com/spf13/cobra v1.7.0
 	golang.org/x/crypto v0.12.0

go.sum

@@ -1,5 +1,7 @@
 asciigoat.org/core v0.3.9 h1:hgDDz4ecm3ZvehX++m8A/IzAt+B5oDPiRtxatzfUHPQ=
 asciigoat.org/core v0.3.9/go.mod h1:CAaHwyw8MpAq4a1MYtN2dxJrsK+hmIdW50OndaQZYPI=
+asciigoat.org/ini v0.2.5 h1:4gRIp9rU+XQt8+HMqZO5R7GavMv9Yl2+N+je6djDIAE=
+asciigoat.org/ini v0.2.5/go.mod h1:gmXzJ9XFqf1NLk5nQkj04USQ4tMtdRJHNQX6vp3DzjU=
 darvaza.org/core v0.9.8 h1:luLxgfUc2pzuusYPo/Z/dC/qr9XZPKpSQw8/kS7zNUM=
 darvaza.org/core v0.9.8/go.mod h1:Dbme64naxeshQfxcVJX9ZT7AiGyIY8kldfuELVtf8mw=
 darvaza.org/resolver v0.5.4 h1:dlSBNV14yYsp7Kg7ipwYOMNsLbrpeXa8Z0HBTa0Ryxs=
@@ -34,6 +36,11 @@ github.com/hack-pad/hackpadfs v0.2.1 h1:FelFhIhv26gyjujoA/yeFO+6YGlqzmc9la/6iKMI
 github.com/hack-pad/hackpadfs v0.2.1/go.mod h1:khQBuCEwGXWakkmq8ZiFUvUZz84ZkJ2KNwKvChs4OrU=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/libdns/cloudflare v0.1.0 h1:93WkJaGaiXCe353LHEP36kAWCUw0YjFqwhkBkU2/iic=
+github.com/libdns/cloudflare v0.1.0/go.mod h1:a44IP6J1YH6nvcNl1PverfJviADgXUnsozR3a7vBKN8=
+github.com/libdns/libdns v0.2.0/go.mod h1:yQCXzk1lEZmmCPa857bnk4TsOiqYasqpyOEeSObbb40=
+github.com/libdns/libdns v0.2.1 h1:Wu59T7wSHRgtA0cfxC+n1c/e+O3upJGWytknkmFEDis=
+github.com/libdns/libdns v0.2.1/go.mod h1:yQCXzk1lEZmmCPa857bnk4TsOiqYasqpyOEeSObbb40=
 github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=

pkg/cluster/cluster_import.go

@@ -2,7 +2,6 @@ package cluster
 
 import (
 	"encoding/json"
-	"fmt"
 	"os"
 
 	"gopkg.in/yaml.v3"
@@ -23,58 +22,25 @@ func (m *Cluster) init(opts *ScanOptions) error {
 	return nil
 }
 
-func (m *Cluster) initZones(opts *ScanOptions) error {
+func (m *Cluster) initZones(_ *ScanOptions) error {
 	var err error
 
 	m.ForEachZone(func(z *Zone) bool {
-		err = m.initZone(z, opts)
+		z.zones = m
+		z.logger = m
+
+		z.ForEachMachine(func(p *Machine) bool {
+			p.zone = z
+			p.logger = z
+			return err != nil
+		})
+
 		return err != nil
 	})
 
 	return err
 }
 
-func (m *Cluster) initZone(z *Zone, _ *ScanOptions) error {
-	var hasMissing bool
-	var lastMachineID int
-
-	z.zones = m
-	z.logger = m
-
-	z.ForEachMachine(func(p *Machine) bool {
-		p.zone = z
-		p.logger = z
-
-		switch {
-		case p.ID == 0:
-			hasMissing = true
-		case p.ID > lastMachineID:
-			lastMachineID = z.ID
-		}
-
-		return false
-	})
-
-	if hasMissing {
-		next := lastMachineID + 1
-
-		z.ForEachMachine(func(p *Machine) bool {
-			if p.ID == 0 {
-				p.ID, next = next, next+1
-			}
-
-			return false
-		})
-	}
-
-	z.ForEachMachine(func(p *Machine) bool {
-		p.Name = fmt.Sprintf("%s-%v", z.Name, p.ID)
-		return false
-	})
-
-	return nil
-}
-
 func decodeConfigData(data []byte) (out *Cluster, err error) {
 	// try JSON first
 	out = new(Cluster)

pkg/cluster/defaults.go

@@ -15,3 +15,8 @@ func DefaultLogger() slog.Logger {
 func DefaultLookuper() resolver.Lookuper {
 	return resolver.NewCloudflareLookuper()
 }
+
+// DefaultResolver returns a [resolver.Resolver] using Cloudflare's 1.1.1.1
+func DefaultResolver() resolver.Resolver {
+	return resolver.NewResolver(DefaultLookuper())
+}

pkg/dns/dns.go

@@ -0,0 +1,12 @@
+// Package dns manages DNS entries for the cluster
+package dns
+
+// A Region describes where a Zone is
+type Region struct {
+	// Name is the identifier of this Region
+	Name string
+	// Regions are a list of (sub)regions that belong to this Region
+	Regions []string
+	// Zones are a list of Zones that directly belong to this Region
+	Zones []string
+}

pkg/dns/manager.go

@@ -0,0 +1,121 @@
+package dns
+
+import (
+	"darvaza.org/core"
+	"darvaza.org/resolver"
+	"darvaza.org/slog"
+
+	"git.jpi.io/amery/jpictl/pkg/cluster"
+)
+
+// Manager is a DNS Manager instance
+type Manager struct {
+	p Provider
+	r resolver.Resolver
+	l slog.Logger
+}
+
+// ManagerOption configures a Manager
+type ManagerOption func(*Manager) error
+
+func newErrorManagerOption(err error, hint string) ManagerOption {
+	return func(*Manager) error {
+		if hint != "" {
+			err = core.Wrap(err, hint)
+		}
+		return err
+	}
+}
+
+// WithProvider attaches a libdns Provider to the Manager
+func WithProvider(p Provider) ManagerOption {
+	var err error
+
+	if p == nil {
+		p, err = DefaultDNSProvider()
+	}
+
+	if err != nil {
+		return newErrorManagerOption(err, "WithProvider")
+	}
+
+	return func(mgr *Manager) error {
+		mgr.p = p
+		return nil
+	}
+}
+
+// WithLookuper attaches a resolver.Lookuper to the Manager
+func WithLookuper(h resolver.Lookuper) ManagerOption {
+	if h == nil {
+		h = cluster.DefaultLookuper()
+	}
+
+	return func(mgr *Manager) error {
+		mgr.r = resolver.NewResolver(h)
+		return nil
+	}
+}
+
+// WithResolver attaches a resolver.Resolver to the Manager
+func WithResolver(r resolver.Resolver) ManagerOption {
+	if r == nil {
+		r = cluster.DefaultResolver()
+	}
+
+	return func(mgr *Manager) error {
+		mgr.r = r
+		return nil
+	}
+}
+
+// WithLogger attaches a logger to the Manager
+func WithLogger(log slog.Logger) ManagerOption {
+	if log == nil {
+		log = cluster.DefaultLogger()
+	}
+
+	return func(mgr *Manager) error {
+		mgr.l = log
+		return nil
+	}
+}
+
+func (mgr *Manager) setDefaults() error {
+	var opts []ManagerOption
+
+	if mgr.p == nil {
+		opts = append(opts, WithProvider(nil))
+	}
+
+	if mgr.r == nil {
+		opts = append(opts, WithResolver(nil))
+	}
+
+	if mgr.l == nil {
+		opts = append(opts, WithLogger(nil))
+	}
+
+	for _, opt := range opts {
+		if err := opt(mgr); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+// NewManager creates a DNS manager with the
+func NewManager(opts ...ManagerOption) (*Manager, error) {
+	mgr := new(Manager)
+
+	for _, opt := range opts {
+		if err := opt(mgr); err != nil {
+			return nil, err
+		}
+	}
+
+	if err := mgr.setDefaults(); err != nil {
+		return nil, err
+	}
+	return mgr, nil
+}

pkg/dns/provider.go

@@ -0,0 +1,36 @@
+package dns
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/libdns/cloudflare"
+	"github.com/libdns/libdns"
+)
+
+const (
+	// CloudflareAPIToken is the environment variable
+	// containing the API Token
+	CloudflareAPIToken = "CLOUDFLARE_DNS_API_TOKEN"
+)
+
+// Provider manages DNS entries
+type Provider interface {
+	libdns.RecordGetter
+	libdns.RecordDeleter
+}
+
+// DefaultDNSProvider returns a cloudflare DNS provider
+// using an API Token from env [CloudflareAPIToken]
+func DefaultDNSProvider() (*cloudflare.Provider, error) {
+	s := os.Getenv(CloudflareAPIToken)
+	if s == "" {
+		return nil, fmt.Errorf("%q: %s", CloudflareAPIToken, "not found")
+	}
+
+	p := &cloudflare.Provider{
+		APIToken: s,
+	}
+
+	return p, nil
+}