Deploying Carmenta Engine 5 Applications on Linux/ARM
Deploying applications
This article describes how to deploy a Carmenta Engine application on Linux/ARM.
The libraries that needs to be present when deploying a Carmenta Engine application on Linux/ARM is the same as the ones listed in Deploying Carmenta Engine 5 applications on Linux. The Deployment using packages and the Carmenta Engine packages sections in the same location are also valid for Linux/ARM.
Deploying .NET applications
For a .NET application, you should use the standard deployment method for such applications, i.e. run a 'dotnet publish ...' command. All needed Carmenta Engine components will be copied from the NuGet packages.
dotnet publish --runtime linux-arm64 --configuration Release --self-contained --output SimpleTileServer-linux-arm64
# Copy the Carmenta Engine SDK license for use as a runtime license key while developing
cp /etc/Carmenta/License.carmentakey SimpleTileServer-linux-arm64/data/License.carmentakey
LD_LIBRARY_PATH=. ./SimpleTileServer
Deploying Java applications
The packages used when deploying a Java application is in the same location as the once used when deploying a C++ application.
For a Java application, a Java Runtime Environment (JRE) version 8 or later must also be installed.
The Java applications can be built on the host computer and copied to the Linux/ARM device. Make sure the version of the Java SDK is equal to or lower than the Java runtime used on the device.
Deploying C++ applications
The rpm and deb packages for Linux/ARM, that can be used when deploying applications, are located in the /usr/share/carmenta/linux directory. Install them on the device with the system package manager before running the application. The carmenta.public.gpg key, that can be used to verify the signed rpm packages, is located in the same directory.
While developing, you can use your Carmenta Engine SDK license key as a runtime license on the Linux/ARM device. To run the samples, without changing the call to Runtime.Initialize, you can, after installing the carmenta-engine package, copy the License.carmentakey file from your /etc/Carmenta/ directory to the /usr/share/carmenta/data/ directory on the Linux/ARM device.
Building C++ applications
To build a C++ application for Linux/ARM the host computer needs to have a cross compiler and the libraries necessary for building the application built for Linux/ARM installed.
The following example shows how to setup a cross compiler on Ubuntu Linux. The package repository list needs to be modified to enable installing arm64 packages on an x86_64 OS. The package architectures for the existing repositories needs to be limited to amd64 and i386, and some new repositories needs to be added for the arm64 packages. Make sure to take a backup of your /etc/apt/sources.list file before editing. For existing lines in /etc/apt/sources.list that looks like the "Default package repositories", add [arch=i386,amd64] to make them look like the "Modified lines". The example shows repositories for Ubuntu 20.04. For other versions of Ubuntu replace 'focal' with the release name in the example below.
# Modified lines, with [arch=i386,amd64] added, to limit the architectures for packages from the default package repositories
deb [arch=i386,amd64] http://archive.ubuntu.com/ubuntu/ focal main ...
deb [arch=i386,amd64] http://security.ubuntu.com/ focal main ...
# New lines to enable the arm64 package repositories
deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports/ focal main restricted universe multiverse
deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports/ focal-updates main restricted universe multiverse
deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports/ focal-backports main restricted universe multiverse
deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports/ focal-security main restricted universe multiverse
# Install the C++ cross compiler
apt update && apt install g++-aarch64-linux-gnu
# Enable installing packages for the arm64 architecture
dpkg --add-architecture arm64
# Install libraries needed for building the sample
apt update && apt install libx11-dev:arm64
# Install the Carmenta Engine packages for Linux/ARM
apt install /usr/share/carmenta/linux/carmenta-engine_5.*_arm64.deb /usr/share/carmenta/linux/carmenta-engine-dev_5.*_arm64.deb
Extract and build the HelloWorldX11, with the C++ cross compiler, on the host computer.
tar xf /usr/share/carmenta/samples/Applications/HelloWorldX11.tar.gz
cd HelloWorldX11
CXX=aarch64-linux-gnu-g++ make
Building Qt applications
Setup the cross compiler as described in Building C++ applications. To build Qt applications for Linux/ARM some additional packages needs to be installed.
# Install libraries needed for building the sample
apt install qt5-default qtcreator qtdeclarative5-dev qtdeclarative5-dev:arm64
tar xf /usr/share/carmenta/samples/Applications/HelloWorldQtQuick.tar.gz
cd HelloWorldQtQuick
aarch64-linux-gnu-qmake .
make
Testing applications in a container
For testing an application built for Linux/ARM, you can use Docker to test running the application before deploying to a device. To emulate the Linux/ARM environment, in the container, the QEMU user mode emulation binaries can be used.
apt install docker.io qemu-user-static
Below are some examples on how to run some of the Carmenta Engine sample applications in a container.
For the example below to work the Carmenta Samples Geodata needs to be installed and a Carmenta Engine SDK license needs to be registered on the host computer.
Running the .NET SimpleTileServer sample
Follow the instructions in Deploying .NET applications on Linux/ARM and, after starting the container, the Example for launching a deployed version of the SimpleTileServer sample application above.
For the example to work the deployed SimpleTileServer sample needs to be in your home directory on the host computer.
docker run \\
--platform=linux/arm64 \\
--tty \\
--interactive \\
--rm \\
--volume="/usr/share/carmenta/geodata-5.15:/usr/share/carmenta/geodata-5.15:ro" \\
--volume="${HOME}/SimpleTileServer-linux-arm64:/SimpleTileServer:ro" \\
--env="DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1" \\
--env="ASPNETCORE_URLS=http://+;" \\
--publish=5000:80 \\
ubuntu:20.04
You should now have an interactive prompt inside the container. To download and install the required packages for Carmenta Engine and the SimpleTileServer sample, run:
# Install some libraries needed to run Carmenta Engine
apt update && apt install libcurl4 libfontconfig1
To view the SimpleTileServer sample running in the container, open http://localhost:5000/maps/ in a web browser on the host computer.
Running the Java HelloWorldJava sample
Follow the instructions in Deploying Java applications on Linux/ARM before starting the container.
For the example to work the sample needs to be in your home directory on the host computer.
docker run \\
--platform=linux/arm64 \\
--tty \\
--interactive \\
--rm \\
--volume="/usr/share/carmenta/geodata-5.15:/usr/share/carmenta/geodata-5.15:ro" \\
--volume="/etc/Carmenta/License.carmentakey:/usr/share/carmenta/data/License.carmentakey:ro" \\
--volume="/usr/share/carmenta/linux:/usr/share/carmenta/linux:ro" \\
--volume="${HOME}/HelloWorldJava:/HelloWorldJava:ro" \\
--volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" \\
--env="DISPLAY" \\
registry.access.redhat.com/ubi8
You should now have an interactive prompt inside the container. To download and install the required packages for Carmenta Engine and the HelloWorldJava sample, run:
# Install Java and the Carmenta Engine packages
yum install java-11-openjdk /usr/share/carmenta/linux/carmenta-engine-5.*.aarch64.rpm /usr/share/carmenta/linux/carmenta-engine-java-5.*.rpm
# Add a user and switch to it before running the application
useradd carmenta && su carmenta
# Run the application
cd /HelloWorldJava
./run.sh
Running the C++ HelloWorldX11 sample
Follow the instructions in Building C++ applications and Deploying C++ applications on Linux/ARM before starting the container.
For the example to work the sample needs to be in your home directory on the host computer.
docker run \\
--platform=linux/arm64 \\
--tty \\
--interactive \\
--rm \\
--volume="/usr/share/carmenta/geodata-5.15:/usr/share/carmenta/geodata-5.15:ro" \\
--volume="/etc/Carmenta/License.carmentakey:/usr/share/carmenta/data/License.carmentakey:ro" \\
--volume="/usr/share/carmenta/linux:/usr/share/carmenta/linux:ro" \\
--volume="${HOME}/HelloWorldX11:/HelloWorldX11:ro" \\
--volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" \\
--env="DISPLAY" \\
opensuse/leap
You should now have an interactive prompt inside the container. To download and install the required packages for Carmenta Engine and the HelloWorldX11 sample, run:
# Import the key used to verify the signed Carmenta Engine packages
rpm --import /usr/share/carmenta/linux/carmenta.public.gpg
# Install the Carmenta Engine runtime and some libraries needed to run the sample
zypper install Mesa-libGL1 fontconfig dejavu-fonts /usr/share/carmenta/linux/carmenta-engine-5.*.aarch64.rpm
# Add a user and switch to it before running the application
useradd carmenta && su carmenta
# Run the application
cd /HelloWorldX11
./HelloWorldX11
Running the C++ HelloWorldQtQuick sample
Follow the instructions in Building Qt applications before starting the container.
For the example to work the sample needs to be in your home directory on the host computer.
docker run \\
--platform=linux/arm64 \\
--tty \\
--interactive \\
--rm \\
--volume="/usr/share/carmenta/geodata-5.15:/usr/share/carmenta/geodata-5.15:ro" \\
--volume="/etc/Carmenta/License.carmentakey:/usr/share/carmenta/data/License.carmentakey:ro" \\
--volume="/usr/share/carmenta/linux:/usr/share/carmenta/linux:ro" \\
--volume="${HOME}/HelloWorldQtQuick:/HelloWorldQtQuick:ro" \\
--volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" \\
--env="DISPLAY" \\
ubuntu:20.04
You should now have an interactive prompt inside the container. To download and install the required packages for Carmenta Engine and the HelloWorldQtQuick sample, run:
apt update && apt install libqt5quick5-gles qml-module-qtquick-controls /usr/share/carmenta/linux/carmenta-engine_5.*_arm64.deb
# Add a user and switch to it before running the application
useradd carmenta && su carmenta
# Run the application
cd /HelloWorldQtQuick
./HelloWorldQtQuick
You can follow the same instructions for building and running the HelloWorldQt sample, just install the libqt5gui5-gles package instead of the libqt5quick5-gles and the qml-module-qtquick-controls packages when running the sample.