Moved internal/ to pkg/ to make building external plugins possible

pkg/generator/plugins/conman/conman.go

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"fmt"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type Conman struct{}
+
+func (g *Conman) GetName() string {
+	return "conman"
+}
+
+func (g *Conman) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *Conman) GetDescription() string {
+	return fmt.Sprintf("Configurator generator plugin for '%s'.", g.GetName())
+}
+
+func (g *Conman) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	var (
+		params                                   = generator.GetParams(opts...)
+		client                                   = generator.GetClient(params)
+		targetKey                                = params["targets"].(string) // required param
+		target                                   = config.Targets[targetKey]
+		eps       []configurator.RedfishEndpoint = nil
+		err       error                          = nil
+		// serverOpts = ""
+		// globalOpts = ""
+		consoles = ""
+	)
+
+	// fetch required data from SMD to create config
+	if client != nil {
+		eps, err = client.FetchRedfishEndpoints(opts...)
+		if err != nil {
+			return nil, fmt.Errorf("failed to fetch redfish endpoints with client: %v", err)
+		}
+	}
+
+	// add any additional conman or server opts
+	// if extraOpts, ok := params["opts"].(map[string]any); ok {
+
+	// }
+
+	// format output to write to config file
+	consoles = "# ========== DYNAMICALLY GENERATED BY OPENCHAMI CONFIGURATOR ==========\n"
+	for _, ep := range eps {
+		consoles += fmt.Sprintf("CONSOLE name=%s dev=ipmi:%s-bmc ipmiopts=U:%s,P:%s,W:solpayloadsize\n", ep.Name, ep.Name, ep.User, ep.Password)
+	}
+	consoles += "# ====================================================================="
+
+	// apply template substitutions and return output as byte array
+	return generator.ApplyTemplateFromFiles(generator.Mappings{
+		"plugin_name":        g.GetName(),
+		"plugin_version":     g.GetVersion(),
+		"plugin_description": g.GetDescription(),
+		"server_opts":        "",
+		"global_opts":        "",
+	}, target.Templates...)
+}
+
+var Generator Conman

pkg/generator/plugins/coredhcp/coredhcp.go

@@ -0,0 +1,29 @@
+package main
+
+import (
+	"fmt"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type CoreDhcp struct{}
+
+func (g *CoreDhcp) GetName() string {
+	return "coredhcp"
+}
+
+func (g *CoreDhcp) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *CoreDhcp) GetDescription() string {
+	return fmt.Sprintf("Configurator generator plugin for '%s' to generate config files. This plugin is not complete and still a WIP.", g.GetName())
+}
+
+func (g *CoreDhcp) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	return nil, fmt.Errorf("plugin does not implement generation function")
+}
+
+var Generator CoreDhcp

pkg/generator/plugins/dhcpd/dhcpd.go

@@ -0,0 +1,76 @@
+package main
+
+import (
+	"fmt"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type Dhcpd struct{}
+
+func (g *Dhcpd) GetName() string {
+	return "dhcpd"
+}
+
+func (g *Dhcpd) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *Dhcpd) GetDescription() string {
+	return fmt.Sprintf("Configurator generator plugin for '%s'.", g.GetName())
+}
+
+func (g *Dhcpd) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	var (
+		params                                         = generator.GetParams(opts...)
+		client                                         = generator.GetClient(params)
+		targetKey                                      = params["target"].(string)
+		target                                         = config.Targets[targetKey]
+		compute_nodes                                  = ""
+		eths          []configurator.EthernetInterface = nil
+		err           error                            = nil
+	)
+
+	//
+	if client != nil {
+		eths, err = client.FetchEthernetInterfaces(opts...)
+		if err != nil {
+			return nil, fmt.Errorf("failed to fetch ethernet interfaces with client: %v", err)
+		}
+	}
+
+	// check if we have the required params first
+	if eths == nil {
+		return nil, fmt.Errorf("invalid ethernet interfaces (variable is nil)")
+	}
+	if len(eths) <= 0 {
+		return nil, fmt.Errorf("no ethernet interfaces found")
+	}
+
+	// format output to write to config file
+	compute_nodes = "# ========== DYNAMICALLY GENERATED BY OPENCHAMI CONFIGURATOR ==========\n"
+	for _, eth := range eths {
+		if len(eth.IpAddresses) == 0 {
+			continue
+		}
+		compute_nodes += fmt.Sprintf("host %s { hardware ethernet %s; fixed-address %s} ", eth.ComponentId, eth.MacAddress, eth.IpAddresses[0])
+	}
+	compute_nodes += "# ====================================================================="
+
+	if verbose, ok := params["verbose"].(bool); ok {
+		if verbose {
+			fmt.Printf("")
+		}
+	}
+	return generator.ApplyTemplateFromFiles(generator.Mappings{
+		"plugin_name":        g.GetName(),
+		"plugin_version":     g.GetVersion(),
+		"plugin_description": g.GetDescription(),
+		"compute_nodes":      compute_nodes,
+		"node_entries":       "",
+	}, target.Templates...)
+}
+
+var Generator Dhcpd

