diff --git a/internal/pkg/warewulfd/daemon.go b/internal/pkg/warewulfd/daemon.go index 5ee29d42..65bfe4d7 100644 --- a/internal/pkg/warewulfd/daemon.go +++ b/internal/pkg/warewulfd/daemon.go @@ -1,3 +1,8 @@ +// Package warewulfd implements the Warewulf provisioning daemon, handling +// HTTP requests from compute nodes for boot files, kernel images, overlays, +// and EFI bootloaders. +// +// See userdocs/server/routes.rst for more information. package warewulfd import ( diff --git a/internal/pkg/warewulfd/parser.go b/internal/pkg/warewulfd/parser.go index 1fdbeda1..ef70e98d 100644 --- a/internal/pkg/warewulfd/parser.go +++ b/internal/pkg/warewulfd/parser.go @@ -96,6 +96,12 @@ func parseHwaddr(hwaddr string) string { return hwaddr } +// parseRequest extracts provisioning parameters from an HTTP request. The +// stage and hwaddr are taken from the URL path, with fallbacks to query +// parameters and ARP cache lookup for hwaddr. Stage aliases (e.g. +// "container", "overlay-system") are normalized to their canonical names. +// +// See userdocs/server/routes.rst for more information. func parseRequest(req *http.Request) (parsedRequest, error) { var ret parsedRequest diff --git a/internal/pkg/warewulfd/server/server.go b/internal/pkg/warewulfd/server/server.go index e436efdf..f3661f62 100644 --- a/internal/pkg/warewulfd/server/server.go +++ b/internal/pkg/warewulfd/server/server.go @@ -1,3 +1,7 @@ +// Package server starts the Warewulf HTTP(S) server, registers provisioning +// and API routes, and handles TLS configuration and SIGHUP-triggered reloads. +// +// See userdocs/server/routes.rst for more information. package server import (