Refactor gRPC-based image functions

Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2026-03-21 01:49:07 -06:00
parent a21a73379f
commit 3c895dd941
15 changed files with 420 additions and 582 deletions

View File

@@ -1,396 +0,0 @@
package image
import (
"fmt"
"os"
"path"
"path/filepath"
"slices"
"strconv"
"strings"
"github.com/containers/image/v5/types"
"github.com/warewulf/warewulf/internal/pkg/api/routes/wwapiv1"
"github.com/warewulf/warewulf/internal/pkg/image"
"github.com/warewulf/warewulf/internal/pkg/kernel"
"github.com/warewulf/warewulf/internal/pkg/node"
"github.com/warewulf/warewulf/internal/pkg/util"
"github.com/warewulf/warewulf/internal/pkg/warewulfd"
"github.com/warewulf/warewulf/internal/pkg/wwlog"
)
func ImageBuild(cbp *wwapiv1.ImageBuildParameter) (err error) {
if cbp == nil {
return fmt.Errorf("input parameter is nil")
}
var images []string
if cbp.All {
images, err = image.ListSources()
} else {
images = cbp.ImageNames
}
if len(images) == 0 {
return
}
for _, c := range images {
if !image.ValidSource(c) {
return fmt.Errorf("image name does not exist: %s", c)
}
err = image.Build(c, cbp.Force)
if err != nil {
return fmt.Errorf("could not build image %s: %s", c, err)
}
}
return
}
func ImageDelete(cdp *wwapiv1.ImageDeleteParameter) (err error) {
if cdp == nil {
return fmt.Errorf("input parameter is nil")
}
nodeDB, err := node.New()
if err != nil {
return fmt.Errorf("could not open nodeDB: %s", err)
}
// validate image names
for _, imageName := range cdp.ImageNames {
if !image.ValidSource(imageName) {
return fmt.Errorf("image name is not valid source: %s", imageName)
}
}
// check if the deleted images are not used by nodes
for nodeName, node := range nodeDB.Nodes {
if slices.Contains(cdp.ImageNames, node.ImageName) {
return fmt.Errorf("image %s is in use by node %s, cannot delete", node.ImageName, nodeName)
}
}
// check if the deleted images are not used by profiles
for profileName, profile := range nodeDB.NodeProfiles {
if slices.Contains(cdp.ImageNames, profile.ImageName) {
return fmt.Errorf("image %s is in use by profile %s, cannot delete", profile.ImageName, profileName)
}
}
// delete images
for _, imageName := range cdp.ImageNames {
err := image.DeleteSource(imageName)
if err != nil {
return fmt.Errorf("could not remove source image %s: %w", imageName, err)
}
err = image.DeleteImage(imageName)
if err != nil {
return fmt.Errorf("could not remove image file %s: %w", imageName, err)
}
wwlog.Info("Image %q has been deleted", imageName)
}
return
}
func ImageImport(cip *wwapiv1.ImageImportParameter) (imageName string, err error) {
if cip == nil {
err = fmt.Errorf("input parameter is nil")
return
}
if cip.Name == "" {
name := path.Base(cip.Source)
wwlog.Info("Setting image name: %s", name)
cip.Name = name
}
if !image.ValidName(cip.Name) {
err = fmt.Errorf("image name contains illegal characters: %s", cip.Name)
return
}
imageName = cip.Name
fullPath := image.SourceDir(cip.Name)
// image already exists and should be removed first
if util.IsDir(fullPath) && cip.Force {
wwlog.Info("Overwriting existing image")
err = os.RemoveAll(fullPath)
if err != nil {
return
}
}
if util.IsDir(fullPath) {
if !cip.Update {
err = fmt.Errorf("image name exists, specify --force, --update, or choose a different name: %s", cip.Name)
return
}
wwlog.Info("Updating existing image")
}
if strings.HasPrefix(cip.Source, "docker://") || strings.HasPrefix(cip.Source, "docker-daemon://") ||
strings.HasPrefix(cip.Source, "file://") || util.IsFile(cip.Source) {
var sCtx *types.SystemContext
sCtx, err = GetSystemContext(cip.OciNoHttps, cip.OciUsername, cip.OciPassword, cip.Platform)
if err != nil {
return
}
if util.IsFile(cip.Source) && !filepath.IsAbs(cip.Source) {
cip.Source, err = filepath.Abs(cip.Source)
if err != nil {
err = fmt.Errorf("when resolving absolute path of %s, err: %v", cip.Source, err)
return
}
}
err = image.ImportDocker(cip.Source, cip.Name, sCtx)
if err != nil {
err = fmt.Errorf("could not import image: %s", err.Error())
_ = image.DeleteSource(cip.Name)
return
}
} else if util.IsDir(cip.Source) {
err = image.ImportDirectory(cip.Source, cip.Name)
if err != nil {
err = fmt.Errorf("could not import image: %s", err.Error())
_ = image.DeleteSource(cip.Name)
return
}
} else {
err = fmt.Errorf("invalid dir or uri: %s", cip.Source)
return
}
if cip.SyncUser {
err = image.Syncuser(cip.Name, true)
if err != nil {
err = fmt.Errorf("syncuser error: %w", err)
return
}
}
if cip.Build {
wwlog.Info("Building image: %s", cip.Name)
err = image.Build(cip.Name, true)
if err != nil {
err = fmt.Errorf("could not build image %s: %s", cip.Name, err.Error())
return
}
}
return
}
func ImageList() (imageInfo []*wwapiv1.ImageInfo, err error) {
var sources []string
sources, err = image.ListSources()
if err != nil {
wwlog.Error("%s", err)
return
}
nodeDB, err := node.New()
if err != nil {
wwlog.Error("%s", err)
return
}
nodes, err := nodeDB.FindAllNodes()
if err != nil {
wwlog.Error("%s", err)
return
}
nodemap := make(map[string]int)
for _, n := range nodes {
nodemap[n.ImageName]++
}
for _, source := range sources {
if nodemap[source] == 0 {
nodemap[source] = 0
}
wwlog.Debug("Finding kernel version for: %s", source)
kernel := kernel.FindKernels(source).Default()
kernelVersion := ""
if kernel != nil {
kernelVersion = kernel.Version()
}
var creationTime uint64
sourceStat, err := os.Stat(image.SourceDir(source))
wwlog.Debug("Checking creation time for: %s,%v", image.SourceDir(source), sourceStat.ModTime())
if err != nil {
wwlog.Error("%s", err)
} else {
creationTime = uint64(sourceStat.ModTime().Unix())
}
var modTime uint64
imageStat, err := os.Stat(image.ImageFile(source))
if err == nil {
modTime = uint64(imageStat.ModTime().Unix())
}
imgSize := image.ImageSize(source)
imgCSize := image.CompressedImageSize(source)
imageInfo = append(imageInfo, &wwapiv1.ImageInfo{
Name: source,
NodeCount: uint32(nodemap[source]),
KernelVersion: kernelVersion,
CreateDate: creationTime,
ModDate: modTime,
ImgSize: uint64(imgSize),
ImgSizeComp: uint64(imgCSize),
})
}
return
}
func ImageShow(csp *wwapiv1.ImageShowParameter) (response *wwapiv1.ImageShowResponse, err error) {
imageName := csp.ImageName
if !image.ValidName(imageName) {
err = fmt.Errorf("%s is not a valid image name", imageName)
return
}
rootFsDir := image.RootFsDir(imageName)
if !util.IsDir(rootFsDir) {
err = fmt.Errorf("%s is not a valid image", imageName)
return
}
kernel := kernel.FindKernels(imageName).Default()
kernelVersion := ""
if kernel != nil {
kernelVersion = kernel.Version()
}
nodeDB, err := node.New()
if err != nil {
return
}
nodes, err := nodeDB.FindAllNodes()
if err != nil {
return
}
var nodeList []string
for _, n := range nodes {
if n.ImageName == imageName {
nodeList = append(nodeList, n.Id())
}
}
response = &wwapiv1.ImageShowResponse{
Name: imageName,
Rootfs: rootFsDir,
Nodes: nodeList,
KernelVersion: kernelVersion,
}
return
}
func ImageRename(crp *wwapiv1.ImageRenameParameter) (err error) {
// rename the image source folder
sourceDir := image.SourceDir(crp.ImageName)
destDir := image.SourceDir(crp.TargetName)
err = os.Rename(sourceDir, destDir)
if err != nil {
return err
}
err = image.DeleteImage(crp.ImageName)
if err != nil {
wwlog.Warn("Could not remove image files for %s: %s", crp.ImageName, err)
}
if crp.Build {
err = image.Build(crp.TargetName, true)
if err != nil {
return err
}
}
// update the nodes profiles image name
nodeDB, err := node.New()
if err != nil {
return err
}
for nodeId, node := range nodeDB.Nodes {
if node.ImageName == crp.ImageName {
wwlog.Debug("updating node %s image to %s", nodeId, crp.TargetName)
nodeDB.Nodes[nodeId].ImageName = crp.TargetName
}
}
for profileId, profile := range nodeDB.NodeProfiles {
if profile.ImageName == crp.ImageName {
wwlog.Debug("updating profile %s image to %s", profileId, crp.TargetName)
nodeDB.NodeProfiles[profileId].ImageName = crp.TargetName
}
}
err = nodeDB.Persist()
if err != nil {
return err
}
err = warewulfd.DaemonStatus()
if err != nil {
// warewulfd is not running, skip
return nil
}
// else reload daemon to apply new changes
return warewulfd.DaemonReload()
}
// create the system context and reading out environment variables
func GetSystemContext(noHttps bool, username string, password string, platform string) (sCtx *types.SystemContext, err error) {
sCtx = &types.SystemContext{}
// only check env if noHttps wasn't set
if !noHttps {
val, ok := os.LookupEnv("WAREWULF_OCI_NOHTTPS")
if ok {
noHttps, err = strconv.ParseBool(val)
if err != nil {
return nil, fmt.Errorf("while parsing insecure http option: %v", err)
}
}
// only set this if we want to disable, otherwise leave as undefined
if noHttps {
sCtx.DockerInsecureSkipTLSVerify = types.NewOptionalBool(true)
}
sCtx.OCIInsecureSkipTLSVerify = noHttps
}
if username == "" {
username, _ = os.LookupEnv("WAREWULF_OCI_USERNAME")
}
if password == "" {
password, _ = os.LookupEnv("WAREWULF_OCI_PASSWORD")
}
if username != "" || password != "" {
if username != "" && password != "" {
sCtx.DockerAuthConfig = &types.DockerAuthConfig{
Username: username,
Password: password,
}
} else {
return nil, fmt.Errorf("oci username and password env vars must be specified together")
}
}
if platform == "" {
platform, _ = os.LookupEnv("WAREWULF_OCI_PLATFORM")
}
if platform != "" {
sCtx.ArchitectureChoice = platform
}
return sCtx, nil
}

