kelvin/warewulf
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Audit and correct documentation, cobra help text, and log messages for accuracy

Browse Source 
Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2026-03-18 16:58:39 -06:00
parent 7d56252d65
commit 9e526c23fc
23 changed files with 50 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
internal/pkg/api/node/set.go
View File

@@ -88,7 +88,7 @@ func NodeSetParameterCheck(set *wwapiv1.ConfSetParameter) (nodeDB node.NodesYaml
if set.PartitionDelete != "" {
for diskname, disk := range nodePtr.Disks {
if _, ok := disk.Partitions[set.PartitionDelete]; ok {
wwlog.Verbose("Node: %s, on disk %, deleting partition: %s", nId, diskname, set.PartitionDelete)
wwlog.Verbose("Node: %s, on disk %s, deleting partition: %s", nId, diskname, set.PartitionDelete)
delete(disk.Partitions, set.PartitionDelete)
} else {
return nodeDB, count, fmt.Errorf("partition doesn't exist: %s", set.PartitionDelete)

6
internal/pkg/api/profile/set.go
View File

@@ -89,7 +89,7 @@ func ProfileSetParameterCheck(set *wwapiv1.ConfSetParameter) (nodeDB node.NodesY
if set.PartitionDelete != "" {
for diskname, disk := range profilePtr.Disks {
if _, ok := disk.Partitions[set.PartitionDelete]; ok {
wwlog.Verbose("Node: %s, on disk %, deleting partition: %s", profileId, diskname, set.PartitionDelete)
wwlog.Verbose("Profile: %s, on disk %s, deleting partition: %s", profileId, diskname, set.PartitionDelete)
delete(disk.Partitions, set.PartitionDelete)
} else {
return nodeDB, count, fmt.Errorf("partition doesn't exist: %s", set.PartitionDelete)
@@ -99,7 +99,7 @@ func ProfileSetParameterCheck(set *wwapiv1.ConfSetParameter) (nodeDB node.NodesY
}
if set.DiskDelete != "" {
if _, ok := profilePtr.Disks[set.DiskDelete]; ok {
wwlog.Verbose("Node: %s, deleting disk: %s", profileId, set.DiskDelete)
wwlog.Verbose("Profile: %s, deleting disk: %s", profileId, set.DiskDelete)
delete(profilePtr.Disks, set.DiskDelete)
} else {
return nodeDB, count, fmt.Errorf("disk doesn't exist: %s", set.DiskDelete)
@@ -107,7 +107,7 @@ func ProfileSetParameterCheck(set *wwapiv1.ConfSetParameter) (nodeDB node.NodesY
}
if set.FilesystemDelete != "" {
if _, ok := profilePtr.FileSystems[set.FilesystemDelete]; ok {
wwlog.Verbose("Node: %s, deleting filesystem: %s", profileId, set.FilesystemDelete)
wwlog.Verbose("Profile: %s, deleting filesystem: %s", profileId, set.FilesystemDelete)
delete(profilePtr.FileSystems, set.FilesystemDelete)
} else {
return nodeDB, count, fmt.Errorf("disk doesn't exist: %s", set.FilesystemDelete)

2
internal/pkg/image/build.go
View File

@@ -34,7 +34,7 @@ func Build(name string, buildForce bool) error {
var err error
ignore, err = util.ReadFile(excludes_file)
if err != nil {
return fmt.Errorf("failed creating directory: %s: %w", imagePath, err)
return fmt.Errorf("failed reading excludes file: %s: %w", excludes_file, err)
}
}

2
internal/pkg/node/flags.go
View File

@@ -58,7 +58,7 @@ func (f *boolPtrFlag) Type() string {
}
type NodeConfDel struct {
TagsDel []string `lopt:"tagdel" comment:"add tags"`
TagsDel []string `lopt:"tagdel" comment:"delete tags"`
IpmiTagsDel []string `lopt:"ipmitagdel" comment:"delete ipmi tags"`
NetTagsDel []string `lopt:"nettagdel" comment:"delete network tags"`
NetDel string `lopt:"netdel" comment:"network to delete"`

4
internal/pkg/warewulfd/api/overlay.go
View File

@@ -101,13 +101,13 @@ func (of *OverlayFile) readContents() (string, error) {
fullPath := of.FullPath()
f, err := os.ReadFile(fullPath)
if err != nil {
wwlog.Warn("os.ReadFile err %w", err)
wwlog.Warn("os.ReadFile err %v", err)
return "", err
}
// Populate the permissions, uid, and gid.
s, err := os.Stat(fullPath)
if err != nil {
wwlog.Warn("os.Stat err %w", err)
wwlog.Warn("os.Stat err %v", err)
return "", err
}
fileMode := s.Mode()

2
internal/pkg/warewulfd/daemon.go
View File

@@ -82,7 +82,7 @@ func DaemonStatus() error {
} else {
err := process.Signal(syscall.Signal(0))
if err != nil {
return fmt.Errorf("failed to send process SIGCONT: %w", err)
return fmt.Errorf("failed to send signal 0 (process existence check): %w", err)
} else {
wwlog.Serv("Warewulf server is running at PID: %d", pid)
}

9
internal/pkg/warewulfd/efi.go
View File

@@ -6,6 +6,7 @@ import (
"path"
"github.com/warewulf/warewulf/internal/pkg/image"
"github.com/warewulf/warewulf/internal/pkg/util"
"github.com/warewulf/warewulf/internal/pkg/wwlog"
)
@@ -38,20 +39,20 @@ func HandleEfiBoot(w http.ResponseWriter, req *http.Request) {
case "grub.efi", "grub-tpm.efi", "grubx64.efi", "grubia32.efi", "grubaa64.efi", "grubarm.efi":
stageFile = image.GrubFind(imageName)
if stageFile == "" {
wwlog.Error("could't find grub*.efi for %s", imageName)
wwlog.Error("couldn't find grub*.efi for %s", imageName)
w.WriteHeader(http.StatusNotFound)
return
}
case "grub.cfg":
stageFile = path.Join(ctx.conf.Paths.Sysconfdir, "warewulf/grub/grub.cfg.ww")
tmplData = buildTemplateVars(ctx.conf, ctx.rinfo, ctx.remoteNode)
if stageFile == "" {
wwlog.Error("could't find grub.cfg template for %s", imageName)
if !util.IsFile(stageFile) {
wwlog.Error("couldn't find grub.cfg template for %s", imageName)
w.WriteHeader(http.StatusNotFound)
return
}
default:
wwlog.ErrorExc(fmt.Errorf("could't find efiboot file: %s", ctx.rinfo.efifile), "")
wwlog.ErrorExc(fmt.Errorf("couldn't find efiboot file: %s", ctx.rinfo.efifile), "")
w.WriteHeader(http.StatusNotFound)
return
}

2
internal/pkg/warewulfd/server/server.go
View File

@@ -97,7 +97,7 @@ func RunServer() error {
auth := warewulfconf.NewAuthentication()
if util.IsFile(conf.Paths.AuthenticationConf()) {
if err := auth.Read(conf.Paths.AuthenticationConf()); err != nil {
wwlog.Warn("%w\n", err)
wwlog.Warn("%v", err)
}
}

4
internal/pkg/wwlog/wwlog.go
View File

@@ -167,10 +167,10 @@ func SetLogWriterInfo(newOut io.Writer) {
}
/*
Set the log ofr info only
Set the log writer for errors
*/
func SetLogWriterErr(newOut io.Writer) {
logOut = newOut
logErr = newOut
}
/*