Paraview with docker

[UlysseDurand]

Describe the bug
The trame paraview with Docker example doesn't work.

To Reproduce

1. Go to examples/07_paraview/Docker
2. Update Dockerfile's paraview URL with the following line (old URL is deprecated)

ARG PV_URL='https://www.paraview.org/files/v5.13/ParaView-5.13.3-osmesa-MPI-Linux-Python3.10-x86_64.tar.gz'

3. Build (takes some time to download paraview)

docker build -t test .

4. Run

docker run -it --rm -p 9000:80 test

It shows

ulysse-durand@ulyssedurand:~/git/trame/examples/07_paraview/Docker$ sudo docker run -it --rm -p 9000:80 test
 * Restarting Apache httpd web server apache2                                                                                AH00558: apache2: Could not reliably determine the server's fully qualified domain name, using 172.17.0.2. Set the 'ServerName' directive globally to suppress this message
                                                                                                                      [ OK ]
Starting server...
Starting the wslink launcher at
======== Running on http://0.0.0.0:9000 ========
(Press CTRL+C to quit)

Then when connecting with browser the loading animation doesn't stop

After some browser refresh the console shows

Error handling request from 127.0.0.1
Traceback (most recent call last):
  File "/deploy/server/venv/lib/python3.10/site-packages/aiohttp/web_protocol.py", line 517, in _handle_request
    resp = await request_handler(request)
  File "/deploy/server/venv/lib/python3.10/site-packages/aiohttp/web_app.py", line 569, in _handle
    return await handler(request)
  File "/deploy/server/venv/lib/python3.10/site-packages/wslink/backends/aiohttp/launcher.py", line 91, in handle_post
    return await self._waitForReady(session, request)
  File "/deploy/server/venv/lib/python3.10/site-packages/wslink/backends/aiohttp/launcher.py", line 102, in _waitForReady
    if self.process_manager.isReady(session, count):
  File "/deploy/server/venv/lib/python3.10/site-packages/wslink/launcher.py", line 476, in isReady
    if not self.isRunning(id) and count < 60:
  File "/deploy/server/venv/lib/python3.10/site-packages/wslink/launcher.py", line 464, in isRunning
    return self.processes[id].poll() is None
KeyError: '25b4d5b2-3421-11f1-b7e5-4ebbde9d9884'

Platform:

Device:

• Desktop
• Mobile

OS:

• Windows
• MacOS
• Linux
• Android
• iOS

Browsers Affected:

• Chrome
• Firefox
• Microsoft Edge
• Safari
• Opera
• Brave
• IE 11

[jourdain]

We should use https://www.paraview.org/files/v6.1/ParaView-6.1.0-MPI-Linux-Python3.12-x86_64.tar.gz with an image like

FROM kitware/trame:uv-glvnd

ENV TRAME_PYTHON=3.12

RUN install -d -o trame-user -g trame-user /deploy

ARG PV_URL='https://www.paraview.org/files/v6.1/ParaView-6.1.0-MPI-Linux-Python3.12-x86_64.tar.gz'
RUN mkdir -p /opt/paraview && cd /opt/paraview && wget -qO- $PV_URL | tar --strip-components=1 -xzv
ENV TRAME_PARAVIEW=/opt/paraview

COPY --chown=trame-user:trame-user . /deploy

RUN /opt/trame/entrypoint.sh build

[UlysseDurand]

With this new Dockerfile the same problem happens
it takes ~20min to build the docker image because of the downloading time of paraview

[jourdain]

Taking 20 minutes to build the docker image should not be an issue. Also are you sure you are building the docker image from the correct directory?

[UlysseDurand]

Yes I double checked I built from the correct directory (same directory as the Dockerfile and I do docker build -t test .)
The issue is still the same: after running the image (docker run ...) the web page is accessible but the loading animation doesn't stop and for each page refreshs the same error as above is shown in the python console.

[jourdain]

That is because that file is wrong. https://github.com/Kitware/trame/blob/master/examples/07_paraview/Docker/setup/apps.yml

It is missing the --venv /deploy/server/venv args after pvpython.

[UlysseDurand]

I changed it, the problem still persists

ulysse-durand@ulyssedurand:~/git/trame/examples/07_paraview/Docker$ cat setup/apps.yml 
trame:
  cmd:
    - /opt/paraview/bin/pvpython
    - --venv
    - /deploy/server/venv
    - /deploy/SimpleCone.py
    - --host
    - ${host}
    - --port
    - ${port}
    - --authKey
    - ${secret}
    - --server
