Jupyter notebook support

.gitignore

@@ -1,6 +1,7 @@
 # SPDX-FileCopyrightText: Copyright DB Netz AG and the capella-collab-manager contributors
 # SPDX-License-Identifier: CC0-1.0
 
+logs/
 .venv*
 /.provision-backend
 /.provision-guacamole

CONTRIBUTING.md

@@ -185,7 +185,6 @@ To create an upgrade script automatically (this will compare the current databas
 with the models):
 
 ```sh
-cd capellacollab
 alembic revision --autogenerate -m "Commit message"
 ```
 

Makefile

@@ -11,9 +11,9 @@ SESSION_NAMESPACE = collab-sessions
 PORT ?= 8080
 
 # List of Capella versions, e.g.: `5.0.0 5.2.0 6.0.0`
-CAPELLA_VERSIONS ?= 5.2.0
+CAPELLA_VERSIONS ?= 6.0.0
 # List of T4C versions, e.g., `5.2.0 6.0.0`
-T4C_CLIENT_VERSIONS ?= 5.2.0
+T4C_CLIENT_VERSIONS ?= 6.0.0
 
 TIMEOUT ?= 10m
 
@@ -29,7 +29,7 @@ export DOCKER_BUILDKIT=1
 SHELL = /bin/bash
 .SHELLFLAGS = -euo pipefail -c
 
-build: backend frontend docs guacamole
+build: backend frontend docs guacamole jupyter
 
 backend: IMAGE=capella/collab/backend
 backend:
@@ -54,6 +54,9 @@ capella:
 t4c-client:
 	$(CAPELLA_DOCKERIMAGES) CAPELLA_VERSIONS="$(T4C_CLIENT_VERSIONS)" t4c/client/remote t4c/client/backup
 
+jupyter:
+	$(CAPELLA_DOCKERIMAGES) jupyter-notebook
+
 docs:
 	docker build -t capella/collab/docs -t $(LOCAL_REGISTRY_NAME):$(REGISTRY_PORT)/capella/collab/docs docs/user
 	docker push $(LOCAL_REGISTRY_NAME):$(REGISTRY_PORT)/capella/collab/docs

backend/capellacollab/alembic/versions/61d36288afe9_define_jupyter_as_integration.py

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: Copyright DB Netz AG and the capella-collab-manager contributors
+# SPDX-License-Identifier: Apache-2.0
+
+"""Define Jupyter as integration
+
+Revision ID: 61d36288afe9
+Revises: f3d2dedd7906
+Create Date: 2023-02-09 11:57:07.345877
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "61d36288afe9"
+down_revision = "f3d2dedd7906"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.add_column(
+        "tool_integrations",
+        sa.Column(
+            "jupyter", sa.Boolean(), nullable=False, server_default="false"
+        ),
+    )
+
+
+def downgrade():
+    op.drop_column("tool_integrations", "jupyter")

backend/capellacollab/alembic/versions/f3d2dedd7906_add_jupyter_token_column.py

@@ -0,0 +1,28 @@
+# SPDX-FileCopyrightText: Copyright DB Netz AG and the capella-collab-manager contributors
+# SPDX-License-Identifier: Apache-2.0
+
+"""Commit message
+
+Revision ID: f3d2dedd7906
+Revises: 4df9c82766e2
+Create Date: 2023-02-03 14:31:55.776520
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "f3d2dedd7906"
+down_revision = "f7c1a89af5d7"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.add_column(
+        "sessions", sa.Column("jupyter_token", sa.String(), nullable=True)
+    )
+
+
+def downgrade():
+    op.drop_column("sessions", "jupyter_token")

backend/capellacollab/config/config_schema.yaml

@@ -121,6 +121,14 @@ properties:
             type: string
           password:
             type: string
+      jupyter:
+        type: object
+        additionalProperties: false
+        required:
+          - publicURI
+        properties:
+          publicURI:
+            type: string
   authentication:
     type: object
     required:

backend/capellacollab/core/database/migration.py

@@ -33,6 +33,8 @@
 )
 from capellacollab.tools import crud as tools_crud
 from capellacollab.tools import models as tools_models
+from capellacollab.tools.integrations import crud as integrations_crud
+from capellacollab.tools.integrations import models as integrations_models
 from capellacollab.users import crud as users_crud
 from capellacollab.users import models as users_models
 from capellacollab.users.events import crud as events_crud
@@ -109,6 +111,16 @@ def create_tools(db):
     )
     tools_crud.create_tool(db, capella)
     tools_crud.create_tool(db, papyrus)
+    jupyter = tools_models.Tool(
+        name="Jupyter",
+        docker_image_template=f"{registry}/jupyter-notebook:$version",
+    )
+    tools_crud.create_tool(db, jupyter)
+    integrations_crud.update_integrations(
+        db,
+        jupyter.integrations,
+        integrations_models.PatchToolIntegrations(jupyter=True),
+    )
 
     default_version = tools_crud.create_version(db, capella.id, "6.0.0", True)
     tools_crud.create_version(db, capella.id, "5.2.0")
@@ -117,6 +129,8 @@ def create_tools(db):
     tools_crud.create_version(db, papyrus.id, "6.1")
     tools_crud.create_version(db, papyrus.id, "6.0")
 
+    tools_crud.create_version(db, jupyter.id, "python-3.11")
+
     default_nature = tools_crud.create_nature(db, capella.id, "model")
     tools_crud.create_nature(db, capella.id, "library")
 

backend/capellacollab/sessions/models.py

@@ -37,6 +37,7 @@ class DatabaseSession(Base):
     guacamole_username: str = sa.Column(sa.String)
     guacamole_password: str = sa.Column(sa.String)
     guacamole_connection_id: str = sa.Column(sa.String)
+    jupyter_token: str = sa.Column(sa.String)
     host: str = sa.Column(sa.String)
     type: WorkspaceType = sa.Column(sa.Enum(WorkspaceType), nullable=False)
     project_id: str = sa.Column(