feat: add persistent disks on raveld with ZFS

Author: lucas-jacques

cmd/ravel/commands/disks/create.go

@@ -0,0 +1,42 @@
+package disks
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/valyentdev/ravel/cmd/ravel/util"
+	"github.com/valyentdev/ravel/core/daemon"
+)
+
+func newCreateCmd() *cobra.Command {
+	var size uint64
+
+	cmd := &cobra.Command{
+		Use:   "create <id> [--size|-s <size>]",
+		Short: "Create a disk",
+		RunE: func(cmd *cobra.Command, args []string) error {
+
+			if len(args) == 0 {
+				cmd.Println("id is required")
+				return cmd.Usage()
+			}
+			return runCreateDisk(cmd, args[0], size)
+		},
+	}
+
+	cmd.Flags().Uint64VarP(&size, "size", "s", 512, "Size of the disk in MB")
+
+	return cmd
+}
+
+func runCreateDisk(cmd *cobra.Command, id string, size uint64) error {
+	disk, err := util.GetDaemonClient(cmd).CreateDisk(cmd.Context(), daemon.DiskOptions{
+		SizeMB: size,
+		Id:     id,
+	})
+
+	if err != nil {
+		return err
+	}
+
+	cmd.Printf("Disk %s created\n", disk.Id)
+	return nil
+}

cmd/ravel/commands/disks/destroy.go

@@ -0,0 +1,25 @@
+package disks
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/valyentdev/ravel/cmd/ravel/util"
+)
+
+func newDestroyCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "destroy <id>",
+		Short: "Destroy a disk",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return runDestroyDisk(cmd, args[0])
+		},
+	}
+}
+
+func runDestroyDisk(cmd *cobra.Command, id string) error {
+	err := util.GetDaemonClient(cmd).DestroyDisk(cmd.Context(), id)
+	if err != nil {
+		return err
+	}
+	cmd.Printf("Disk %s destroyed\n", id)
+	return nil
+}

cmd/ravel/commands/disks/disks.go

@@ -0,0 +1,16 @@
+package disks
+
+import "github.com/spf13/cobra"
+
+func NewDisksCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "disks",
+		Short: "Manage disks",
+	}
+
+	cmd.AddCommand(newCreateCmd())
+	cmd.AddCommand(newListCmd())
+	cmd.AddCommand(newDestroyCmd())
+
+	return cmd
+}

cmd/ravel/commands/disks/ls.go

@@ -0,0 +1,39 @@
+package disks
+
+import (
+	"fmt"
+	"text/tabwriter"
+
+	"github.com/spf13/cobra"
+	"github.com/valyentdev/ravel/cmd/ravel/util"
+)
+
+func newListCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "ls",
+		Short: "List disks",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			disks, err := util.GetDaemonClient(cmd).ListDisks(cmd.Context())
+			if err != nil {
+				return err
+			}
+
+			w := tabwriter.NewWriter(cmd.OutOrStdout(), 1, 1, 1, ' ', 0)
+
+			fmt.Fprintln(w, "ID\tINSTANCE\tSIZE MB\tCREATED AT")
+			for _, disk := range disks {
+				var instance string
+				if disk.AttachedInstance != "" {
+					instance = disk.AttachedInstance
+				} else {
+					instance = "-"
+				}
+
+				fmt.Fprintf(w, "%s\t%s\t%dMB\t%s\n", disk.Id, instance, disk.SizeMB, disk.CreatedAt)
+			}
+			w.Flush()
+
+			return nil
+		},
+	}
+}

cmd/ravel/commands/root.go

