feat: Add support for provisioning of tool models #1901

MoritzWeber0 · 2024-10-11T16:07:06Z

The already known provisioning feature for read-only sessions will be extended to persistent workspace sessions.

Per session, a user can request a persistent workspace session and can pass optionally one model to provision. It's not possible to provision more than one model (aka one Git repository).

The provisioning takes place once. We'll not touch the provisioned workspace until the user explicently resets the provisioning. The provisioning revision and date are stored in the database.

When the users reset their workspace, we'll remove the provisioning model from the database. During the next session start, the matching workspace will be re-initialized and a copy will be saved to a .bak directory.

This feature is essential for the start-up of trainings.

TODO:

github-actions · 2024-10-11T16:08:09Z

The generated OpenAPI client is not up to date with the latest changes in the OpenAPI specification.
Please run make openapi locally and commit the changes.

github-actions · 2024-10-11T16:08:26Z

API Changelog 4.13.1.dev60+gc2898fa5

GET /api/v1/projects/{project_slug}/models

added the required property '/items/tool/config/provisioning/required' to the response with the '200' status

POST /api/v1/projects/{project_slug}/models

added the required property 'tool/config/provisioning/required' to the response with the '200' status

GET /api/v1/projects/{project_slug}/models/{model_slug}

added the required property 'tool/config/provisioning/required' to the response with the '200' status

PATCH /api/v1/projects/{project_slug}/models/{model_slug}

added the required property 'tool/config/provisioning/required' to the response with the '200' status

DELETE /api/v1/projects/{project_slug}/models/{model_slug}/provisioning

endpoint added

GET /api/v1/projects/{project_slug}/models/{model_slug}/provisioning

endpoint added

GET /api/v1/projects/{project_slug}/models/{model_slug}/readme

endpoint added

GET /api/v1/projects/{project_slug}/tools

endpoint added

POST /api/v1/projects/{project_slug}/tools

endpoint added

DELETE /api/v1/projects/{project_slug}/tools/{project_tool_id}

endpoint added

GET /api/v1/sessions

added the required property '/items/version/tool/config/provisioning/required' to the response with the '200' status

POST /api/v1/sessions

⚠️ the 'connection_method_id' request property type/format changed from 'string'/'' to ''/''
⚠️ the 'provisioning/items/revision' request property type/format changed from 'string'/'' to ''/''
added the new optional request property 'project_slug'
added 'subschema 1, subschema 2' to the 'connection_method_id' request property 'anyOf' list
added 'subschema 1, subschema 2' to the 'provisioning/items/revision' request property 'anyOf' list
the request property 'connection_method_id' became optional
the request property 'provisioning/items/revision' became optional
added the required property 'version/tool/config/provisioning/required' to the response with the '200' status

GET /api/v1/sessions/{session_id}

added the required property 'version/tool/config/provisioning/required' to the response with the '200' status

GET /api/v1/tools

added the required property '/items/config/provisioning/required' to the response with the '200' status

POST /api/v1/tools

added the new optional request property 'config/provisioning/required'
added the required property 'config/provisioning/required' to the response with the '200' status

GET /api/v1/tools/*/versions

added the required property '/items/tool/config/provisioning/required' to the response with the '200' status

GET /api/v1/tools/default

added the required property 'config/provisioning/required' to the response with the '200' status

GET /api/v1/tools/{tool_id}

added the required property 'config/provisioning/required' to the response with the '200' status

PUT /api/v1/tools/{tool_id}

added the new optional request property 'config/provisioning/required'
added the required property 'config/provisioning/required' to the response with the '200' status

GET /api/v1/users/{user_id}/sessions

added the required property '/items/version/tool/config/provisioning/required' to the response with the '200' status

github-actions · 2024-10-22T11:56:58Z

A Storybook preview is available for commit c2898fa.
➡️ View Storybook
➡️ View Chromatic build

frontend/src/app/projects/project-detail/training-details/training-details.component.html

...end/src/app/projects/project-detail/create-project-tools/create-project-tools.component.html

...wrapper/create-sessions/create-provisioned-session/create-provisioned-session.component.html

frontend/src/app/projects/project-detail/project-details.component.html

The already known provisioning feature for read-only sessions will be extended to persistent workspace sessions. Per session, a user can request a persistent workspace session and can pass optionally one model to provision. It's not possible to provision more than one model (aka one Git repository). The provisioning takes place once. We'll not touch the provisioned workspace until the user explicently resets the provisioning. The provisioning revision and date are stored in the database. When the users reset their workspace, we'll remove the provisioning model from the database. During the next session start, the matching workspace will be re-initialized and a copy will be saved to a `.bak` directory. This feature is essential for the start-up of trainings.

sonarcloud · 2024-11-19T11:15:59Z

Quality Gate passed

Issues
10 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2024-11-19T11:22:52Z

ArtifactName: `reg`

Failed to find a target artifact.
All items will be treated as new items and will be used as expected data for the next time.

item	count
new	412

This was linked to issues Oct 11, 2024

Initialize training setup, spawn related sessions #1004

Closed

Reset a pre-provisioned workspace #1823

Closed