mathew updates 5

Signed-off-by: Mathew Wicks <[email protected]>
kubeflow · Jul 15, 2024 · 27d03c4 · 27d03c4
1 parent 7b7a6bb
commit 27d03c4
Show file tree

Hide file tree

Showing 7 changed files with 162 additions and 57 deletions.
diff --git a/workspaces/controller/api/v1beta1/workspacekind_types.go b/workspaces/controller/api/v1beta1/workspacekind_types.go
@@ -120,8 +120,8 @@ type WorkspaceKindPodTemplate struct {
 	HTTPProxy *HTTPProxy `json:"httpProxy,omitempty"`
 
 	// environment variables for Workspace Pods (MUTABLE)
-	//  - the following string templates are available:
-	//     - `.PathPrefix`: the path prefix of the Workspace (e.g. '/workspace/{profile_name}/{workspace_name}/')
+	//  - the following go template functions are available:
+	//     - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port
 	//+kubebuilder:validation:Optional
 	//+listType:="map"
 	//+listMapKey:="name"
@@ -336,23 +336,31 @@ type ImageConfigSpec struct {
 	//     in a dropdown menu on the Workspace overview page
 	//+kubebuilder:validation:MinItems:=1
 	//+listType:="map"
-	//+listMapKey:="port"
+	//+listMapKey:="id"
 	Ports []ImagePort `json:"ports"`
 }
 
 type ImagePort struct {
-	// the display name of the port
-	//+kubebuilder:validation:MinLength:=2
-	//+kubebuilder:validation:MaxLength:=64
-	//+kubebuilder:example:="JupyterLab"
-	DisplayName string `json:"displayName"`
+	// the id of the port
+	//  - this is NOT used as the Container or Service port name, but as part of the HTTP path
+	//+kubebuilder:validation:MinLength:=1
+	//+kubebuilder:validation:MaxLength:=32
+	//+kubebuilder:validation:Pattern:=^[a-z0-9][a-z0-9_-]*[a-z0-9]$
+	//+kubebuilder:example="jupyterlab"
+	Id string `json:"id"`
 
 	// the port number
 	//+kubebuilder:validation:Minimum:=1
 	//+kubebuilder:validation:Maximum:=65535
 	//+kubebuilder:example:=8888
 	Port int32 `json:"port"`
 
+	// the display name of the port
+	//+kubebuilder:validation:MinLength:=2
+	//+kubebuilder:validation:MaxLength:=64
+	//+kubebuilder:example:="JupyterLab"
+	DisplayName string `json:"displayName"`
+
 	// the protocol of the port
 	//+kubebuilder:example:="HTTP"
 	Protocol ImagePortProtocol `json:"protocol"`

diff --git a/workspaces/controller/config/crd/bases/kubeflow.org_workspacekinds.yaml b/workspaces/controller/config/crd/bases/kubeflow.org_workspacekinds.yaml
@@ -288,8 +288,8 @@ spec:
                   extraEnv:
                     description: |-
                       environment variables for Workspace Pods (MUTABLE)
-                       - the following string templates are available:
-                          - `.PathPrefix`: the path prefix of the Workspace (e.g. '/workspace/{profile_name}/{workspace_name}/')
+                       - the following go template functions are available:
+                          - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port
                     items:
                       description: EnvVar represents an environment variable present
                         in a Container.
@@ -2323,6 +2323,15 @@ spec:
                                             maxLength: 64
                                             minLength: 2
                                             type: string
+                                          id:
+                                            description: |-
+                                              the id of the port
+                                               - this is NOT used as the Container or Service port name, but as part of the HTTP path
+                                            example: jupyterlab
+                                            maxLength: 32
+                                            minLength: 1
+                                            pattern: ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
+                                            type: string
                                           port:
                                             description: the port number
                                             example: 8888
@@ -2338,13 +2347,14 @@ spec:
                                             type: string
                                         required:
                                         - displayName
+                                        - id
                                         - port
                                         - protocol
                                         type: object
                                       minItems: 1
                                       type: array
                                       x-kubernetes-list-map-keys:
-                                      - port
+                                      - id
                                       x-kubernetes-list-type: map
                                   required:
                                   - image

diff --git a/workspaces/controller/config/samples/v1beta1_workspacekind.yaml b/workspaces/controller/config/samples/v1beta1_workspacekind.yaml
@@ -149,15 +149,16 @@ spec:
     ## environment variables for Workspace Pods (MUTABLE)
     ##  - spec for EnvVar:
     ##    https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#envvar-v1-core
-    ##  - the following string templates are available:
-    ##      - `.PathPrefix`: the path prefix of the Workspace (e.g. '/workspace/{profile_name}/{workspace_name}/')
+    ##  - the following go template functions are available:
+    ##      - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port
     ##
     extraEnv:
 
       ## to enable backwards compatibility with old Jupyter images from Kubeflow Notebooks V1
       ## https://github.com/kubeflow/kubeflow/blob/v1.8.0/components/example-notebook-servers/jupyter/s6/services.d/jupyterlab/run#L12
       - name: "NB_PREFIX"
-        value: "{{ .PathPrefix }}"
+        value: |-
+          {{ httpPathPrefix "juptyerlab" }}
 
     ## extra volume mounts for Workspace Pods (MUTABLE)
     ##  - spec for VolumeMount:
@@ -267,7 +268,8 @@ spec:
               ##    in a dropdown menu on the Workspace overview page
               ##
               ports:
-                - displayName: "JupyterLab"
+                - id: "jupyterlab"
+                  displayName: "JupyterLab"
                   port: 8888
                   protocol: "HTTP"
 
@@ -285,7 +287,8 @@ spec:
               image: "docker.io/kubeflownotebookswg/jupyter-scipy:v1.9.0"
               imagePullPolicy: "IfNotPresent"
               ports:
-                - displayName: "JupyterLab"
+                - id: "jupyterlab"
+                  displayName: "JupyterLab"
                   port: 8888
                   protocol: "HTTP"
 

diff --git a/workspaces/controller/internal/controller/suite_test.go b/workspaces/controller/internal/controller/suite_test.go
@@ -221,7 +221,7 @@ func NewExampleWorkspaceKind1(name string) *kubefloworgv1beta1.WorkspaceKind {
 				ExtraEnv: []v1.EnvVar{
 					{
 						Name:  "NB_PREFIX",
-						Value: "{{ .PathPrefix }}",
+						Value: `{{ httpPathPrefix "jupyterlab" }}`,
 					},
 				},
 				ExtraVolumeMounts: []v1.VolumeMount{
@@ -278,6 +278,7 @@ func NewExampleWorkspaceKind1(name string) *kubefloworgv1beta1.WorkspaceKind {
 									Image: "docker.io/kubeflownotebookswg/jupyter-scipy:v1.8.0",
 									Ports: []kubefloworgv1beta1.ImagePort{
 										{
+											Id:          "jupyterlab",
 											DisplayName: "JupyterLab",
 											Port:        8888,
 											Protocol:    "HTTP",
@@ -301,6 +302,7 @@ func NewExampleWorkspaceKind1(name string) *kubefloworgv1beta1.WorkspaceKind {
 									Image: "docker.io/kubeflownotebookswg/jupyter-scipy:v1.9.0",
 									Ports: []kubefloworgv1beta1.ImagePort{
 										{
+											Id:          "jupyterlab",
 											DisplayName: "JupyterLab",
 											Port:        8888,
 											Protocol:    "HTTP",