Merge pull request #213 from threefoldtech/development_cli_gpu

Adding deploying vm with GPU option

Author: maayarosama

grid-cli/cmd/deploy_vm.go

@@ -12,11 +12,19 @@ import (
 	"github.com/threefoldtech/tfgrid-sdk-go/grid-cli/internal/filters"
 	"github.com/threefoldtech/tfgrid-sdk-go/grid-client/deployer"
 	"github.com/threefoldtech/tfgrid-sdk-go/grid-client/workloads"
+	"github.com/threefoldtech/zos/pkg/gridtypes/zos"
 )
 
 var ubuntuFlist = "https://hub.grid.tf/tf-official-apps/threefoldtech-ubuntu-22.04.flist"
 var ubuntuFlistEntrypoint = "/sbin/zinit init"
 
+func convertGPUsToZosGPUs(gpus []string) (zosGPUs []zos.GPU) {
+	for _, g := range gpus {
+		zosGPUs = append(zosGPUs, zos.GPU(g))
+	}
+	return
+}
+
 // deployVMCmd represents the deploy vm command
 var deployVMCmd = &cobra.Command{
 	Use:   "vm",
@@ -66,6 +74,11 @@ var deployVMCmd = &cobra.Command{
 		if err != nil {
 			return err
 		}
+		gpus, err := cmd.Flags().GetStringSlice("gpus")
+		if err != nil {
+			return err
+		}
+
 		ipv4, err := cmd.Flags().GetBool("ipv4")
 		if err != nil {
 			return err
@@ -83,6 +96,7 @@ var deployVMCmd = &cobra.Command{
 			EnvVars:    map[string]string{"SSH_KEY": string(sshKey)},
 			CPU:        cpu,
 			Memory:     memory * 1024,
+			GPUs:       convertGPUsToZosGPUs(gpus),
 			RootfsSize: rootfs * 1024,
 			Flist:      flist,
 			Entrypoint: entrypoint,
@@ -104,6 +118,7 @@ var deployVMCmd = &cobra.Command{
 		if err != nil {
 			log.Fatal().Err(err).Send()
 		}
+
 		if node == 0 {
 			nodes, err := deployer.FilterNodes(
 				cmd.Context(),
@@ -158,6 +173,10 @@ func init() {
 	deployVMCmd.Flags().Int("rootfs", 2, "root filesystem size in gb")
 	deployVMCmd.Flags().Int("disk", 0, "disk size in gb mounted on /data")
 	deployVMCmd.Flags().String("flist", ubuntuFlist, "flist for vm")
+	deployVMCmd.Flags().StringSlice("gpus", []string{}, "gpus for vm")
+	// to ensure node is provided for gpus
+	deployVMCmd.MarkFlagsRequiredTogether("gpus", "node")
+
 	deployVMCmd.Flags().String("entrypoint", ubuntuFlistEntrypoint, "entrypoint for vm")
 	// to ensure entrypoint is provided for custom flist
 	deployVMCmd.MarkFlagsRequiredTogether("flist", "entrypoint")

grid-cli/docs/vm.md

@@ -26,15 +26,26 @@ tf-grid-cli deploy vm [flags]
 - memory: memory size in GB (default 1).
 - rootfs: root filesystem size in GB (default 2).
 - ygg: assign yggdrasil ip for VM (default true).
+- gpus: assign a list of gpus' ids to the VM. note: setting this without the node option will fail.
 
 Example:
 
+- Deploying VM without GPU
+
 ```console
 $ tf-grid-cli deploy vm --name examplevm --ssh ~/.ssh/id_rsa.pub --cpu 2 --memory 4 --disk 10
 12:06PM INF deploying network
 12:06PM INF deploying vm
 12:07PM INF vm yggdrasil ip: 300:e9c4:9048:57cf:7da2:ac99:99db:8821
 ```
+- Deploying VM with GPU
+
+```console
+$ tf-grid-cli deploy vm --name examplevm --ssh ~/.ssh/id_rsa.pub --cpu 2 --memory 4 --disk 10 --gpus '0000:0e:00.0/1882/543f' --gpus '0000:0e:00.0/1887/593f' --node 12
+12:06PM INF deploying network
+12:06PM INF deploying vm
+12:07PM INF vm yggdrasil ip: 300:e9c4:9048:57cf:7da2:ac99:99db:8821
+```
 
 ## Get