Create default notebook 2.0 (#305)

* slight refactor to reduce duplicate conditional

* removed unused component

* added endpoint in backend for creating default notebook

* added default notebook label

---------

Co-authored-by: Mathis Marcotte <[email protected]>

Author: mathis-marcotte

frontend/jupyter/src/app/pages/form/form-new/form-new.component.ts

@@ -26,8 +26,6 @@ export class FormNewComponent
   formCtrl: FormGroup;
   config: Config;
 
-  defaultStorageclass = false;
-
   subscriptions = new Subscription();
 
   readonlySpecs: boolean;
@@ -91,20 +89,6 @@ export class FormNewComponent
         });
       }),
     );
-
-    // Check if a default StorageClass is set
-    this.backend.getDefaultStorageClass().subscribe(defaultClass => {
-      if (defaultClass.length === 0) {
-        this.defaultStorageclass = false;
-        this.popup.open(
-          $localize`No default Storage Class is set. Can't create new Disks for the new Notebook. Please use an Existing Disk.`,
-          SnackType.Warning,
-          0,
-        );
-      } else {
-        this.defaultStorageclass = true;
-      }
-    });
   }
 
   ngOnDestroy() {
@@ -133,19 +117,7 @@ export class FormNewComponent
     // Use the custom image instead
     if (notebook.customImageCheck) {
       notebook.image = notebook.customImage;
-    } else if (notebook.serverType === 'group-one') {
-      // Set notebook image from imageGroupOne
-      notebook.image = notebook.imageGroupOne;
-    } else if (notebook.serverType === 'group-two') {
-      // Set notebook image from imageGroupTwo
-      notebook.image = notebook.imageGroupTwo;
-    } else if (notebook.serverType === 'group-three') {
-      // Set notebook image from imageGroupThree
-      notebook.image = notebook.imageGroupThree;
-    }
-
-    // Set serverType for custom image
-    if (notebook.customImageCheck) {
+      // Set serverType for custom image
       if (notebook.image.match(/\/rstudio:/)) {
         notebook.serverType = 'group-one';
       } else if (notebook.image.match(/\/remote-desktop:/)) {
@@ -155,6 +127,15 @@ export class FormNewComponent
       } else {
         notebook.serverType = 'jupyter';
       }
+    } else if (notebook.serverType === 'group-one') {
+      // Set notebook image from imageGroupOne
+      notebook.image = notebook.imageGroupOne;
+    } else if (notebook.serverType === 'group-two') {
+      // Set notebook image from imageGroupTwo
+      notebook.image = notebook.imageGroupTwo;
+    } else if (notebook.serverType === 'group-three') {
+      // Set notebook image from imageGroupThree
+      notebook.image = notebook.imageGroupThree;
     }
 
     // Remove unnecessary images from the request sent to the backend

main.go

@@ -3,7 +3,6 @@ package main
 import (
 	"context"
 	"flag"
-	"io/ioutil"
 	"log"
 	"net/http"
 	"net/url"
@@ -88,7 +87,7 @@ func main() {
 	s := server{}
 
 	// Parse config
-	cfdata, err := ioutil.ReadFile(spawnerConfigPath)
+	cfdata, err := os.ReadFile(spawnerConfigPath)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -179,6 +178,17 @@ func main() {
 		},
 	}, s.GetNotebooks)).Methods("GET")
 
