This folder and sub-folders contain what's necessary to build Trace Viewer example Docker images, that each contain a Trace Viewer frontend application.
Each application has a DockerFile in this folder and its resources in a sub-folder:
DockerFile-tate, resources folder: theia-app-theia-ext/: Dockerfile and resourced needed to build a Trace Viewer Appliance, using a Theia application that includes the Theia Trace Viewer (Theia) extension, installed from npm.DockerFile-tave, resources folder: theia-app-vscode-ext/: Dockerfile and resources needed to build a Trace Viewer Appliance, using a Theia application that includes the Trace Viewer for VSCode (vsix) extension, installed from the open vsx public registryDockerfile-demo, resources folder: theia-app-demo/: Dockerfile that extends one of the Theia-based docker image (tate, tave) and makes it "demo-ready" by adding the Eclipse Trace Compass trace server, a set of sample traces and configuring the traces folder as the starting workspace. See corresponding README for more details.
Note:
- the
-demoimages are meant to be "up-and-running" quickly and contain a trace server and some Tutorial traces. For some quick tests or a demo, this is perfect, but maybe not suitable for general use, where you probably want to view your own traces. - the other images contain exclusively the trace viewer front-end. If you want to run a complete trace viewer application, you will need a service running the trace-server (not included here)
- see section "Docker tips and tricks" if you are relatively new to Docker and want to learn about some potential alternatives or refinements about some of the commands in this document.
(see section further down to learn how to manually build/run the images)
For convenience and use in CI, there are package.json scripts to build the docker images on Linux. Note that it's not necessary to build anything in the repo first:
$ cd <repo>/docker
# build all docker images
$ yarn build:docker
# build docker images individually
# build "tate" image: Theia app that uses
# the theia trace viewer extension:
$ yarn build:docker:tate
# Run image:
$ yarn run:docker:tate
# build "tave" image: Theia app that uses
# the vscode trace viewer extension:
$ yarn build:docker:tave
# Run image:
$ yarn run:docker:tave
# Access the application at http://localhost:4000/
# e.g.:
$ firefox http://localhost:4000
The Docker images can be build from the <repo>/docker folder. For each image, the resources it needs are in a sub-folder, whose name is passed as a docker build build argument and used to retrieve expected resourced needed during image build.
Build the image and name it tv-tate (short for "trace viewer - theia application/theia extension"). You may use a different name if you prefer.
Try adding --network host in case of build failures related to debian packages retrieval:
docker build -f Dockerfile-tate -t tv-tate --build-arg RESOURCES=theia-app-theia-ext .Once the image has been built, start a container named tv-tate-1 from the tv-tate image:
# Keep container after the execution is done:
docker run --name tv-tate-1 --network="host" tv-tate
# if you do not need the container after execution and want
# to avoid having to clean-up:
docker run --rm --name tv-tate-1 --network="host" tv-tateFind the IP address of the tv-tate-1 container:
docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' tv-tate-1Connect to port 4000 of the IP identified earlier using your browser. You should be able to see the theia-trace-extension UI. If it is not visible, click on View -> Open View... -> Trace Viewer
Alternatively, one may start the container using "--network host" and then the app will be accessible opening in the browser: "localhost:4000":
docker run --name tv-tate-1 --network="host" tv-tate
# open "http://localhost:4000" in browser. e.g.:
firefox http://localhost:4000Let's say you have another container running the trace-server at IP 172.17.0.2, port 8080. You can launch the tv-tate-1 container and connect it to the trace-server using the following command:
docker run --name tv-tate-1 --network="host" -e TRACE_SERVER_URL=172.17.0.2:8080/tsp/api tv-tateBuild the image and name it tv-tave (short for "trace viewer - theia application/vscode extension"). You may use a different name if you prefer.
Try adding --network host in case of build failures related to debian packages retrieval.
docker build -f Dockerfile-tave -t tv-tave --build-arg RESOURCES=theia-app-vscode-ext .Once the image has been built, start a container named tv-tave-1 fromthe tave image:
docker run --name tv-tave-1 --network host tv-taveConnect to localhost:4000 your browser. You should be able to see the trace-extension UI. If it is not visible, click on View -> Open View... -> Trace Viewer
When the Theia applications are modified/updated, e.g. to update the contained trace extension or for other reasons, it's important to build the modified app(s) outside Docker and check-in the modified yarn.lock. The lock file is used when building in the container, to insure a known/curated set of dependencies/versions are used. Without the lock file, unexpected 3PPs or versions of 3PPs might be pulled.
To build the Theia applications:
# build both apps (dev)
$ yarn && yarn build
# build both apps (prod version)
$ yarn && yarn build:prodIf after the build, it turns-out that yarn.lock has been modified, the new version needs to be upstreamed as part of the PR that changed the Theia application, so that the applications built as part of the images will use the same dependencies/versions.
If a container already exists with the same name, you will get an error like this:
docker: Error response from daemon: Conflict. The container name "/tv-tate-1" is already in use by container "bdc7e40b3c61d60538b54e2842c34a66e9641d00b17511096d01d7db81e4782f". You have to remove (or rename) that container to be able to reuse that name.
Option 1: you may delete the old version of that container:
# The error message above provides the container id. You may use it
# directly to delete the container (you may use the beginning of the SHA):
docker rm bdc7e40b
# If you need to find the id for the old container yourself:
docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
bdc7e40b3c61 tv-tate "docker-entrypoint.sh" 56 minutes ago Exited (137) 13 minutes ago tv-tate-1Options 2 and 3 will avoid the error in the future:
Option 2: use "--rm" when running "docker run" so that docker will itself remove the container upon exit:
# for example
docker run --rm --name tv-tate-1 tv-tateoption 3: do not name the containers and let Docker give them a randomly-generated name.
# for example
docker run --rm tv-tate
# use "docker ps" to find the name
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
693f53e05929 tv-tate "docker-entrypoint.sh" 4 seconds ago Up 3 seconds 4000/tcp eloquent_wozniak
# in this case the container is named: "eloquent_wozniak"
If docker can't connect to the apt repository to fetch required packages, use "--network host". e.g.:
# if this times-out accessing the apt repo
docker build -f Dockerfile-tate -t tv-tate --build-arg RESOURCES=theia-app-theia-ext .
# try this instead:
docker build --network host -f Dockerfile-tate -t tv-tate --build-arg RESOURCES=theia-app-theia-ext .Using "--network host" as part of "docker run [...]": This configures the Docker container to use the host network stack directly instead of creating an isolated network namespace for the container. This can make some use-cases easier, e.g. having the trace viewer app running in the container accessing a trace server running on the host.
But be aware that this may have security implications in some contexts.