Docker Compose file for running the entire OpenTOSCA stack.
docker-compose will be integrated into the docker cmd. If this is the case then all docker-compose commands must be written as docker compose (without the hyphen)! (See Compose V2 and the new docker compose command)
The fastest way to get started is using Docker Compose:
-
Create a
.envfile by coping it from_.env -
Add your publicly available FQDN or IP address to the
PUBLIC_HOSTNAMEvariable in the.envfile and save it
(see also I don't know my public IP) -
Execute the following command:
docker-compose up
Wait a few seconds, then open the OpenTOSCA user interface.
More useful commands can be found in section Useful Commands.
A more detailed overview can be found in the docs folder.
| OpenTOSCA Component | URL | GitHub | Docker Hub |
|---|---|---|---|
| OpenTOSCA UI | http://localhost http://localhost:8088 |
Link | Link |
| OpenTOSCA Modelling (Eclipse Winery) | http://localhost/winery http://localhost:8080 |
Link | Link |
| OpenTOSCA Container API | http://localhost:1337 | Link | Link |
| OpenTOSCA Container Repository | http://localhost:8081 | Link | Link |
| Plan Engine BPEL (Apache ODE) | http://localhost/ode http://localhost:9763/ode |
Link | Link |
| Plan Engine BPMN (Camunda) | http://localhost/camunda http://localhost:8092/camunda |
Link | Link |
| IA Engine (Apache Tomcat) | http://localhost/manager http://localhost:8090/manager (based on Java 8) http://localhost:8093/manager (based on Java 17) (user: admin, password: admin) |
Link | Link |
Make sure following ports in your environment are free in order to start OpenTOSCA properly:
133718838080-8088809080918092809397633000(optional grafana server)3100(optional loki server)9000(optional)9990-9999(optional, used as application ports in DIND deployments)
It is recommended that your host or virtual machine has at least 4GB of memory.
NOTE: Please check the Docker Daemon Settings
The steps to deploy OpenTOSCA in production can be found in docs/production.md
How-Tos explaining how to realize specific scenarios can be found in docs/advanced-how-to.md
- How to configure the OpenTOSCA UI to use a different Winery repository
- How to use an existing local Winery repository
- How to use an existing public git Winery repository
- How to run the environment with WSO2 BPS engine
- How to debug components running inside the environment
- How to clone a private TOSCA definitions repository to be used with Winery
- How to extend Winery's JVM Heap Size
- How to access logs using the Browser
docker-compose are integrated into the docker command and must be run as docker compose (without the hyphen)! (See Compose V2 and the new docker compose command)
In most cases starting the containers in the background and attaching to the log of select containers in different terminals will provide the best experience.
# Start services in background
docker-compose up -d
# Attach to container log in first terminal
docker-compose logs -f container
# Attach to engine logs in second terminal
docker-compose logs -f engine-ia-jdk17 engine-plan-bpel
# Or attach to engine logs for legacy IAs
docker-compose logs -f engine-ia-jdk8 engine-plan-bpel
# Shutdown services
docker-compose downTo pull the latest images and ensure that they are run remove the existing containers at shutdown:
# Shutdown services and remove container
docker-compose down -v
# Shutdown services and remove containers (including containers from unspecified services)
docker-compose down -v --remove-orphans
# Pull the latest images
docker-compose pullOther useful commands:
# Validate and view the resulting configuration
docker-compose [-f <file> ...] config
# Display useful logs
docker-compose logs -f [--tail=1 <SERVICE_NAME>...]
docker-compose logs -f container
docker-compose logs -f engine-ia-jdk8 engine-ia-jdk17 engine-plan-bpelThe OpenTOSCA environment needs about 6GB of RAM to run smoothly. For a good user experience set up your Docker environment accordingly:
On some linux systems the following problem arises: https://stackoverflow.com/questions/27612209/spring-boot-application-wont-boot-at-startup-inside-docker
The easiest way right now to fix it is the following: bash apt-get install haveged -y
The amount of RAM that Docker is allowed to use is probably too small.
=> See Not enough RAM for the Docker Daemon?
This is usually a problem with the configured stack size in Java.
You can try to fix it by allowing the Java runtime in the container to use more space.
Therefore, add the following lines to your docker-compose.override file:
engine-plan-bpel:
environment:
_JAVA_OPTIONS: "-Xmx3048m -Xms512m -Xss4m" :warning: The underscore in front of the variable name is important. If it is missing, the override does not work!
The git repositories used by winery use git lfs as they contain large binary files which are not checked in to the git tree.
This can be a problem if you use a locally installed Winery or have mapped existing git repositories into the Winery container.
To install git lfs follow these steps:
- Install
git lfson your machine (see thegit lfshomepage or the wiki) - run
git lfs installin all git repositories used by your Winery (firstcdinto the git repository) - run
git lfs pullto download the binary files
git lfs pull in every repository used by your Winery.
💡 To install git lfs globally, run git lfs install --system.
This makes git lfs automatically available for all repositories and you do not have to run git lfs pull yourself.
This only works for newly cloned git repositories so make sure to check all existing repositories manually.
Windows: Open a command line and type ipconfig then search for the IPv4 or IPv6 address of the wlan or ethernet adapter currently in use.
If you know the hostname of your machine you can also try ping yourHostnameHere or ping yourHostnameHere.local to get the IP.
To get the hostname use the command hostname.
To get all IP addresses known for the hostname try nslookup yourHostnameHere.
Mac: The IP address can be found in the "System Preferences" under "Network".
Options with a green dot are active and should have an IP address that can be found by selecting the option, then clicking "Advanced" and opening the "TCP/IP" tab.
Alternatively use the command ifconfig in the shell and look for inet or inet6 addresses for the ethernet or wlan interfaces in use.
Linux: Use the command ip addr show (or shorter ip a s) in a shell to list the IP addresses of all available interfaces and look for inet or inet6 addresses for the ethernet or wlan interface(s).
On older linux systems where this command is not available use ifconfig instead.
If you know the hostname of your machine you can also try host yourHostnameHere or host yourHostnameHere.local to get the IP.
To get the hostname use the command hostname.
If you are unsure which IP to choose, start with one, run the docker-compose and test with which IPs both the OpenTOSCA UI and the Winery can be reached. Use the IP address that reaches both.
127.0.0.1 or ::1: as these are special addresses (local loopback).
[] (e.g. [2607:f0d0:1002:51::4] or [2607:f0d0:1002:0051:0000:0000:0000:0004]). Do not use [] in the PUBLIC_HOSTNAME environemnt variable!
Make sure that the PUBLIC_HOSTNAME environemnt variable is set and points to your local machine running the docker-compose file.
Test if you can reach the open ports of all containers with that address.
See Container Overview for a more detailed description of the container ports and dependencies between containers.
See also About the Network for background information of the bridge network setup in the docker compose file.
Windows and Mac users may use host.docker.internal as PUBLIC_HOSTNAME if all containers are started locally in docker-compose.
This will not work for development setups where some parts of OpenTOSCA are started outside of the docker-compose network!
Mac users need to apply a workaround described in About the Network for this to work.
In rare cases the port 8080 of the winery container may be inaccessible.
In these cases it may help to change the port in the docker-compose file (e.g. to 8079:8080 [<outside-port>:<container-port>]) and use the config options described in How to configure the OpenTOSCA UI to use a different Winery repository to point the OpenTOSCA ui to the new port for the Winery.
$ sudo apt update
…
Reading package lists... Done
E: Release file for http://us.archive.ubuntu.com/ubuntu/dists/bionic-updates/InRelease is not valid yet (invalid for another 4h 34min 33s). Updates for this repository will not be applied.
…
Most noticable is the apt update command failing with errors like "Release file is not yet valid".
This can happen if the clock of the system is out of sync with the rest of the internet.
Check the current date-time by calling date in the affected systems console.
WSL2: Linux running on the WSL2 can get out of sync if the windows host went into sleep.
On wakeup the windows host does not synchronize the new time with the WSL guests.
The solution is to run sudo hwclock --hctosys in the linux guest to re-synchronize its clock to the hardware clock.
Alternatively shutdown and restart the linux guest (e.g. wsl wsl --shutdown ubuntu) or reboot the windows host.
This also affects docker as it runs as a wsl guest on modern windows installations!
General: If the time is out of sync it might be that none of the configured ntp servers are reachable. Check the manuals for your linux distribution on how to debug/configure ntp or how to manually configure the current time.
$ sudo apt update
…
W: GPG error: http://ports.ubuntu.com/ubuntu-ports focal InRelease: At least one invalid signature was encountered.
…The problem seems to be caused by the fact that the VM hosting the Docker images had run out of disk space (See StackOverflow).
The solution is to run docker image prune -a or to increase the size of the virtual disk by the virtual machine that is running docker. In Docker Desktop this can be done via Preferences > Resources > Disk image size.
If you're connected to the network via Wifi, try to connect via LAN and replace the IP in .env with you LAN IP.
If you see an error like "OpenTOSCA" is not a valid project name: it must contain only characters from [a-z0-9_-] and start with [a-z0-9] you need to specify a valid project name for docker compose.
You can do this while starting the docker compose with this command:
# specify project name with "-p <project name>"
docker compose -p opentosca upor specify the project name in the environment variable COMPOSE_PROJECT_NAME e.g. see _.env file.
.env file specifies a valid project name with COMPOSE_PROJECT_NAME! (see error message above for the requirements)
Dies ist ein Forschungsprototyp. Die Haftung für entgangenen Gewinn, Produktionsausfall, Betriebsunterbrechung, entgangene Nutzungen, Verlust von Daten und Informationen, Finanzierungsaufwendungen sowie sonstige Vermögens- und Folgeschäden ist, außer in Fällen von grober Fahrlässigkeit, Vorsatz und Personenschäden ausgeschlossen.
Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.