pkg/generator/plugins/dnsmasq/dnsmasq.go

@@ -0,0 +1,85 @@
+package main
+
+import (
+	"fmt"
+	"strings"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type DnsMasq struct{}
+
+func (g *DnsMasq) GetName() string {
+	return "dnsmasq"
+}
+
+func (g *DnsMasq) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *DnsMasq) GetDescription() string {
+	return fmt.Sprintf("Configurator generator plugin for '%s'.", g.GetName())
+}
+
+func (g *DnsMasq) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	// make sure we have a valid config first
+	if config == nil {
+		return nil, fmt.Errorf("invalid config (config is nil)")
+	}
+
+	// set all the defaults for variables
+	var (
+		params                                     = generator.GetParams(opts...)
+		client                                     = generator.GetClient(params)
+		targetKey                                  = params["target"].(string) // required param
+		target                                     = config.Targets[targetKey]
+		eths      []configurator.EthernetInterface = nil
+		err       error                            = nil
+	)
+
+	// if we have a client, try making the request for the ethernet interfaces
+	if client != nil {
+		eths, err = client.FetchEthernetInterfaces(opts...)
+		if err != nil {
+			return nil, fmt.Errorf("failed to fetch ethernet interfaces with client: %v", err)
+		}
+	}
+
+	// check if we have the required params first
+	if eths == nil {
+		return nil, fmt.Errorf("invalid ethernet interfaces (variable is nil)")
+	}
+	if len(eths) <= 0 {
+		return nil, fmt.Errorf("no ethernet interfaces found")
+	}
+
+	// print message if verbose param found
+	if verbose, ok := params["verbose"].(bool); ok {
+		if verbose {
+			fmt.Printf("template: \n%s\nethernet interfaces found: %v\n", strings.Join(target.Templates, "\n\t"), len(eths))
+		}
+	}
+
+	// format output to write to config file
+	output := "# ========== DYNAMICALLY GENERATED BY OPENCHAMI CONFIGURATOR ==========\n"
+	for _, eth := range eths {
+		if eth.Type == "NodeBMC" {
+			output += "dhcp-host=" + eth.MacAddress + "," + eth.ComponentId + "," + eth.IpAddresses[0].IpAddress + "\n"
+		} else {
+			output += "dhcp-host=" + eth.MacAddress + "," + eth.ComponentId + "," + eth.IpAddresses[0].IpAddress + "\n"
+		}
+	}
+	output += "# ====================================================================="
+
+	// apply template substitutions and return output as byte array
+	return generator.ApplyTemplateFromFiles(generator.Mappings{
+		"plugin_name":        g.GetName(),
+		"plugin_version":     g.GetVersion(),
+		"plugin_description": g.GetDescription(),
+		"dhcp-hosts":         output,
+	}, target.Templates...)
+}
+
+var Generator DnsMasq

pkg/generator/plugins/example/example.go

@@ -0,0 +1,34 @@
+package main
+
+import (
+	"fmt"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type Example struct {
+	Message string
+}
+
+func (g *Example) GetName() string {
+	return "example"
+}
+
+func (g *Example) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *Example) GetDescription() string {
+	return fmt.Sprintf("Configurator generator plugin for '%s'.", g.GetName())
+}
+
+func (g *Example) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	g.Message = `
+	This is an example generator plugin. See the file in 'internal/generator/plugins/example/example.go' on
+	information about constructing plugins and plugin requirements.`
+	return generator.FileMap{"example": []byte(g.Message)}, nil
+}
+
+var Generator Example

pkg/generator/plugins/hostfile/hostfile.go

@@ -0,0 +1,29 @@
+package main
+
+import (
+	"fmt"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type Hostfile struct{}
+
+func (g *Hostfile) GetName() string {
+	return "hostfile"
+}
+
+func (g *Hostfile) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *Hostfile) GetDescription() string {
+	return fmt.Sprintf("Configurator generator plugin for '%s'.", g.GetName())
+}
+
+func (g *Hostfile) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	return nil, fmt.Errorf("plugin does not implement generation function")
+}
+
+var Generator Hostfile