+	router.HandleFunc("/api/namespaces/{namespace}/notebooks/default", s.checkAccess(authorizationv1.SubjectAccessReview{
+		Spec: authorizationv1.SubjectAccessReviewSpec{
+			ResourceAttributes: &authorizationv1.ResourceAttributes{
+				Group:    kubeflowv1.SchemeGroupVersion.Group,
+				Verb:     "create",
+				Resource: "notebooks",
+				Version:  kubeflowv1.SchemeGroupVersion.Version,
+			},
+		},
+	}, s.NewDefaultNotebook)).Headers("Content-Type", "application/json").Methods("POST")
+
 	router.HandleFunc("/api/namespaces/{namespace}/notebooks", s.checkAccess(authorizationv1.SubjectAccessReview{
 		Spec: authorizationv1.SubjectAccessReviewSpec{
 			ResourceAttributes: &authorizationv1.ResourceAttributes{

notebooks.go

@@ -109,6 +109,7 @@ type newnotebookrequest struct {
 	ServerType         string            `json:"serverType"`
 	AffinityConfig     string            `json:"affinityConfig"`
 	TolerationGroup    string            `json:"tolerationGroup"`
+	DefaultNotebook    bool              `json:"defaultNotebook"`
 }
 
 type gpuresponse struct {
@@ -447,6 +448,131 @@ func (s *server) handleVolume(ctx context.Context, req volrequest, notebook *kub
 	return nil
 }
 
+// Sets default values to notebook request if missing
+func (s *server) createDefaultNotebook(namespace string) (newnotebookrequest, error) {
+	var notebook newnotebookrequest
+	notebookname := namespace + "-notebook"
+	cpuvalue, err := resource.ParseQuantity(s.Config.SpawnerFormDefaults.CPU.Value)
+	if err != nil {
+		return notebook, err
+	}
+
+	cpulimitvalue, err := resource.ParseQuantity(s.Config.SpawnerFormDefaults.CPU.LimitValue)
+	if err != nil {
+		return notebook, err
+	}
+
+	memoryvalue, err := resource.ParseQuantity(s.Config.SpawnerFormDefaults.Memory.Value + "Gi")
+	if err != nil {
+		return notebook, err
+	}
+
+	memorylimitvalue, err := resource.ParseQuantity(s.Config.SpawnerFormDefaults.Memory.LimitValue + "Gi")
+	if err != nil {
+		return notebook, err
+	}
+
+	size, err := resource.ParseQuantity(s.Config.SpawnerFormDefaults.WorkspaceVolume.Value.NewPvc.Spec.Resources.Requests.Storage)
+	if err != nil {
+		return notebook, err
+	}
+	workspacevolumename := notebookname + "-workspace"
+	workspaceVol := volrequest{
+		Mount: s.Config.SpawnerFormDefaults.WorkspaceVolume.Value.Mount,
+		NewPvc: NewPvc{
+			NewPvcMetadata: NewPvcMetadata{
+				Name: &workspacevolumename,
+			},
+			NewPvcSpec: NewPvcSpec{
+				Resources: Resources{
+					Requests: Requests{
+						Storage: size,
+					},
+				},
+				AccessModes:      s.Config.SpawnerFormDefaults.WorkspaceVolume.Value.NewPvc.Spec.AccessModes,
+				StorageClassName: "",
+			},
+		},
+	}
+
+	var datavols []volrequest
+	for _, volreq := range s.Config.SpawnerFormDefaults.DataVolumes.Value {
+		size, err := resource.ParseQuantity(s.Config.SpawnerFormDefaults.WorkspaceVolume.Value.NewPvc.Spec.Resources.Requests.Storage)
+		if err != nil {
+			return notebook, err
+		}
+		vol := volrequest{
+			Mount: volreq.Value.Mount,
+			NewPvc: NewPvc{
+				NewPvcMetadata: NewPvcMetadata{
+					Name: &volreq.Value.NewPvc.Metadata.Name,
+				},
+				NewPvcSpec: NewPvcSpec{
+					Resources: Resources{
+						Requests: Requests{
+							Storage: size,
+						},
+					},
+					AccessModes:      workspaceVol.NewPvc.NewPvcSpec.AccessModes,
+					StorageClassName: "",
+				},
+			},
+		}
+		datavols = append(datavols, vol)
+	}
+
+	notebook = newnotebookrequest{
+		Name:             notebookname,
+		Namespace:        namespace,
+		Image:            s.Config.SpawnerFormDefaults.Image.Value,
+		CustomImage:      "",
+		CustomImageCheck: false,
+		CPU:              cpuvalue,
+		CPULimit:         cpulimitvalue,
+		Memory:           memoryvalue,
+		MemoryLimit:      memorylimitvalue,
+		GPUs: gpurequest{
+			Quantity: s.Config.SpawnerFormDefaults.GPUs.Value.Num,
+			Vendor:   s.Config.SpawnerFormDefaults.GPUs.Value.Vendor,
+		},
+		NoWorkspace:        false,
+		Workspace:          workspaceVol,
+		DataVolumes:        datavols,
+		EnableSharedMemory: s.Config.SpawnerFormDefaults.Shm.Value,
+		Configurations:     s.Config.SpawnerFormDefaults.Configurations.Value,
+		Protb:              false,
+		Language:           "en",
+		ImagePullPolicy:    s.Config.SpawnerFormDefaults.ImagePullPolicy.Value,
+		ServerType:         "jupyter",
+		AffinityConfig:     s.Config.SpawnerFormDefaults.AffinityConfig.Value,
+		TolerationGroup:    s.Config.SpawnerFormDefaults.TolerationGroup.Value,
+		DefaultNotebook:    true,
+	}
+
+	return notebook, nil
+}
+
+func (s *server) NewDefaultNotebook(w http.ResponseWriter, r *http.Request) {
+	vars := mux.Vars(r)
+	namespace := vars["namespace"]
+
+	req, err := s.createDefaultNotebook(namespace)
+	if err != nil {
+		s.error(w, r, err)
+		return
+	}
+
+	newnotebook, err := json.Marshal(req)
+	if err != nil {
+		s.error(w, r, err)
+		return
+	}
+
+	r.Body = io.NopCloser(bytes.NewBuffer(newnotebook))
+
+	s.NewNotebook(w, r)
+}
+
 func (s *server) NewNotebook(w http.ResponseWriter, r *http.Request) {
 	vars := mux.Vars(r)
 	namespace := vars["namespace"]
@@ -469,8 +595,7 @@ func (s *server) NewNotebook(w http.ResponseWriter, r *http.Request) {
 	image := req.Image
 	if req.CustomImageCheck {
 		image = req.CustomImage
-	}
-	if s.Config.SpawnerFormDefaults.Image.ReadOnly {
+	} else if s.Config.SpawnerFormDefaults.Image.ReadOnly {
 		image = s.Config.SpawnerFormDefaults.Image.Value
 	}
 	image = strings.TrimSpace(image)
@@ -540,6 +665,11 @@ func (s *server) NewNotebook(w http.ResponseWriter, r *http.Request) {
 		notebook.ObjectMeta.Labels["notebook.statcan.gc.ca/protected-b"] = "true"
 	}
 
+	// AAW Customization Creating default notebook
+	if req.DefaultNotebook {
+		notebook.ObjectMeta.Labels["notebook.statcan.gc.ca/default-notebook"] = "true"
+	}
+
 	// Add configuration items
 	if s.Config.SpawnerFormDefaults.Configurations.ReadOnly {
 		for _, config := range s.Config.SpawnerFormDefaults.Configurations.Value {