ulysse-durand@ulyssedurand:~/git/trame/examples/07_paraview/Docker$ sudo docker build -t test .
[+] Building 0.5s (10/10) FINISHED                               docker:default
 => [internal] load build definition from Dockerfile                       0.0s
 => => transferring dockerfile: 457B                                       0.0s
 => [internal] load metadata for docker.io/kitware/trame:uv-glvnd          0.4s
 => [internal] load .dockerignore                                          0.0s
 => => transferring context: 2B                                            0.0s
 => [1/5] FROM docker.io/kitware/trame:uv-glvnd@sha256:a2ad5f3d6019d06607  0.0s
 => => resolve docker.io/kitware/trame:uv-glvnd@sha256:a2ad5f3d6019d06607  0.0s
 => [internal] load build context                                          0.0s
 => => transferring context: 165B                                          0.0s
 => CACHED [2/5] RUN install -d -o trame-user -g trame-user /deploy        0.0s
 => CACHED [3/5] RUN mkdir -p /opt/paraview && cd /opt/paraview && wget -  0.0s
 => CACHED [4/5] COPY --chown=trame-user:trame-user . /deploy              0.0s
 => CACHED [5/5] RUN /opt/trame/entrypoint.sh build                        0.0s
 => exporting to image                                                     0.1s
 => => exporting layers                                                    0.0s
 => => exporting manifest sha256:00aa17c2d560c956bbf1d146d5489bc9c1447231  0.0s
 => => exporting config sha256:c440745f60f51b87016e1fd93833528aca54d27e72  0.0s
 => => exporting attestation manifest sha256:c38c91c636442eb6116f38d03700  0.0s
 => => exporting manifest list sha256:ddeeb800ef7ebb6ee40619b8e5bf13240a5  0.0s
 => => naming to docker.io/library/test:latest                             0.0s
 => => unpacking to docker.io/library/test:latest                          0.0s
ulysse-durand@ulyssedurand:~/git/trame/examples/07_paraview/Docker$ sudo docker run -it --rm -p 8080:80 test
 * Restarting Apache httpd web server apache2                                   AH00558: apache2: Could not reliably determine the server's fully qualified domain name, using 172.17.0.2. Set the 'ServerName' directive globally to suppress this message
                                                                         [ OK ]
Starting server...
Starting the wslink launcher at
======== Running on http://0.0.0.0:9000 ========
(Press CTRL+C to quit)
Error handling request from 127.0.0.1
Traceback (most recent call last):
  File "/deploy/server/venv/lib/python3.12/site-packages/aiohttp/web_protocol.py", line 517, in _handle_request
    resp = await request_handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/deploy/server/venv/lib/python3.12/site-packages/aiohttp/web_app.py", line 569, in _handle
    return await handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/deploy/server/venv/lib/python3.12/site-packages/wslink/backends/aiohttp/launcher.py", line 91, in handle_post
    return await self._waitForReady(session, request)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/deploy/server/venv/lib/python3.12/site-packages/wslink/backends/aiohttp/launcher.py", line 102, in _waitForReady
    if self.process_manager.isReady(session, count):
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/deploy/server/venv/lib/python3.12/site-packages/wslink/launcher.py", line 476, in isReady
    if not self.isRunning(id) and count < 60:
           ^^^^^^^^^^^^^^^^^^
  File "/deploy/server/venv/lib/python3.12/site-packages/wslink/launcher.py", line 464, in isRunning
    return self.processes[id].poll() is None
           ~~~~~~~~~~~~~~^^^^
KeyError: '1b0be39c-3969-11f1-b198-5de39d817b3d'

[jourdain]

