A web platform for collaboration on MBSE and Capella projects.
Copyright 2021 - 2024 DB InfraGO AG, licensed under Apache 2.0 License (see full text here)
Turn your local MBSE and Capella experience into a browser-based collaboration platform for model-based projects. Designed to enable co-working across multiple organizations. Here are some of the key features:
In addition, we have integrated commercial products:
We've prepared a small video, where we showcase the diagram cache feature and show how you can use Capella and Jupyter in split view in the browser:
To deploy the application you need:
If you'd like to run it locally, these tools are additionally required:
When you have all that installed you can do the following:
git clone --recurse-submodules https://github.com/DSD-DBS/capella-collab-manager.git
cd capella-collab-manager
# Create a local k3d cluster and test the registry reachability
make create-cluster reach-registry
Then, choose one of the four options and run the corresponding command. The options can be changed at any time later:
[!NOTE] Currently, we only provide amd64 images. If you want to run the application on arm64, you need to build the images yourself (option 3 or 4).
Fetch management portal and session images from Github (without TeamForCapella support). This option is recommended for the first deployment.
export DOCKER_REGISTRY=ghcr.io/dsd-dbs/capella-collab-manager
export CAPELLACOLLAB_SESSIONS_REGISTRY=ghcr.io/dsd-dbs/capella-dockerimages
DEVELOPMENT_MODE=1 make helm-deploy open
Build management portal images and fetch session images from Github (without initial TeamForCapella support)
export CAPELLACOLLAB_SESSIONS_REGISTRY=ghcr.io/dsd-dbs/capella-dockerimages
DEVELOPMENT_MODE=1 make build helm-deploy open rollout
Build management portal and session images locally (without initial
TeamForCapella support) \
To reduce the build time, the default configutation only builds images for
Capella 6.0.0. If you want to build more images for different versions, set
the environment variable CAPELLA_VERSIONS
with a space-separated list of
semantic Capella versions.
export CAPELLA_VERSIONS="6.0.0 6.1.0"
export BUILD_ARCHITECTURE=amd64 # or arm64
Then, run the following command:
DEVELOPMENT_MODE=1 make deploy
Build Capella and TeamForCapella images locally (with initial TeamForCapella support)
Read and execute the preparation in the Capella Docker images documentation: TeamForCapella client base.
Then, run the following command:
DEVELOPMENT_MODE=1 make deploy-t4c
It can take a long time to run, but shouldn't take more than 5 minutes. Please wait until all services are in the "Running" state.
If all goes well, you should find Capella Collaboration Manager running on https://localhost:443/.
If you want to see the individual services in the web-based Kubernetes dashboard, you can run the following command:
make dashboard
If something goes wrong, please open an issue on Github.
To clean up the environment, run:
make delete-cluster
k3d registry delete k3d-myregistry.localhost
Once the cluster is installed and all services are running
(kubectl get pods
), you can get started. Follow our
Getting started guide
and be up and running in a few minutes.
You can find the installation guide for a production deployment in the general documentation.
The Capella Collaboration Manager consists of a couple of components:
External software can also be linked. These parts can be installed separately:
We'd love to see your bug reports and improvement suggestions! Please take a look at our developer documentation. You'll also find instructions on how to set up a local development environment.