Merge pull request #12 from NetApp/sufian-mount-pvc

K8s - Create JupyterLab - Add Option to Mount PVC

Author: mboglesby

netapp_dataops_k8s/netapp_dataops/k8s/__init__.py

@@ -4,7 +4,7 @@
 by applications using the import method of utilizing the toolkit.
 """
 
-__version__ = "2.1.1"
+__version__ = "2.2.0beta1"
 
 import base64
 from datetime import datetime
@@ -609,7 +609,8 @@ def clone_volume(new_pvc_name: str, source_pvc_name: str, source_snapshot_name:
         print("Volume successfully cloned.")
 
 
-def create_jupyter_lab(workspace_name: str, workspace_size: str, storage_class: str = None, load_balancer_service: bool = False, namespace: str = "default",
+def create_jupyter_lab(workspace_name: str, workspace_size: str, mount_pvc: str = None, storage_class: str = None,
+                       load_balancer_service: bool = False, namespace: str = "default",
                        workspace_password: str = None, workspace_image: str = "jupyter/tensorflow-notebook",
                        request_cpu: str = None, request_memory: str = None, request_nvidia_gpu: str = None, register_with_astra: bool = False,
                        print_output: bool = False, pvc_already_exists: bool = False, labels: dict = None) -> str:
@@ -779,6 +780,34 @@ def create_jupyter_lab(workspace_name: str, workspace_size: str, storage_class:
         )
     )
 
+    # Mount Additional pvc if needed
+    if mount_pvc:
+
+        divider_index = mount_pvc.find(":")
+        user_pvc_name = mount_pvc[:divider_index]
+        user_pvc_mountpoint = mount_pvc[divider_index+1:]
+
+        if print_output:
+            print("\nAttaching Additional PVC: '" + user_pvc_name + "' at mount_path: '" + user_pvc_mountpoint + "'.")
+            
+        # Add user-specified PVC
+        deployment.spec.template.spec.volumes.append(
+            client.V1Volume(
+                name="uservol",
+                persistent_volume_claim={
+                    "claimName": user_pvc_name
+                    }
+                )
+            )
+
+        # Add mountpoint for user-specified PVC
+        deployment.spec.template.spec.containers[0].volume_mounts.append(
+            client.V1VolumeMount(
+                name="uservol",
+                mount_path=user_pvc_mountpoint
+                )
+            )
+
     # Apply resource requests
     if request_cpu:
         deployment.spec.template.spec.containers[0].resources["requests"]["cpu"] = request_cpu

netapp_dataops_k8s/netapp_dataops/netapp_dataops_k8s_cli.py

@@ -102,7 +102,7 @@
 \t-b, --load-balancer\t\tOption to use a LoadBalancer instead of using NodePort service. If not specified, NodePort service will be utilized.
 
 Examples:
-\tnetapp_dataops_k8s_cli.py clone jupyterlab --new-workspace-name=project1-experiment1 --source-workspace-name=project1 --nvidia-gpu=1 
+\tnetapp_dataops_k8s_cli.py clone jupyterlab --new-workspace-name=project1-experiment1 --source-workspace-name=project1 --nvidia-gpu=1
 \tnetapp_dataops_k8s_cli.py clone jupyterlab -w project2-mike -s project2-snap1 -n team1 -g 1 -p 0.5 -m 1Gi -b
 '''
 helpTextCloneToNewNsJupyterLab = '''
@@ -165,6 +165,7 @@
 \t-p, --cpu=\t\t\tNumber of CPUs to reserve for JupyterLab workspace. Format: '0.5', '1', etc. If not specified, no CPUs will be reserved.
 \t-b, --load-balancer\t\tOption to use a LoadBalancer instead of using NodePort service. If not specified, NodePort service will be utilized.
 \t-a, --register-with-astra\tRegister new workspace with Astra Control (requires Astra Control).
+\t-v, --mount-pvc\t\t\tOption to attach an additional existing PVC that can be mounted at a spefic path whithin the container. Format: -v/--mount-pvc=existing_pvc_name:mount_point. If not specified, no additional PVC will be attached.
 
 Examples:
 \tnetapp_dataops_k8s_cli.py create jupyterlab --workspace-name=mike --size=10Gi --nvidia-gpu=2
@@ -739,12 +740,13 @@ def getTarget(args: list) -> str:
             requestCpu = None
             register_with_astra = False
             load_balancer_service = False
+            mount_pvc = None
 
             # Get command line options
             try:
-                opts, args = getopt.getopt(sys.argv[3:], "hw:s:n:c:i:g:m:p:ab",
+                opts, args = getopt.getopt(sys.argv[3:], "hw:s:n:c:i:g:m:p:abv:",
                                            ["help", "workspace-name=", "size=", "namespace=", "storage-class=",
-                                            "image=", "nvidia-gpu=", "memory=", "cpu=", "register-with-astra", "load-balancer"])
+                                            "image=", "nvidia-gpu=", "memory=", "cpu=", "register-with-astra", "load-balancer", "mount-pvc="])
             except:
                 handleInvalidCommand(helpText=helpTextCreateJupyterLab, invalidOptArg=True)
 
@@ -773,7 +775,8 @@ def getTarget(args: list) -> str:
                     register_with_astra = True
                 elif opt in ("-b", "--load-balancer"):
                     load_balancer_service = True
-
+                elif opt in ("-v", "--mount-pvc"):
+                    mount_pvc = arg
 
             # Check for required options
             if not workspaceName or not workspaceSize:
@@ -782,7 +785,7 @@ def getTarget(args: list) -> str:
             # Create JupyterLab workspace
             try:
                 create_jupyter_lab(workspace_name=workspaceName, workspace_size=workspaceSize, storage_class=storageClass,
-                                   load_balancer_service=load_balancer_service, namespace=namespace, workspace_image=workspaceImage, request_cpu=requestCpu,
+                                   load_balancer_service=load_balancer_service, namespace=namespace, workspace_image=workspaceImage, request_cpu=requestCpu, mount_pvc=mount_pvc,
                                    request_memory=requestMemory, request_nvidia_gpu=requestNvidiaGpu, register_with_astra=register_with_astra, print_output=True)
             except (InvalidConfigError, APIConnectionError):
                 sys.exit(1)