Versions Compared

Old Version 2

changes.mady.by.user Inga A.

Saved on

compared with

New Version Current

changes.mady.by.user Agne P.

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
content-1087436467

This page provides an example package for building Cassandra and Magic Collaboration Studio components from a Magic Collaboration Studio No-Install package. The example package uses Docker Compose to build all the components required to deploy a fully-functional Magic Collaboration Studio containerized environment. Such an environment can be deployed in an orchestration framework to enhance scaling and management.

Magic Collaboration Studio Container Example Package Components

Docker Hub Pulled Images:

  • Cassandra 4.
0
  • 1.
3
  • 1
  • Zookeeper 3.7.0
  • ZooNavigator 1.1.1 (elkozmon) (optional)
  • Elasticsearch 7.16.2 

External Packages:

  • Magic Collaboration Studio
2022x
  • 2024x No-Install Linux (downloaded from
the
  • the 3DS software download page)
  • ActiveMQ Artemis 2.26.0 (downloaded automatically after executing the containerization environment staging script)

Example with Docker Compose

content-layer
id1087436400
Content column
width50.00001%
id1087436380
Content column
width50.00001%
id1087436468
block
id1087504433
Warning
These procedures are intended for users with Docker knowledge. We do not provide Docker support, just provide guidelines on how to use it with our product. For more information about Docker, see https://docs.docker.com/

Table of Contents

Example package

Content block
id
Note

The example package requires at least 32GB of available RAM.

  1. Download and extract the example package into an empty working directory.
  2. Download a
2022x
  1. 2024x or
newer
  1. later version of Magic Collaboration Studio No-Install Linux package.
  2. Rename or symbolically link the no-install package to twcoudsuite.zip.
  3. Execute the config.tw-compose.sh script to stage the containerization environment.

  4. Run the following command to initialize Docker Compose container configurations:

    Code Block
    languagebash
    themeDJango
    linenumberstrue
    docker compose build

  5. Run the following command to launch containers:

    Code Block
    languagebash
    themeDJango
    linenumberstrue
    docker compose up -d

    If you execute this command for the first time, it will build the containers as well.

  6. Use the following URLs:

    • To access web UI:

      Code Block
      languagebash
      https://host.docker.internal:8443/webapp

    • To connect from a modeling tool client (with default port 3579):

      Code Block
      languagebash
      host.docker.internal

    •  To access REST API/Swagger Page:

      Code Block
      languagebash
      https://host.docker.internal:8111
Info

You can apply the Magic Collaboration Studio license via the web UI or REST API. 

Helpful commands

To follow the output (tail) the output of a specific container:

Code Block
languagebash
themeDJango
linenumberstrue
docker compose logs -f <Container Name or ID>

To stop all containers but retain data in non-persistent storage:

Code Block
languagebash
themeDJango
linenumberstrue
docker compose stop

 To stop all and remove all running containers (non-persistent storage data will be lost):

Code Block
languagebash
themeDJango
linenumberstrue
docker compose down -v