Skip to content

Commit ca7a800

Browse files
committed
Add notes and restrictions to Docker packaging README
1 parent eb0939e commit ca7a800

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

packaging/docker/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# Package Ultimate for Docker
1+
# Docker Packaging and Deployment of Ultimate Products
22

33
## Build Ultimate Docker images
4+
45
An Ultimate `PRODUCT` can be built with the following Docker call
56

67
```shell
7-
docker build -t <PRODUCT> --target <PRODUCT> .
8+
docker build --platform linux/amd64 --tag <PRODUCT> --target <PRODUCT> .
89
```
910

1011
where `PRODUCT` is a placeholder for one of the pre-configured products
@@ -27,6 +28,10 @@ or one of the basic products without any configuration (e.g., for your own Docke
2728

2829
shipped with the Ultimate program analysis framework.
2930

31+
> [!NOTE]
32+
> Building the Ultimate product images is currently limited to the Docker target platform `linux/amd64` (Linux containers for the 64-bit x86 architecture).
33+
> However, these images can still be used on a Windows system with [Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/) configured with the WSL2 or Hyper-V backend in order to create and run Linux containers on a Windows system.
34+
3035
For validating the built Ultimate `PRODUCT` image, you can create and run a Docker container based on this image with the following Docker call.
3136
```shell
3237
docker run -it <PRODUCT>
@@ -42,8 +47,10 @@ docker run -it <PRODUCT> /bin/bash
4247
<PRODUCT> -tc <TOOLCHAIN> -s <SETTINGS> -i <PROGRAM>
4348
```
4449
Calling the Ultimate `PRODUCT` within the container then follows as usual, where a `TOOLCHAIN`, `SETTINGS`, and `PROGRAM` file should be specified for a verification run.
45-
The pre-configured products are already provided with the appropriate tool-specific configuration files (toolchain and setting files).
46-
You can access the configuration directory within a Docker container via the environment variable `ULTIMATE\_CONFIG\_PATH`.
50+
51+
> [!NOTE]
52+
> The pre-configured products are already provided with the appropriate configuration (toolchain and setting files).
53+
> You can access the configuration directory within a Docker container via the environment variable `ULTIMATE_CONFIG_PATH`.
4754
4855
An exception is a start of the graphical Ultimate Debug UI.
4956
To do this, a graphic connection to the host system must be established via the X11 protocol, which can be done with the following Docker call.

0 commit comments

Comments
 (0)