@@ -7,6 +7,7 @@ import (
 	"github.com/valyentdev/ravel/cmd/ravel/commands/corrosion"
 	"github.com/valyentdev/ravel/cmd/ravel/commands/daemon"
 	"github.com/valyentdev/ravel/cmd/ravel/commands/db"
+	"github.com/valyentdev/ravel/cmd/ravel/commands/disks"
 	"github.com/valyentdev/ravel/cmd/ravel/commands/images"
 	"github.com/valyentdev/ravel/cmd/ravel/commands/instance"
 	"github.com/valyentdev/ravel/cmd/ravel/commands/server"
@@ -39,6 +40,7 @@ func NewRootCmd() *cobra.Command {
 		images.NewImagesCmd(),
 		tls.NewTLSCommand(),
 		corrosion.NewCorroCmd(),
+		disks.NewDisksCmd(),
 	)
 
 	return rootCmd

core/config/runtime.go

@@ -5,4 +5,5 @@ type RuntimeConfig struct {
 	JailerBinary          string `json:"jailer_binary" toml:"jailer_binary"`
 	InitBinary            string `json:"init_binary" toml:"init_binary"`
 	LinuxKernel           string `json:"linux_kernel" toml:"linux_kernel"`
+	ZFSPool               string `json:"zfs_pool" toml:"zfs_pool"`
 }

core/daemon/daemon.go

@@ -9,6 +9,7 @@ import (
 	"github.com/valyentdev/ravel/api/errdefs"
 	"github.com/valyentdev/ravel/core/instance"
 	"github.com/valyentdev/ravel/core/validation"
+	"github.com/valyentdev/ravel/runtime/disks"
 )
 
 type InstanceOptions struct {
@@ -34,6 +35,11 @@ func (i *InstanceOptions) Validate() error {
 	return nil
 }
 
+type DiskOptions struct {
+	Id     string `json:"id"`
+	SizeMB uint64 `json:"size_mb"`
+}
+
 type Daemon interface {
 	CreateInstance(ctx context.Context, opt InstanceOptions) (*instance.Instance, error)
 	GetInstance(ctx context.Context, id string) (*instance.Instance, error)
@@ -48,4 +54,9 @@ type Daemon interface {
 	DeleteImage(ctx context.Context, ref string) error
 	ListImages(ctx context.Context) ([]images.Image, error)
 	PullImage(ctx context.Context, opt ImagePullOptions) (*images.Image, error)
+
+	CreateDisk(ctx context.Context, opt DiskOptions) (*disks.Disk, error)
+	GetDisk(ctx context.Context, id string) (*disks.Disk, error)
+	ListDisks(ctx context.Context) ([]disks.Disk, error)
+	DestroyDisk(ctx context.Context, id string) error
 }

core/instance/instance.go

@@ -45,12 +45,26 @@ type State struct {
 	ExitResult *ExitResult    `json:"exit_result,omitempty"`
 }
 
+type Mount struct {
+	Disk string `json:"disk"`
+	Path string `json:"path"`
+}
+
 type InstanceConfig struct {
-	Image string              `json:"image"`
-	Guest InstanceGuestConfig `json:"guest"`
-	Init  api.InitConfig      `json:"init"`
-	Stop  *api.StopConfig     `json:"stop,omitempty"`
-	Env   []string            `json:"env"`
+	Image  string              `json:"image"`
+	Guest  InstanceGuestConfig `json:"guest"`
+	Init   api.InitConfig      `json:"init"`
+	Stop   *api.StopConfig     `json:"stop,omitempty"`
+	Env    []string            `json:"env,omitempty"`
+	Mounts []Mount             `json:"mounts,omitempty"`
+}
+
+func (ic InstanceConfig) GetDisks() []string {
+	disks := make([]string, len(ic.Mounts))
+	for i, m := range ic.Mounts {
+		disks[i] = m.Disk
+	}
+	return disks
 }
 
 type InstanceGuestConfig struct {

core/validation/instance.go

@@ -12,6 +12,21 @@ import (
 
 var idRegexp = regexp.MustCompile("^[A-Za-z0-9_-]+$")
 
+func ValidateObjectId(id string) error {
+	if id == "" {
+		return errors.New("id is required")
+	}
+
+	if len(id) > 64 {
+		return errors.New("id is too long")
+	}
+
+	if !idRegexp.MatchString(id) {
+		return errors.New("id contains invalid characters")
+	}
+	return nil
+}
+
 func ValidateInstanceId(id string) error {
 	if id == "" {
 		return errors.New("instance id is required")

docs/examples/example.json

@@ -13,7 +13,8 @@
             },
             "init": {
                 "user": "root"
-            }
+            },
+            "auto_destroy": true
         },
         "guest": {
             "cpu_kind": "eco",