Page History

This page provides instructions and sample scripts on how to build an example package for building Cassandra and Teamwork Cloud containers components from the a Teamwork Cloud No Install archive. These containers can be run on any orchestration platform together with WebApps to ensure easy Teamwork Cloud deployment.

Creating a Docker image

To create a Docker image

-Install package. 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.7.0
• ZooNavigator 1.1.1 (elkozmon)
• Elasticsearch 7.16.2 

External Packages:

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

Example with Docker Compose

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

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

   Code Block
   language bash theme DJango linenumbers true
   docker compose build

6. Run the following command to launch containers:

7. Create a working directory image/

8. Extract the content of Teamwork Cloud No Install archive for Linux to image/ to create a folder named image/TeamworkCloudSuite/

   Info
   You can modify your configurations as needed: TeamworkCloudSuite/jvm.options TeamworkCloudSuite/configuration/application.conf TeamworkCloudSuite/configuration/logback.xml

9. Run the following command. Do not forget to add a space and a full stop at the end.

   Code Block
   language bash theme DJango linenumbers true
   docker buildcompose up -t twcloud .

   You can choose a different image name, if necessary.

Example with Docker Compose

1. Create a working directory compose/
2. Copy the content from image/TeamworkCloudSuite/configuration to compose/configuration
3. Modify configurations as needed:
   • configuration/application.conf
   • configuration/logback.xml
4. In this sample, it is mandatory to modify configuration/application.conf as follows:
   • Change the key value esi.persistence.datastax-java-driver.basic.contact-points from 127.0.0.1:9042 to cassandra:9042
5. (Optional) You can modify the memory limits for Cassandra and Teamwork Cloud in docker-compose.yml

6. Run the following command. Do not forget to add a space and a full stop at the end.

   Code Block
   language bash theme DJango linenumbers true
   docker build -t twcloud .

   You can choose a different image name, if necessary.

Helpful commands

1. d

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

2. Use the following URLs:

   • To access web UI:

     Code Block
     language bash
     https://host.docker.internal:8443/webapp

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

     Code Block
     language bash
     host.docker.internal

   •  To access REST API/Swagger Page:

     Code Block
     language bash
     https://host.docker.internal:8111

Helpful commands

To follow the output (tail) the output of a specific To show the output of the Teamwork Cloud Docker container:

docker compose logs -f twcloud <Container Name or ID>

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

docker compose stop

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

docker compose down -v

Building Teamwork Cloud containers in a clustered environment

To build Teamwork Cloud container in a cluster

1. Create a Docker image.
2. Then do the following on each host:
   1. Expose port 2552 by adding it to compose/docker-compose.yml#twcloud.ports (same as 8111 port).
   2. Configure compose/configuration/application.conf key akka.cluster.seed-nodes as as described in the article Teamwork Cloud Cluster Setup.
   3. Modify CASSANDRA_SEEDS in compose/docker-compose.yml as described in the article Teamwork Cloud Cluster Setup.

   4. Run command:

      Code Block
      language bash theme DJango linenumbers true
      docker compose up -d

Configuring Cassandra on a host machine

Docker provides a special hostname for the host machine: host.docker.internal

How to use the special hostname