Skip to content

How to Migrate a Capella Model to a Higher Version (in TeamForCapella)

Warning

A downgrade of Capella models is not possible.

  1. Open a new persistent session with the old Capella version.
  2. Check that nobody is connected to the remote repository: See who is connected to a TeamForCapella repository
  3. Run a backup pipeline and verify that the latest changes are included in the Git repository. If the Git repository is already up-to-date, there will be no additional commit. In this case, you should check the status of the pipeline run.
  4. Import the model from the TeamForCapella server via the Import wizard from TeamForCapella into your local workspace: Import a model from TeamForCapella
  5. If you're still connected to the old Capella repository (*.team project in the workspace), delete the *.team project. Do not delete the previously imported project!
  6. Terminate the session.
  7. Remove existing TeamForCapella to Git backup pipelines in the Collaboration Manager: Remove a backup
  8. Add a new repository in the TeamForCapella server with the new Capella version via the Capella Collaboration Manager: Add a new TeamForCapella repository
  9. Unlink the old TeamForCapella repository (old Capella version) from your model: Unlink a TeamForCapella repository
  10. Update the model version to the newer Capella version: Change model metadata
  11. Link the new TeamForCapella repository (new Capella version) to your model: Link a TeamForCapella repository
  12. Create a new session with the new Capella version.

  13. In your persistent workspace, execute the following steps:

    1. Right-click on the model in your workspace.
    2. Select Migration and Migrate Project toward current version Migrate Capella model
    3. A backup is not required as the latest version should still be available on the old TeamForCapella server. Disable backup option

  14. Export the model to the new TeamForCapella server via the Export wizard from TeamForCapella: Export a model to TeamForCapella

  15. If you have CI/CD pipelines in the linked Git repositories which depend on a specific Capella version, make sure to update them. For our pipelines it might be necessary to update the CAPELLA_VERSION environment variable.
  16. Recreate the backup pipeline(s) for the new TeamForCapella server version: Set up a TeamForCapella backup. Start a pipeline run and verify that the changes are included in the Git repository. Verify also that the CI/CD pipelines in the linked Git repository are still working (if applicable).
  17. Use the capella-diff-tools and compare the commit after the migration with the commit before the migration. Verify that the changes are correct.
  18. Communicate to all users that the model has been migrated to a new version. Users have to reimport the repositories in their personal workspace. Share the following documentation page with all users: Steps after a Model Migration
  19. At a later point, when the new repository is stable on the new server: Remove the old TeamForCapella repository from the old server