Feat/image builder api

components/renku_data_services/notebooks/api/classes/k8s_client.py

@@ -467,7 +467,6 @@ async def get_server(self, name: str, safe_username: str) -> _SessionType | None
 
         If the request to the cache fails, fallback to the k8s API.
         """
-        server = None
         try:
             server = await self.cache.get_server(name)
         except CacheError:

components/renku_data_services/session/api.spec.yaml

@@ -274,6 +274,10 @@ components:
           $ref: "#/components/schemas/Description"
         container_image:
           $ref: "#/components/schemas/ContainerImage"
+        build_parameter:
+          $ref: "#/components/schemas/BuildParameter"
+        environment_image_source:
+          $ref: "#/components/schemas/EnvironmentImageSource"
         default_url:
           $ref: "#/components/schemas/DefaultUrl"
         uid:
@@ -301,19 +305,7 @@ components:
         - uid
         - gid
         - default_url
-      example:
-        id: 01AN4Z79ZS6XX96588FDX0H099
-        name: JupyterLab environment
-        creation_date: "2023-11-01T17:32:28Z"
-        description: JupyterLab session environment
-        container_image: renku-jupyter:latest
-        default_url: "/lab"
-        port: 8080
-        working_directory: /home/jovyan/work
-        mount_directory: /home/jovyan/work
-        uid: 1000
-        gid: 1000
-        is_archive: false
+        - environment_image_source
     EnvironmentGetInLauncher:
       allOf:
         - $ref: "#/components/schemas/Environment"
@@ -323,19 +315,10 @@ components:
               $ref: "#/components/schemas/EnvironmentKind"
           required:
             - environment_kind
-          example:
-            environment_kind: global_environment
     EnvironmentPostInLauncher:
-      allOf:
+      oneOf:
         - $ref: "#/components/schemas/EnvironmentPost"
-        - type: object
-          properties:
-            environment_kind:
-              $ref: "#/components/schemas/EnvironmentKind"
-          required:
-            - environment_kind
-          example:
-            environment_kind: global_environment
+        - $ref: "#/components/schemas/BuildParameterPost"
     EnvironmentPost:
       description: Data required to create a session environment
       type: object
@@ -377,9 +360,15 @@ components:
         is_archived:
           $ref: "#/components/schemas/IsArchived"
           default: false
+        environment_image_source:
+          description: Source of the environment
+          type: string
+          enum:
+            - image
       required:
         - name
         - container_image
+        - environment_image_source
     EnvironmentPatchInLauncher:
       allOf:
         - $ref: "#/components/schemas/EnvironmentPatch"
@@ -416,6 +405,10 @@ components:
           $ref: "#/components/schemas/EnvironmentArgs"
         is_archived:
           $ref: "#/components/schemas/IsArchived"
+        build_parameter:
+          $ref: "#/components/schemas/BuildParameter"
+        environment_image_source:
+          $ref: "#/components/schemas/EnvironmentImageSource"
     SessionLaunchersList:
       description: A list of Renku session launchers
       type: array
@@ -506,6 +499,19 @@ components:
       minLength: 1
       maxLength: 99
       example: My Renku Session :)
+    BuilderVariant:
+      description: Type of virtual environment manager when building custom environments.
+      type: string
+      enum:
+        - conda
+        - pip
+    FrontendVariant:
+      description: User's Frontend Choice.
+      type: string
+      enum:
+        - vscodium
+        - jupyterlab
+        - streamlit
     EnvironmentIdOnlyPatch:
       type: object
       properties:
@@ -519,12 +525,17 @@ components:
       required:
         - id
     EnvironmentKind:
-      description: Kind of environment to use
+      description: Kind of the environment
+      type: string
+      enum:
+        - global
+        - custom
+    EnvironmentImageSource:
+      description: Source of the environment's image
       type: string
       enum:
-        - GLOBAL
-        - CUSTOM
-      example: CUSTOM
+        - image
+        - build
     EnvironmentId:
       description: Id of the environment to use
       type: string
@@ -539,6 +550,48 @@ components:
       description: A description for the resource
       type: string
       maxLength: 500
+    BuildParameter:
+      description: A build parameter
+      type: object
+      additionalProperties: false
+      properties:
+        repository:
+          $ref: "#/components/schemas/Repository"
+        revision:
+          $ref: "#/components/schemas/Revision"
+        subdir:
+          $ref: "#/components/schemas/SubDir"
+        builder_variant:
+          $ref: "#/components/schemas/BuilderVariant"
+        frontend_variant:
+          $ref: "#/components/schemas/FrontendVariant"
+      required:
+        - repository
+        - builder_variant
+        - frontend_variant
+    BuildParameterPost:
+      description: Data required to create a build parameter
+      type: object
+      properties:
+        repository:
+          $ref: "#/components/schemas/Repository"
+        revision:
+          $ref: "#/components/schemas/Revision"
+        subdir:
+          $ref: "#/components/schemas/SubDir"
+        builder_variant:
+          $ref: "#/components/schemas/BuilderVariant"
+        frontend_variant:
+          $ref: "#/components/schemas/FrontendVariant"
+        environment_image_source:
+          type: string
+          enum:
+            - build
+      required:
+        - repository
+        - builder_variant
+        - frontend_variant
+        - environment_image_source
     ContainerImage:
       description: A container image
       type: string
@@ -547,6 +600,19 @@ components:
       # based on https://github.com/opencontainers/distribution-spec/blob/main/spec.md
       pattern: "^[a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*(\\/[a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*)*(:[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}|@sha256:[a-fA-F0-9]{64}){0,1}$"
       example: renku/renkulab-py:3.10-0.18.1
+    Repository:
+      description: The repository used as a basis for a custom builder
+      type: string
+      maxLength: 500
+      example: "https://github.com/voila-gallery/gaussian-density"
+    Revision:
+      description: The revision of the repository used as a basis for a custom builder
+      type: string
+      maxLength: 100
+    SubDir:
+      description: The sub directory of the repository used as a basis for a custom builder
+      type: string
+      minLength: 1
     DefaultUrl:
       description: The default path to open in a session
       type: string
@@ -596,7 +662,9 @@ components:
       example: "/home/jovyan/work"
     EnvironmentMountDirectory:
       type: string
-      description: The location where the persistent storage for the session will be mounted, usually it should be identical to or a parent of the working directory, if left unset will default to the working directory.
+      description:
+        The location where the persistent storage for the session will be mounted, usually it should be identical to or
+        a parent of the working directory, if left unset will default to the working directory.
       minLength: 1
       example: "/home/jovyan/work"
     EnvironmentMountDirectoryPatch: