Skip to content

Releases: DSD-DBS/capella-collab-manager

v3.2.4

17 May 10:15
ff32d5f
Compare
Choose a tag to compare

What's Changed

Bug fixes

Full Changelog: v3.2.3...v3.2.4

v3.2.3

16 May 08:23
f1bf7a6
Compare
Choose a tag to compare

What's Changed

Internal changes

Full Changelog: v3.2.2...v3.2.3

v3.2.2

10 May 09:25
0665eb5
Compare
Choose a tag to compare

What's Changed

Bug fixes

Under the hood

Full Changelog: v3.2.1...v3.2.2

v3.2.1

29 Apr 15:22
c3d93d9
Compare
Choose a tag to compare

What's Changed

Full Changelog: v3.2.0...v3.2.1

v3.2.0

29 Apr 12:56
23bcfa8
Compare
Choose a tag to compare

Breaking changes

  • This release is only compatible with Capella Docker images version >v2.0.0. Be sure to use the new v2.0.0 images as persistent images BEFORE upgrading to Capella Collaboration Manager v3.2.0. The read-only image should remain on the old version and will be automatically removed when you upgrade to Capella Collaboration Manager v3.2.0.
  • The internal registry in the values.yaml points to the Capella Collaboration Manager registry now (ghcr.io/dsd-dbs/capella-collab-manager). If you've manually overwritten the docker.registry.internal value, make sure to update it! It should point to a valid Docker registry where the backend, frontend, guacamole and session-preparation images can be pulled from.
  • Read-only images have been removed. Instead, models are loaded with a new provisioning system and mounted into the session container. The behavior is analogous to persistent workspace sessions, except that an empty workspace and the models are mounted.

What's Changed

With this release, read-only sessions start faster. Model loading is now part of the Collaboration Manager, making it possible to provide read-only sessions for more tools in the future.

You can also quickly request previously requested sessions:

Features

Bug fixes

Documentation

Development

Full Changelog: v3.1.0...v3.2.0

v3.1.0

22 Mar 16:03
47cda65
Compare
Choose a tag to compare

What's Changed

Features

Documentation

Internal changes

Full Changelog: v3.0.2...v3.1.0

v3.0.2

18 Mar 08:28
aebe3cd
Compare
Choose a tag to compare

What's Changed

Bug fixes

Full Changelog: v3.0.1...v3.0.2

v3.0.1

15 Mar 16:47
bce139e
Compare
Choose a tag to compare

What's Changed

Bug fixes

Development

  • build(deps-dev): bump capellambse from 0.5.47 to 0.5.51 in /backend by @dependabot in #1378
  • feat(backup): Remove connection method specific variables by @dominik003 in #1410
  • build(deps): bump actions/add-to-project from 0.5.0 to 0.6.0 by @dependabot in #1383

Full Changelog: v3.0.0...v3.0.1

v3.0.0

15 Mar 09:22
e4e0470
Compare
Choose a tag to compare

Overview

This release introduces a new yaml-based tool editor for administrators. The new tool editor doesn't only increase the configuration flexibility, it comes with general web-based tool support, custom resources, better extendibility, predefined environment variables, and different connection methods (#1355).

If a tool offers more than one connection method, the user can select the connection method when requesting a persistent or read-only session. Users of our Capella Docker images can benefit from the new connection method Xpra as alternative to Guacamole.

There were many changes under the hood. We've moved more code into session lifecycle hooks, replaced the Jupyter specific code with a general "http" connection method and removed the Guacamole code from the frontend.

If you're interested in extending the Collaboration Manager with a new tool, have a look at our new documentation page: Configuration of tools

Important notes

The release contains many breaking changes. Please review the changes before updating. The update doesn't cause a downtime and can be installed during daily operation. Running sessions are automatically migrated to the new version and are not interrupted. v3.0.0 of the Collaboration Manager is only compatible with >v1.18.0 of Capella Docker images. Make sure to update the Docker image version before you start the Collaboration Manager update!

Breaking changes

For users

  • Project leads can no longer see the session overview. It's reserved to admins from now on.
  • It's no longer possible to spawn multiple read-only sessions with the same tool/version. In the future, it will be possible to load a read-only session with models from different projects.
  • Until a proper locking mechanism or support for multiple workspaces is implemented, we no longer restrict that a users runs multiple different Eclipse-based sessions at a time. Instead, Eclipse will print an error message in the session. Previously, we assumed that the session is Eclipse-based if it was not Jupyter. This is no longer possible due to the removal of the specific Jupyter implementation.

For developers

  • The "/sessions/{session_id}/guacamole-tokens" route was removed completely. The route provided the URL to Guacamole and the Guacamole token. The URL is now provided in the GetSessionsResponse as redirect_url to make it consistent with other connection methods. The token is now passed as value of the GUAC_AUTH key in the local_storage dict of SessionConnectionInformation, which is the return type of the new route GET /sessions/{session_id}/connection.
  • The return type of all session hooks has changed. Instead of a tuple, a typed dict is now returned. This makes backwards compatibility for future updates easier and adds partial returns (not all attributes of the tuple have to be returned).
  • The following attributes were removed from the GetSessionsResponse: jupyter_uri (replaced with redirect_url), guacamole_username (not exposed anymore, but saved in the database in the config column) and guacamole_connection_id (not exposed anymore, but saved in the database in the config column).
  • The POST /sessions/persistent and POST /projects/<slug>/sessions/read-only routes were merged into POST /sessions. Have a look in the API documentation for the updated interface.
  • The local development environment works with HTTPS now, reachable via https://localhost:443. It can be used to test the compatibility of sessions with TLS edge termination. The development cluster has to be recreated with delete-cluster and create-cluster.
  • The extensions.jupyter configuration option was removed, there is no specific public URI for Jupyter anymore. In the local development setup, it has to be removed manually.

Notable changes

For users

  • During each session start (persistent or read-only), the user can select a connection method if more than connection method is available for the tool.
  • The "Request a session with a persistent workspace" button is now disabled during an active request to avoid accidental creation of multiple sessions.
  • The "Request session" button in the read-only dialog is now disabled if no model is selected.
  • The "Request a persistent session" button was renamed to "Request a session with a persistent workspace".
  • It's possible to open multiple Xpra-based sessions side-by-side in the internal session viewer (e.g. a Capella read-only and persistent session):

  • A troubleshooting section for long session request times was added to the documentation by @MoritzWeber0 in #1397

For administrators

  • There is significantly more flexibility in defining tools: It's possible to define environment variables, use new pre-defined variables, define cookies for tools, define the exposed ports in the container and create own connection methods.
  • There is now general web-based tool support, which means that admins can integrate other web-based tools.
  • TeamForCapella metrics about the license usage are available in a new pre-provisioned dashboard in #1387, #1391, #1394 and #1395.

For developers

  • Two new session hooks fetch_session_hook and session_connection_hook have been introduced. The fetch_session_hook is executed during fetching of each session (in the GET session routes and after session creation). The session_connection_hook is executed when a user connects to a session (when the new route GET /sessions/<id>/connection is called).
  • The post_session_creation_hook can now return information on what to store in the frontend local storage.
  • Session environment variables can be defined per tool in a flexible way using Pythons format syntax. The existing Jupyter environment variables were migrated to the new format.
  • All references to Guacamole except the Guacamole status in the Monitoring view are removed from the frontend.
  • All Jupyter specific code is removed from the frontend and was replaced with general web-based implementation.
  • Guacamole related actions were removed to the Guacamole session hook.
  • The read-only sessions have no reference to specific projects anymore, allowing to load models from different projects in one session (only via the API currently, not in the frontend).
  • The /api/v1/users/current/tokens endpoint uses a date instead datetime as expiration_date.

Small changes

Read more

v2.26.0

09 Feb 13:41
d6d256e
Compare
Choose a tag to compare

Breaking changes

The metadata configuration via the values.yaml was removed. Instead, the configuration can be set via an interactive YAML editor in the frontend. To update the configuration, navigate to "Menu" -> "Settings" -> "Configuration":
image

Notable changes

Our API documentation is live! Learn more about the API documentation in the new section of our documentation.
In addition, we removed many legacy components in the frontend as part of this update. This can lead to some smaller changes in the frontend UI. We've tried to keep the changes as small as possible.

Full changelog

Features

Bug fixes

Documentation

Development

Dependency updates

Full Changelog: v2.25.1...v2.26.0