pkg/generator/plugins/powerman/powerman.go

@@ -0,0 +1,29 @@
+package main
+
+import (
+	"fmt"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type Powerman struct{}
+
+func (g *Powerman) GetName() string {
+	return "powerman"
+}
+
+func (g *Powerman) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *Powerman) GetDescription() string {
+	return fmt.Sprintf("Configurator generator plugin for '%s'.", g.GetName())
+}
+
+func (g *Powerman) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	return nil, fmt.Errorf("plugin does not implement generation function")
+}
+
+var Generator Powerman

pkg/generator/plugins/syslog/syslog.go

@@ -0,0 +1,29 @@
+package main
+
+import (
+	"fmt"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type Syslog struct{}
+
+func (g *Syslog) GetName() string {
+	return "syslog"
+}
+
+func (g *Syslog) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *Syslog) GetDescription() string {
+	return fmt.Sprintf("Configurator generator plugin for '%s'.", g.GetName())
+}
+
+func (g *Syslog) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	return nil, fmt.Errorf("plugin does not implement generation function")
+}
+
+var Generator Syslog

pkg/generator/plugins/warewulf/warewulf.go

@@ -0,0 +1,102 @@
+package main
+
+import (
+	"fmt"
+	"maps"
+	"strings"
+
+	configurator "github.com/OpenCHAMI/configurator/internal"
+	"github.com/OpenCHAMI/configurator/internal/generator"
+	"github.com/OpenCHAMI/configurator/internal/util"
+)
+
+type Warewulf struct{}
+
+func (g *Warewulf) GetName() string {
+	return "warewulf"
+}
+
+func (g *Warewulf) GetVersion() string {
+	return util.GitCommit()
+}
+
+func (g *Warewulf) GetDescription() string {
+	return "Configurator generator plugin for 'warewulf' config files."
+}
+
+func (g *Warewulf) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
+	var (
+		params    = generator.GetParams(opts...)
+		client    = generator.GetClient(params)
+		targetKey = params["target"].(string)
+		target    = config.Targets[targetKey]
+		outputs   = make(generator.FileMap, len(target.FilePaths)+len(target.Templates))
+	)
+
+	// check if our client is included and is valid
+	if client == nil {
+		return nil, fmt.Errorf("invalid client (client is nil)")
+	}
+
+	// if we have a client, try making the request for the ethernet interfaces
+	eths, err := client.FetchEthernetInterfaces(opts...)
+	if err != nil {
+		return nil, fmt.Errorf("failed to fetch ethernet interfaces with client: %v", err)
+	}
+
+	// check if we have the required params first
+	if eths == nil {
+		return nil, fmt.Errorf("invalid ethernet interfaces (variable is nil)")
+	}
+	if len(eths) <= 0 {
+		return nil, fmt.Errorf("no ethernet interfaces found")
+	}
+
+	// print message if verbose param found
+	if verbose, ok := params["verbose"].(bool); ok {
+		if verbose {
+			fmt.Printf("template: \n%s\n ethernet interfaces found: %v\n", strings.Join(target.Templates, "\n\t"), len(eths))
+		}
+	}
+
+	// fetch redfish endpoints and handle errors
+	eps, err := client.FetchRedfishEndpoints(opts...)
+	if err != nil {
+		return nil, fmt.Errorf("failed to fetch redfish endpoints: %v", err)
+	}
+	if len(eps) <= 0 {
+		return nil, fmt.Errorf("no redfish endpoints found")
+	}
+
+	// format output for template substitution
+	nodeEntries := ""
+
+	// load files and templates and copy to outputs
+	files, err := generator.LoadFiles(target.FilePaths...)
+	if err != nil {
+		return nil, fmt.Errorf("failed to load files: %v", err)
+	}
+	templates, err := generator.ApplyTemplateFromFiles(generator.Mappings{
+		"node_entries": nodeEntries,
+	}, target.Templates...)
+	if err != nil {
+		return nil, fmt.Errorf("failed to load templates: %v", err)
+	}
+
+	maps.Copy(outputs, files)
+	maps.Copy(outputs, templates)
+
+	// print message if verbose param is found
+	if verbose, ok := params["verbose"].(bool); ok {
+		if verbose {
+			fmt.Printf("templates and files loaded: \n")
+			for path, _ := range outputs {
+				fmt.Printf("\t%s", path)
+			}
+		}
+	}
+
+	return outputs, err
+}
+
+var Generator Warewulf