166: Add ability to host Shared VMs to Gargantua

v3/pkg/apis/hobbyfarm.io/v1/types.go

@@ -33,16 +33,24 @@ type VirtualMachineList struct {
 }
 
 type VirtualMachineSpec struct {
-	VirtualMachineTemplateId string `json:"vm_template_id"`
-	SshUsername              string `json:"ssh_username"`
-	Protocol                 string `json:"protocol"`
-	SecretName               string `json:"secret_name"` // this refers to the secret name for the keypair
-	VirtualMachineClaimId    string `json:"vm_claim_id"`
-	UserId                   string `json:"user"`
-	Provision                bool   `json:"provision"`
-	VirtualMachineSetId      string `json:"vm_set_id"`
+	VirtualMachineTemplateId string             `json:"vm_template_id"`
+	SshUsername              string             `json:"ssh_username"`
+	Protocol                 string             `json:"protocol"`
+	SecretName               string             `json:"secret_name"` // this refers to the secret name for the keypair
+	VirtualMachineClaimId    string             `json:"vm_claim_id"`
+	UserId                   string             `json:"user"`
+	Provision                bool               `json:"provision"`
+	VirtualMachineSetId      string             `json:"vm_set_id"`
+	VirtualMachineType       VirtualMachineType `json:"vm_type"`
 }
 
+type VirtualMachineType string
+
+const (
+	VirtualMachineTypeUser   VirtualMachineType = "USER"
+	VirtualMachineTypeShared VirtualMachineType = "SHARED"
+)
+
 type VirtualMachineStatus struct {
 	Status        VmStatus `json:"status"` // default is nothing, but could be one of the following: readyforprovisioning, provisioning, running, terminating
 	Allocated     bool     `json:"allocated"`
@@ -488,6 +496,7 @@ type ScheduledEventSpec struct {
 	Printable               bool                      `json:"printable"`
 	Scenarios               []string                  `json:"scenarios"`
 	Courses                 []string                  `json:"courses"`
+	SharedVirtualMachines   []SharedVirtualMachine    `json:"shared_vms"`
 }
 
 type ScheduledEventStatus struct {
@@ -498,6 +507,13 @@ type ScheduledEventStatus struct {
 	Finished           bool     `json:"finished"`
 }
 
+type SharedVirtualMachine struct {
+	VMId        string `json:"vmId"`
+	Name        string `json:"name"`
+	Environment string `json:"environment"`
+	VMTemplate  string `json:"vmTemplate"`
+}
+
 // +genclient
 // +genclient:noStatus
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

v3/pkg/shell/shell.go

@@ -182,7 +182,8 @@ func (sp ShellProxy) proxy(w http.ResponseWriter, r *http.Request, user *userpb.
 		return
 	}
 
-	if vm.GetUser() != user.GetId() {
+	// TODO, if this is a shared VM we should check if the user has access to the Event this Shared VM belongs too.
+	if vm.GetUser() != user.GetId() && vm.GetVmType() == vmpb.VirtualMachineType_USER {
 		// check if the user has access to user sessions
 		impersonatedUserId := user.GetId()
 		authrResponse, err := rbac2.Authorize(r, sp.authrClient, impersonatedUserId, []*authrpb.Permission{
@@ -840,11 +841,9 @@ func (sp ShellProxy) VerifyTasksFuncByVMIdGroupWithSemaphore(w http.ResponseWrit
 		// Handle the error (log, return HTTP error response)
 		close(errorChan)
 		glog.Infof("Error in goroutine: %v", err)
-		util.ReturnHTTPMessage(w, r, 500, "error", "could send command to vm")
+		util.ReturnHTTPMessage(w, r, 500, "error", "could not send command to vm")
 		return
 	default:
-		// No error in the errorChan
-		glog.Infof("No Error in goroutine: %v", vm_output_tasks)
 		jsonStr, _ := json.Marshal(vm_output_tasks)
 		util.ReturnHTTPContent(w, r, 200, "success", jsonStr)
 	}

v3/pkg/util/conversion.go

@@ -55,3 +55,20 @@ func ConvertToStringMapStructMap(in map[string]map[string]string) map[string]*ge
 	}
 	return output
 }
+
+// This function converts a string or underlying string type to a protobuf enum
+func ConvertToPBEnum[T ~string, PB ~int32](val T, pbmap map[string]int32, dftVal PB) PB {
+	v, ok := pbmap[string(val)]
+	if !ok {
+		return dftVal
+	}
+	return PB(v)
+}
+
+func ConvertToStringEnum[PB ~int32, T ~string](pbval PB, pbmap map[int32]string, dftStr T) T {
+	v, ok := pbmap[int32(pbval)]
+	if !ok {
+		return dftStr
+	}
+	return T(v)
+}

v3/pkg/util/verify.go

@@ -82,3 +82,24 @@ func VerifyTaskContent(vm_tasks []hfv1.VirtualMachineTasks, request proto.Messag
 	}
 	return nil
 }
+
+func VerifySharedVirtualMachineContent(virtual_machines []hfv1.SharedVirtualMachine, request proto.Message) error {
+	//Verify that name, description and command are not empty
+	for _, virtual_machine := range virtual_machines {
+		if virtual_machine.Name == "" {
+			glog.Errorf("error: Name (of virtual_machines) is not specified")
+			return hferrors.GrpcError(codes.InvalidArgument, "name for virtual_machines property is not specified", request)
+		}
+
+		if virtual_machine.Environment == "" {
+			glog.Errorf("error: Environment (of virtual_machine %s) is not specified", virtual_machine.Name)
+			return hferrors.GrpcError(codes.InvalidArgument, "name for virtual_machines property is not specified for "+virtual_machine.Name, request)
+		}
+
+		if virtual_machine.VMTemplate == "" {
+			glog.Errorf("error VMTemplate (of virtual_machine %s) is not specified", virtual_machine.Name)
+			return hferrors.GrpcError(codes.InvalidArgument, "name for virtual_machines property is not specified for "+virtual_machine.Name, request)
+		}
+	}
+	return nil
+}