Can you look in the log files inside docker at /deploy/server/logs/launcher/* ?

[UlysseDurand]

Sure

ulysse-durand@ulyssedurand:~/git/trame/examples/07_paraview/Docker$ sudo docker exec -it musing_kilby bin/sh
# ls /deploy/server/logs/launcher/
cda1ee88-398d-11f1-9cc4-03c1b510d747.txt  cee80854-398d-11f1-9cc4-03c1b510d747.txt  cf94e218-398d-11f1-9cc4-03c1b510d747.txt  launcherLog.log
# cat /deploy/server/logs/launcher/*
/opt/paraview/bin/pvpython-real: error while loading shared libraries: libpciaccess.so.0: cannot open shared object file: No such file or directory
/opt/paraview/bin/pvpython-real: error while loading shared libraries: libpciaccess.so.0: cannot open shared object file: No such file or directory
/opt/paraview/bin/pvpython-real: error while loading shared libraries: libpciaccess.so.0: cannot open shared object file: No such file or directory
# 

[jourdain]

Someone from the KEU ParaView team should be able to guide you on what you should install in docker to fix that.

[UlysseDurand]

Adding this line in the Dockerfile fixed the problem

RUN apt-get update && apt-get install -y libpciaccess-dev

Now I still can't run the trame app:

Experiment

• In first terminal

ulysse-durand@ulyssedurand:~/git/trame/examples/07_paraview/Docker$ sudo docker run -it --name testt -p 8080:80 test
 * Restarting Apache httpd web server apache2                                                                                                                                                 AH00558: apache2: Could not reliably determine the server's fully qualified domain name, using 172.17.0.2. Set the 'ServerName' directive globally to suppress this message
                                                                                                                                                                                       [ OK ]
Starting server...
Starting the wslink launcher at
======== Running on http://0.0.0.0:9000 ========
(Press CTRL+C to quit)

• In a second terminal (in the docker container)

ulysse-durand@ulyssedurand:~/Downloads/opt$ sudo docker exec -it testt bin/bash
root@d23aed78c8b1:/# cat /deploy/server/logs/launcher/*
root@d23aed78c8b1:/# 

(Empty logs)

When I open localhost:8080 with my browser once

• In the browser

• In the first terminal
  Nothing new is printed

• In the second terminal (in the docker container)
  I log:

root@d23aed78c8b1:/# cat /deploy/server/logs/launcher/*
ParaView is using venv: /deploy/server/venv
(   4.282s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.282s) [paraview        ]vtkXOpenGLRenderWindow.:1460  WARN| bad X server connection. DISPLAY=
(   4.372s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.391s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.395s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.396s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.593s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library

App running at:
 - Local:   http://0.0.0.0:9500/
 - Network: http://0.0.0.0:9500/

Note that for multi-users you need to use and configure a launcher.
 JS Error => Failed loading css __trame_vuetify/trame-vuetify.css
 JS Error => error: SyntaxError: expected expression, got '<'
root@d23aed78c8b1:/#                                   

When I refresh my browser

• In the browser

• In the first terminal

Nothing new

• In the second terminal (in the docker container)

root@d23aed78c8b1:/# cat /deploy/server/logs/launcher/*
ParaView is using venv: /deploy/server/venv
(   4.222s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.222s) [paraview        ]vtkXOpenGLRenderWindow.:1460  WARN| bad X server connection. DISPLAY=
(   4.311s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.330s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.334s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.335s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.529s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library

App running at:
 - Local:   http://0.0.0.0:9499/
 - Network: http://0.0.0.0:9499/

Note that for multi-users you need to use and configure a launcher.
 JS Error => Failed loading css __trame_vuetify/trame-vuetify.css
 JS Error => error: SyntaxError: expected expression, got '<'
ParaView is using venv: /deploy/server/venv
(   4.282s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.282s) [paraview        ]vtkXOpenGLRenderWindow.:1460  WARN| bad X server connection. DISPLAY=
(   4.372s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.391s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.395s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.396s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library
(   4.593s) [paraview        ]    vtkX11Functions.cxx:194   WARN| Failed to load Xcursor library

App running at:
 - Local:   http://0.0.0.0:9500/
 - Network: http://0.0.0.0:9500/

Note that for multi-users you need to use and configure a launcher.
 JS Error => Failed loading css __trame_vuetify/trame-vuetify.css
 JS Error => error: SyntaxError: expected expression, got '<'
root@d23aed78c8b1:/# 

I share the /opt/trame folder from the docker container, and the /deploy folder (after removing the venv for file size)

trame.zip

deploy.zip

[jourdain]

Install libX too, I though that was not needed anymore with ParaView 6.1... But maybe not.

[UlysseDurand]

With this Dockerfile

FROM kitware/trame:uv-glvnd

ENV TRAME_PYTHON=3.12

RUN install -d -o trame-user -g trame-user /deploy

ARG PV_URL='https://www.paraview.org/files/v6.1/ParaView-6.1.0-MPI-Linux-Python3.12-x86_64.tar.gz'
RUN mkdir -p /opt/paraview && cd /opt/paraview && wget -qO- $PV_URL | tar --strip-components=1 -xzv
ENV TRAME_PARAVIEW=/opt/paraview
# ENV VTK_DEFAULT_OPENGL_WINDOW=OSMesa

RUN apt-get update && apt-get install -y \
    libpciaccess-dev \
    libxcursor-dev \
    libegl1-mesa-dev \
    libosmesa6 libosmesa6-dev \
    libx11-6 \
    libx11-dev \
    libxext6 \
    libxrender1 \
    && rm -rf /var/lib/apt/lists/*

COPY --chown=trame-user:trame-user . /deploy

RUN /opt/trame/entrypoint.sh build

It logs

ulysse-durand@ulyssedurand:~/git/trame-vtk$ sudo docker exec -it testt sh -c "cat deploy/server/logs/launcher/*"
ParaView is using venv: /deploy/server/venv
(   5.564s) [paraview        ]vtkXOpenGLRenderWindow.:1460  WARN| bad X server connection. DISPLAY=

App running at:
 - Local:   http://0.0.0.0:9500/
 - Network: http://0.0.0.0:9500/

Note that for multi-users you need to use and configure a launcher.
 JS Error => Failed loading css __trame_vuetify/trame-vuetify.css
 JS Error => error: SyntaxError: expected expression, got '<'

Uncommenting ENV VTK_DEFAULT_OPENGL_WINDOW=OSMesa it logs

ulysse-durand@ulyssedurand:~/git/trame-vtk$ sudo docker exec -it testt sh -c "cat deploy/server/logs/launcher/*"
ParaView is using venv: /deploy/server/venv
(   5.589s) [paraview        ]vtkOpenGLRenderWindow.c:667   WARN| Failed to create a vtkOpenGLRenderWindow subclass with VTK_DEFAULT_OPENGL_WINDOW=OSMesa
(   5.670s) [paraview        ]vtkOpenGLRenderWindow.c:667   WARN| Failed to create a vtkOpenGLRenderWindow subclass with VTK_DEFAULT_OPENGL_WINDOW=OSMesa
(   5.679s) [paraview        ]vtkOpenGLRenderWindow.c:667   WARN| Failed to create a vtkOpenGLRenderWindow subclass with VTK_DEFAULT_OPENGL_WINDOW=OSMesa

App running at:
 - Local:   http://0.0.0.0:9500/
 - Network: http://0.0.0.0:9500/

Note that for multi-users you need to use and configure a launcher.
 JS Error => Failed loading css __trame_vuetify/trame-vuetify.css
 JS Error => error: SyntaxError: expected expression, got '<'

[Jo-Byr]

@jourdain the problem on the front comes from the MIME types of trame-vuetify's files not being correct (text/html instead of text/css and text/js).

It is fixed indirectly by using vuetify3 instead of vuetify2, so I made the guess that updating the versioning (Kitware/trame-vuetify#35) should fix the problem for vuetify2 but I'm not sure it will be enough.

I'll have a look to the OS Mesa problem.

[UlysseDurand]

Switching the example to vuetify3 (so the versioning and the file serving is right) and using VTK_DEFAULT_OPENGL_WINDOW=vtkEGLRenderWindow makes the example work.

Also, after installing the NVidia container toolkit on my PC which runs docker https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html#installing-with-apt, the example works without VTK_DEFAULT_OPENGL_WINDOW=vtkEGLRenderWindow

To make the example work, this Dockerfile

FROM kitware/trame:uv-glvnd

ENV TRAME_PYTHON=3.12

RUN install -d -o trame-user -g trame-user /deploy

ARG PV_URL='https://www.paraview.org/files/v6.1/ParaView-6.1.0-MPI-Linux-Python3.12-x86_64.tar.gz'
RUN mkdir -p /opt/paraview && cd /opt/paraview && wget -qO- $PV_URL | tar --strip-components=1 -xzv
ENV TRAME_PARAVIEW=/opt/paraview
ENV VTK_DEFAULT_OPENGL_WINDOW=vtkEGLRenderWindow

RUN apt-get update && apt-get install -y \
    libpciaccess-dev \
    libxcursor-dev \
    && rm -rf /var/lib/apt/lists/*

COPY --chown=trame-user:trame-user . /deploy

RUN /opt/trame/entrypoint.sh build

And this setup/apps.yml

trame:
  cmd:
    - /opt/paraview/bin/pvpython
    - --venv
    - /deploy/server/venv
    - /deploy/SimpleCone.py
    - --host
    - ${host}
    - --port
    - ${port}
    - --authKey
    - ${secret}
    - --server

With the SimplCone example updated to use vue3

Make the example work (even without installing NVidia container toolkit).

Should I make a PR with these changes ?