From 5b35b93d13549164575bbe925108a9528a62cd1b Mon Sep 17 00:00:00 2001 From: MoritzWeber Date: Fri, 16 Aug 2024 11:41:36 +0200 Subject: [PATCH] docs: Improve TeamForCapella model migration docs --- docs/docs/admin/teamforcapella/migration.md | 28 ++++++++++++++++----- 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/docs/admin/teamforcapella/migration.md b/docs/docs/admin/teamforcapella/migration.md index b0ba1f142d..a192bcb3a6 100644 --- a/docs/docs/admin/teamforcapella/migration.md +++ b/docs/docs/admin/teamforcapella/migration.md @@ -3,21 +3,26 @@ ~ SPDX-License-Identifier: Apache-2.0 --> -# How to Update a Capella Model to a Higher Version (in TeamForCapella) +# How to Migrate a Capella Model to a Higher Version (in TeamForCapella) !!! warning - Please create backups (e.g., in a Git repository) before you start the update process. A downgrade of Capella models is not possible. 1. Open a new persistent session with the old Capella version. +1. Check that nobody is connected to the remote repository: + [See who is connected to a TeamForCapella repository](../../user/tools/capella/teamforcapella/connect/index.md) +1. Run a backup pipeline and verify that the latest changes are included in + the Git repository. 1. Import the model from the TeamForCapella server via the Import wizard from TeamForCapella into your local workspace: [Import a model from TeamForCapella](../../user/tools/capella/teamforcapella/import/index.md) 1. Terminate the session. -1. Remove existing backups from TeamForCapella: +1. Remove existing TeamForCapella to Git backup pipelines in the Collaboration + Manager and note down if the commit history is included: [Remove a (nightly) backup](../../user/projects/models/backups/remove.md) -1. Add a new repository in the TeamForCapella settings: +1. Add a new repository in the TeamForCapella server with the new Capella + version via the Capella Collaboration Manager: [Add a new TeamForCapella repository](./repository-management/index.md#add-a-new-teamforcapella-repository) 1. Unlink the old TeamForCapella repository (old Capella version) from your model: @@ -36,8 +41,19 @@ on the old TeamForCapella server. ![Disable backup option](../../user/tools/capella/migration/backup-migration.png) -1. Export the model to the new TeamForCapella server via the Export wizzard +1. Export the model to the new TeamForCapella server via the Export wizard from TeamForCapella: [Export a model to TeamForCapella](../../user/tools/capella/teamforcapella/export/index.md) 1. Recreate the backup pipeline: - [Set up a TeamForCapella backup](../../user/projects/models/backups/setup.md) + [Set up a TeamForCapella backup](../../user/projects/models/backups/setup.md). + Start a pipeline run and verify that the changes are included in the Git + repository. +1. Use the [capella-diff-tools](https://github.com/DSD-DBS/capella-diff-tools) + and compare the commit after the migration with the commit before the + migration. Verify that the changes are correct. +1. Communicate to all users that the model has been migrated to a new version. + Users have to use sessions of the newer Capella version after the + migration. Since the connection details have changed, all users have to + delete the old `model.team` project from their personal workspace and + reconnect to the TeamForCapella repository: + [Connect to a TeamForCapella repository](../../user/tools/capella/teamforcapella/export/index.md)