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/


Example package

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

Teamwork Cloud Container Example Package Components

Docker Hub Pulled Images:

  • Cassandra 4.0.3
  • Zookeeper 3.9.2
  • Elasticsearch 7.16.2

External Packages:

  • Product ZIP archive for Linux (the TeamworkCloudAndServices_<version_number>_linux64.zip file downloaded from the 3DS software download page)

  • ActiveMQ Artemis 2.26.0 (you can download the image this version Docker Hub)

    Please note that ActiveMQ does not fully support all special characters in hostnames, particularly underscores.

Example with Docker Compose

  • The example package requires at least 32GB of available RAM.
  • On a Windows machine, you must run the script using the WSL shell.
  1. Install unzip package by executing the following command:
    sudo apt-get install unzip
  2. Install the Java SDK package by executing the following command:
    sudo apt-get install openjdk-17-jdk
  3. Download and extract the example package into an empty working directory.

  4. Download the product ZIP archive for Linux of your product version.

  5. Rename or symbolically link the ZIP archive to twcloudsuite.zip.
  6. Execute the config.tw-compose.sh script to stage the containerization environment.

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

    docker compose build

  8. Run the following command to launch containers:

    docker compose up -d

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

  9. Use the following URLs:

    • To access web UI:

      https://host.docker.internal:8443/webapp

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

      host.docker.internal

    •  To access REST API/Swagger Page:

      https://host.docker.internal:8111

You can apply the Teamwork Cloud license via the web UI or REST API. 

Helpful commands

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

docker compose logs -f <Container Name or ID>

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

docker compose stop

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

docker compose down -v