Getting Started

This page tells you how to get started with Modelix

In production modelix uses docker images running in a kubernetes cluster. During development you can run the different components without docker/kubernetes. You need a PostgreSQL database, the model server and the MPS plugin for the UI server.

Running without kubernetes

  • ./gradlew in the root directory
  • open the project in the folder “mps” with MPS 2020.1.1
  • http://localhost:33333/

This allows you to edit the models stored locally in MPS. Optionally, you can run the model server and connect your MPS to it:

  • database
  • model server
    • cd model-server
    • ../gradlew run
  • connect MPS to the model server
    • open the “Cloud” view in the bottom left corner
    • In the context menu of the root node labeled “Cloud” choose “Add Repository”
    • type http://localhost:28101/
    • navigate to “default tree (default)” > “data [master]” > “ROOT #1” and choose “Add Module” from the context menu
    • add a model to that module using the context menu
    • choose “Bind to Transient Module” from the context menu of the module
    • you should now see that module and the new model in the “Cloud” section at the end in the “Project” view
    • open the “Model Properties” of the new model and add at least one language dependency
    • now you are able to add new root nodes to the model from the MPS “Project” view

Running a local kubernetes cluster

  • Option 1: Docker Desktop
    • Download and install Docker Desktop
    • Enable kubernetes in the preferences
    • Increase memory to 4-8 GB in Preferences > Resources
  • Option 2: minikube
    • minikube start --cpus=4 --memory=8GB --disk-size=40GB
    • eval $(minikube -p minikube docker-env)
  • ./
  • SSL certificate
    • cd ssl
    • ./
    • ./
    • cd ..
  • Option 1: Use the latest published docker images
    • ./
  • Option 2: Build your own docker images
    • ./
  • ./
  • Wait ~2 minutes. You can check the status of the cluster using kubectl get all (or minikube dashboard)
  • Docker Desktop: ./, minikube: minikube service proxy
  • connect MPS to the model server: same steps as described at “Running without kubernetes”, but use the URL you see when you executed ./ / minikube service proxy and append “model/” (e.g.

Running in the google cloud

  • Create cluster
    • Name: modelix
    • Zone: europe-west-3c
    • Pool
      • Number of nodes: 1
      • Machine type: n1-standard-2
  • gcloud container clusters get-credentials modelix
  • ./gradlew
  • ./
  • ./
  • kubectl create secret generic cloudsql-instance-credentials --from-file=./kubernetes/secrets/cloudsql.json
  • ./
  • SSL certificate (not supported yet)
    • cd ssl
    • ./
    • ./
  • ./
  • watch kubectl get all -o wide
  • kubectl delete horizontalpodautoscaler.autoscaling/ui-autoscaler
  • Entities example
    • cd samples/entities/
    • ./
    • ./
    • kubectl apply -f deployment.yaml -f service.yaml

Last modified March 4, 2021: fix link to database properties (a870c8e)