1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# NVIDIA Nsight Systems GUI VNC container
Self-isolated Docker container with NVIDIA Nsight Systems GUI and VNC server
## Prerequisites
* [Docker](https://www.docker.com/)
## Build requirements
### Python 3.5 or later
You need Python 3.5 or later to build this container.
## Build
Inside the script folder:
./build.py
### Build parameters
Example with all the available parameters:
./build.py --vnc-password="123456" -aba="--network=host" --nsys-host-directory="/opt/nvidia/nsight-systems/2022.1.0/host-linux-x64" --nsys-target-directory="/opt/nvidia/nsight-systems/2022.1.0/target-linux-x64" --nsys-target-directory="/opt/nvidia/nsight-systems/2022.1.0/target-linux-tegra-armv8" --tigervnc --http --rdp --geometry=1200x800 --build-directory=/tmp/vnc_container
#### List of available parameters
| Parameter | Full name | Description |
| --------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| | --vnc-password | (optional) Default password for VNC access (at least 6 characters). If it is specified and empty - will be asked during the build. Can be changed when running a container. |
| -aba | --additional-build-arguments | (optional) Additional arguments, which will be passed to the "docker build" command. |
| -hd | --nsys-host-directory | (optional) The directory with NVIDIA Nsight Systems host binaries (with GUI). |
| -td | --nsys-target-directory | (optional, repeatable) The directory with NVIDIA Nsight Systems target binaries (can be specified multiple times). |
| | --tigervnc | (optional) Use TigerVNC instead of x11vnc. |
| | --http | (optional) Install noVNC in the Docker container for HTTP access. |
| | --rdp | (optional) Install xRDP in the Docker for RDP access. |
| | --geometry | (optional) Default VNC server resolution in the format WidthxHeight (default 1920x1080). |
| | --build-directory | (optional) The directory to save temporary files (with the write access for the current user). By default, script or tmp directory will be used. |
## Run
### Ports
These ports can be published from container to provide access to the Docker container:
| Port | Purpose | Condition |
| :------------------ | :----------------------------------- | :----------------------------------------- |
| TCP 5900 | Port for VNC access | |
| TCP 80 (optional) | Port for HTTP access to noVNC server | Container is build with "--http" parameter |
| TCP 3389 (optional) | Port for RDP access | Container is build with "--rdp" parameter |
### Volumes
| Docker folder | Purpose | Description |
| :----------------- | :--------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------- |
| /mnt/host | Root path for shared folders | Folder owned by the Docker user (inner content can be accessed from NVIDIA Nsight Systems GUI) |
| /mnt/host/Projects | Folder with projects and reports, created by NVIDIA Nsight Systems UI in container | |
| /mnt/host/logs | Folder with inner services logs | May be useful to send reports to developers |
### Environment variables
Can be used to configure runtime parameters.
| Variable name | Purpose |
| :----------------- | :----------------------------------------------- |
| VNC_PASSWORD | Password for VNC access (at least 6 characters). |
| NSYS_WINDOW_WIDTH | Width of VNC server display (in pixels) |
| NSYS_WINDOW_HEIGHT | Height of VNC server display (in pixels) |
### Examples
With VNC access on port 5916:
sudo docker run -p 5916:5900/tcp -ti nsys-ui-vnc:1.0
With VNC access on port 5916 and HTTP access on port 8080:
sudo docker run -p 5916:5900/tcp -p 8080:80/tcp -ti nsys-ui-vnc:1.0
With VNC access on port 5916, HTTP access on port 8080 and RDP access on port 33890:
sudo docker run -p 5916:5900/tcp -p 8080:80/tcp -p 33890:3389/tcp -ti nsys-ui-vnc:1.0
With VNC access on port 5916, shared "HOME" folder from the host, VNC server resolution 3840x2160, and custom VNC password
sudo docker run -p 5916:5900/tcp -v $HOME:/mnt/host/home -e NSYS_WINDOW_WIDTH=3840 -e NSYS_WINDOW_HEIGHT=2160 -e VNC_PASSWORD=7654321 -ti nsys-ui-vnc:1.0
With VNC access on port 5916, shared "HOME" folder from the host, and the projects folder to access reports created by NVIDIA Nsight Systems GUI in container
sudo docker run -p 5916:5900/tcp -v $HOME:/mnt/host/home -v /opt/NsysProjects:/mnt/host/Projects -ti nsys-ui-vnc:1.0
|
