feat(instance): support scratch volumes in servers (#3345)

Co-authored-by: Nathanael Demacon <[email protected]>

Author: Codelax

go.mod

@@ -24,7 +24,7 @@ require (
 	github.com/moby/buildkit v0.11.6
 	github.com/opencontainers/go-digest v1.0.0
 	github.com/pkg/errors v0.9.1
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230911082817-45ad1e03b1bb
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21
 	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
 	github.com/spf13/cobra v1.7.0
 	github.com/spf13/pflag v1.0.5

go.sum

@@ -491,8 +491,8 @@ github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncj
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230911082817-45ad1e03b1bb h1:symGjmphE602x27B1kY17r2BamxUaO5alk8y/Vw5N5M=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230911082817-45ad1e03b1bb/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21 h1:yWfiTPwYxB0l5fGMhl/G+liULugVIHD9AU77iNLrURQ=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
 github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
 github.com/secure-systems-lab/go-securesystemslib v0.4.0 h1:b23VGrQhTA8cN2CbBw7/FulN9fTtqYUdS5+Oxzt+DUE=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=

internal/namespaces/instance/v1/custom_server_create.go

@@ -313,6 +313,11 @@ func instanceServerCreateRun(ctx context.Context, argsI interface{}) (i interfac
 		serverReq.Volumes = sanitizeVolumeMap(serverReq.Name, volumes)
 	}
 
+	// Add default volumes to server, ex: scratch storage for GPU servers
+	if serverType != nil {
+		serverReq.Volumes = addDefaultVolumes(serverType, serverReq.Volumes)
+	}
+
 	//
 	// BootType.
 	//
@@ -433,6 +438,46 @@ func instanceServerCreateRun(ctx context.Context, argsI interface{}) (i interfac
 	return server, nil
 }
 
+func addDefaultVolumes(serverType *instance.ServerType, volumes map[string]*instance.VolumeServerTemplate) map[string]*instance.VolumeServerTemplate {
+	needScratch := false
+	hasScratch := false
+	defaultVolumes := []*instance.VolumeServerTemplate(nil)
+	if serverType.ScratchStorageMaxSize != nil && *serverType.ScratchStorageMaxSize > 0 {
+		needScratch = true
+	}
+	for _, volume := range volumes {
+		if volume.VolumeType == instance.VolumeVolumeTypeScratch {
+			hasScratch = true
+		}
+	}
+
+	if needScratch && !hasScratch {
+		defaultVolumes = append(defaultVolumes, &instance.VolumeServerTemplate{
+			Name:       scw.StringPtr("default-cli-scratch-volume"),
+			Size:       serverType.ScratchStorageMaxSize,
+			VolumeType: instance.VolumeVolumeTypeScratch,
+		})
+	}
+
+	if defaultVolumes != nil {
+		if volumes == nil {
+			volumes = make(map[string]*instance.VolumeServerTemplate)
+		}
+		maxKey := 1
+		for k := range volumes {
+			key, err := strconv.Atoi(k)
+			if err == nil && key > maxKey {
+				maxKey = key
+			}
+		}
+		for i, vol := range defaultVolumes {
+			volumes[strconv.Itoa(maxKey+i)] = vol
+		}
+	}
+
+	return volumes
+}
+
 // buildVolumes creates the initial volume map.
 // It is not the definitive one, it will be mutated all along the process.
 func buildVolumes(api *instance.API, zone scw.Zone, serverName, rootVolume string, additionalVolumes []string) (map[string]*instance.VolumeServerTemplate, error) {
@@ -473,7 +518,7 @@ func buildVolumes(api *instance.API, zone scw.Zone, serverName, rootVolume strin
 // Volumes definition must be through multiple arguments (eg: volumes.0="l:20GB" volumes.1="b:100GB")
 //
 // A valid volume format is either
-// - a "creation" format: ^((local|l|block|b):)?\d+GB?$ (size is handled by go-humanize, so other sizes are supported)
+// - a "creation" format: ^((local|l|block|b|scratch|s):)?\d+GB?$ (size is handled by go-humanize, so other sizes are supported)
 // - a "creation" format with a snapshot id: l:<uuid> b:<uuid>
 // - a UUID format
 func buildVolumeTemplate(api *instance.API, zone scw.Zone, flagV string) (*instance.VolumeServerTemplate, error) {
@@ -488,6 +533,8 @@ func buildVolumeTemplate(api *instance.API, zone scw.Zone, flagV string) (*insta
 			vt.VolumeType = instance.VolumeVolumeTypeLSSD
 		case "b", "block":
 			vt.VolumeType = instance.VolumeVolumeTypeBSSD
+		case "s", "scratch":
+			vt.VolumeType = instance.VolumeVolumeTypeScratch
 		default:
 			return nil, fmt.Errorf("invalid volume type %s in %s volume", parts[0], flagV)
 		}

internal/namespaces/instance/v1/custom_server_create_test.go

@@ -1,6 +1,7 @@
 package instance
 
 import (
+	"fmt"
 	"testing"
 
 	"github.com/alecthomas/assert"
@@ -485,3 +486,29 @@ func Test_CreateServerErrors(t *testing.T) {
 		),
 	}))
 }
+
+func Test_CreateServerScratchStorage(t *testing.T) {
+	t.Run("Default scratch storage", core.Test(&core.TestConfig{
+		Commands: GetCommands(),
+		Cmd:      "scw instance server create type=H100-1-80G image=ubuntu_jammy_gpu_os_12",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			func(t *testing.T, ctx *core.CheckFuncCtx) {
+				fmt.Println(ctx.LogBuffer)
+			},
+			core.TestCheckExitCode(0),
+			func(t *testing.T, ctx *core.CheckFuncCtx) {
+				server, isServer := ctx.Result.(*instance.Server)
+				if !isServer {
+					t.Fatalf("Result is not a server")
+				}
+				additionalVolume, exist := server.Volumes["1"]
+				if !exist {
+					t.Fatalf("Expected an additional scratch volume, found none")
+				}
+				assert.Equal(t, additionalVolume.VolumeType, instance.VolumeServerVolumeTypeScratch)
+			},
+		),
+		DisableParallel: true,
+	}))
+}