View File

@@ -4,8 +4,6 @@ import (
"fmt"
"path"
"github.com/pkg/errors"
"github.com/warewulf/warewulf/internal/pkg/util"
"github.com/warewulf/warewulf/internal/pkg/wwlog"
)
@@ -17,7 +15,7 @@ func Build(name string, buildForce bool) error {
imagePath := ImageFile(name)
if !ValidSource(name) {
return errors.Errorf("Image does not exist: %s", name)
return fmt.Errorf("Image does not exist: %s", name)
}
if !buildForce {

View File

@@ -0,0 +1,78 @@
package image
import (
"fmt"
"os"
"github.com/warewulf/warewulf/internal/pkg/node"
"github.com/warewulf/warewulf/internal/pkg/util"
"github.com/warewulf/warewulf/internal/pkg/wwlog"
)
func Delete(name string) error {
// validate image names
if !ValidSource(name) {
return fmt.Errorf("image name is not valid source: %s", name)
}
nodeDB, err := node.New()
if err != nil {
return fmt.Errorf("could not open nodeDB: %s", err)
}
// check if the deleted images are not used by nodes
for nodeName, node := range nodeDB.Nodes {
if node.ImageName == name {
return fmt.Errorf("image %s is in use by node %s, cannot delete", node.ImageName, nodeName)
}
}
// check if the deleted images are not used by profiles
for profileName, profile := range nodeDB.NodeProfiles {
if profile.ImageName == name {
return fmt.Errorf("image %s is in use by profile %s, cannot delete", profile.ImageName, profileName)
}
}
// delete images
if err := DeleteSource(name); err != nil {
return fmt.Errorf("could not remove image source %s: %w", name, err)
}
if err := DeleteImage(name); err != nil {
return fmt.Errorf("could not remove image file %s: %w", name, err)
}
wwlog.Info("Deleted image %q", name)
return nil
}
/*
Delete the chroot of an image
*/
func DeleteSource(name string) error {
fullPath := SourceDir(name)
wwlog.Verbose("Removing path: %s", fullPath)
return os.RemoveAll(fullPath)
}
/*
Delete the image of an image
*/
func DeleteImage(name string) error {
imageFile := ImageFile(name)
if util.IsFile(imageFile) {
wwlog.Verbose("removing %s for image %s", imageFile, name)
errImg := os.Remove(imageFile)
wwlog.Verbose("removing %s for image %s", imageFile+".gz", name)
errGz := os.Remove(imageFile + ".gz")
if errImg != nil {
return fmt.Errorf("Problems delete %s for image %s: %s", imageFile, name, errImg)
}
if errGz != nil {
return fmt.Errorf("Problems delete %s for image %s: %s", imageFile+".gz", name, errGz)
}
return nil
}
return fmt.Errorf("Image %s of image %s doesn't exist", imageFile, name)
}

View File

@@ -2,8 +2,10 @@ package image
import (
"context"
"fmt"
"os"
"path"
"strconv"
"github.com/containers/image/v5/types"
"github.com/containers/storage/drivers/copy"
@@ -74,3 +76,48 @@ func ImportDirectory(uri string, name string) error {
return nil
}
// create the system context and reading out environment variables
func GetSystemContext(noHttps bool, username string, password string, platform string) (sCtx *types.SystemContext, err error) {
sCtx = &types.SystemContext{}
// only check env if noHttps wasn't set
if !noHttps {
val, ok := os.LookupEnv("WAREWULF_OCI_NOHTTPS")
if ok {
noHttps, err = strconv.ParseBool(val)
if err != nil {
return nil, fmt.Errorf("while parsing insecure http option: %v", err)
}
}
// only set this if we want to disable, otherwise leave as undefined
if noHttps {
sCtx.DockerInsecureSkipTLSVerify = types.NewOptionalBool(true)
}
sCtx.OCIInsecureSkipTLSVerify = noHttps
}
if username == "" {
username, _ = os.LookupEnv("WAREWULF_OCI_USERNAME")
}
if password == "" {
password, _ = os.LookupEnv("WAREWULF_OCI_PASSWORD")
}
if username != "" || password != "" {
if username != "" && password != "" {
sCtx.DockerAuthConfig = &types.DockerAuthConfig{
Username: username,
Password: password,
}
} else {
return nil, fmt.Errorf("oci username and password env vars must be specified together")
}
}
if platform == "" {
platform, _ = os.LookupEnv("WAREWULF_OCI_PLATFORM")
}
if platform != "" {
sCtx.ArchitectureChoice = platform
}
return sCtx, nil
}

View File

@@ -0,0 +1,60 @@
package image
import (
"fmt"
"os"
"github.com/warewulf/warewulf/internal/pkg/node"
"github.com/warewulf/warewulf/internal/pkg/wwlog"
)
func Rename(name string, targetName string, build bool) error {
if !ValidSource(name) {
return fmt.Errorf("image source does not exist: %s", name)
}
if !ValidName(targetName) {
return fmt.Errorf("invalid image name: %s", targetName)
}
// rename the image source folder
sourceDir := SourceDir(name)
destDir := SourceDir(targetName)
err := os.Rename(sourceDir, destDir)
if err != nil {
return err
}
err = DeleteImage(name)
if err != nil {
wwlog.Warn("Could not remove image files for %s: %s", name, err)
}
if build {
err = Build(targetName, true)
if err != nil {
return err
}
}
// update the nodes profiles image name
nodeDB, err := node.New()
if err != nil {
return err
}
for nodeId, node := range nodeDB.Nodes {
if node.ImageName == name {
wwlog.Debug("updating node %s image to %s", nodeId, targetName)
nodeDB.Nodes[nodeId].ImageName = targetName
}
}
for profileId, profile := range nodeDB.NodeProfiles {
if profile.ImageName == name {
wwlog.Debug("updating profile %s image to %s", profileId, targetName)
nodeDB.NodeProfiles[profileId].ImageName = targetName
}
}
return nodeDB.Persist()
}

View File

@@ -68,16 +68,6 @@ func ValidSource(name string) bool {
return true
}
/*
Delete the chroot of an image
*/
func DeleteSource(name string) error {
fullPath := SourceDir(name)
wwlog.Verbose("Removing path: %s", fullPath)
return os.RemoveAll(fullPath)
}
func Duplicate(name string, destination string) error {
fullPathImageSource := RootFsDir(name)
@@ -91,27 +81,6 @@ func Duplicate(name string, destination string) error {
return nil
}
/*
Delete the image of an image
*/
func DeleteImage(name string) error {
imageFile := ImageFile(name)
if util.IsFile(imageFile) {
wwlog.Verbose("removing %s for image %s", imageFile, name)
errImg := os.Remove(imageFile)
wwlog.Verbose("removing %s for image %s", imageFile+".gz", name)
errGz := os.Remove(imageFile + ".gz")
if errImg != nil {
return errors.Errorf("Problems delete %s for image %s: %s\n", imageFile, name, errImg)
}
if errGz != nil {
return errors.Errorf("Problems delete %s for image %s: %s\n", imageFile+".gz", name, errGz)
}
return nil
}
return errors.Errorf("Image %s of image %s doesn't exist\n", imageFile, name)
}
func IsWriteAble(name string) bool {
return !util.IsFile(filepath.Join(SourceDir(name), "readonly"))
}

View File

@@ -7,11 +7,10 @@ import (
"github.com/swaggest/usecase"
"github.com/swaggest/usecase/status"
image_api "github.com/warewulf/warewulf/internal/pkg/api/image"
"github.com/warewulf/warewulf/internal/pkg/api/routes/wwapiv1"
"github.com/warewulf/warewulf/internal/pkg/image"
"github.com/warewulf/warewulf/internal/pkg/kernel"
"github.com/warewulf/warewulf/internal/pkg/node"
"github.com/warewulf/warewulf/internal/pkg/warewulfd"
"github.com/warewulf/warewulf/internal/pkg/wwlog"
)
@@ -99,7 +98,7 @@ func importImage() usecase.Interactor {
return status.Wrap(fmt.Errorf("name contains illegal characters: %s", input.Name), status.InvalidArgument)
}
if sctx, err := image_api.GetSystemContext(input.NoHttps, input.User, input.Password, ""); err != nil {
if sctx, err := image.GetSystemContext(input.NoHttps, input.User, input.Password, ""); err != nil {
return err
} else {
if err := image.ImportDocker(input.URI, input.Name, sctx); err != nil {
@@ -139,11 +138,7 @@ func deleteImage() usecase.Interactor {
}
}
cdp := &wwapiv1.ImageDeleteParameter{
ImageNames: []string{input.Name},
}
return image_api.ImageDelete(cdp)
return image.Delete(input.Name)
})
u.SetTitle("Delete an image")
u.SetDescription("Delete an existing OS image")
@@ -163,16 +158,11 @@ func updateImage() usecase.Interactor {
wwlog.Debug("api.updateImage(Name:%v, NewName:%v, Build:%v)", input.Name, input.NewName, input.Build)
name := input.Name
if input.NewName != "" {
crp := &wwapiv1.ImageRenameParameter{
ImageName: input.Name,
TargetName: input.NewName,
Build: input.Build,
}
if err := image_api.ImageRename(crp); err != nil {
if err := image.Rename(input.Name, input.NewName, input.Build); err != nil {
return err
}
name = input.NewName
warewulfd.Reload()
}
*output = *NewImage(name)
@@ -193,12 +183,8 @@ func buildImage() usecase.Interactor {
u := usecase.NewInteractor(func(ctx context.Context, input buildImageInput, output *Image) error {
wwlog.Debug("api.buildImage(Name:%v, Force:%v)", input.Name, input.Force)
cbp := &wwapiv1.ImageBuildParameter{
ImageNames: []string{input.Name},
Force: input.Force,
}
if err := image_api.ImageBuild(cbp); err != nil {
if err := image.Build(input.Name, input.Force); err != nil {
return err
}