eLux SDK VM for eLux RP 6 Virtual machine for software development based on eLux and for creating eLux packages with the eLux Builder Kit Last edited: 2021-05-20 0. Legal information 3 1. About the eLux SDK VM 4 1.1. Kernel development 5 1.2. System packages 5 1.3. Command line tool 6 1.4. Example packages 7 2. Starting eLux Builder Kit 8 3. eLux Builder Kit interface 9 3.1. Main window 9 3.2. Menu options 10 3.3. Context menus 11 3.4. File Browser 12 3.5. Package properties in the Properties Editor 14 3.6. Build section 16 3.7. Output Window 16 4. Creating individual packages in the eLux Builder Kit 17 4.1. Creating a new workspace 17 4.2. Creating a folder 17 4.3. Defining new packages 18 4.4. Creating a Symbolic link 19 5. eLux Builder Kit preferences 20 5.1. Global tab 20 5.2. Build tab 22 5.3. EPM/FPM tab 22 5.4. Invalid settings 23 6. The epkg tool 24 6.1. How to use the epkg tool 25 6.2. How to configure the epkg tool 26 6.3. Metafile structure 29 6.4. Examples of use 33 7. Other 35 7.1. Citrix virtual channels 35 7.2. Scripts on configuration update 35 0. Legal information 0. Legal information © 2021 Unicon Software Entwicklungs- und Vertriebsgesellschaft mbH This document is copyrighted. All rights reserved. No part of this document may be reproduced or trans- mitted in any form or by any means, without our express consent. Information in this document is subject to change without notice. We disclaim all liability regarding correctness, completeness and topicality of the information contained herein and any errors or damage resulting from the information provided. eLux® and Scout Enterprise Management Suite® are registered trademarks of Unicon Software Entwicklungs- und Vertriebsgesellschaft mbH in the European Union, GB and the United States. ScoutaaS® is a registered trademark of Unicon Software Entwicklungs- und Vertriebsgesellschaft mbH in the European Union, GB, the United States and Japan. All other product names are registered trademarks of their relevant owners. Unicon Software Entwicklungs- und Vertriebsgesellschaft mbH Ludwig-Erhard-Allee 26 76131 Karlsruhe +49 (0)721 96451-0 3 1. About the eLux SDK VM The eLux SDK VM is a virtual machine equipped with Software Development Kit tools for eLux RP 6 (64-bit) that we provide upon request. The Linux system comes as a VMware image and runs on all VMware Server versions. We provide a version of our eLux SDK VM which corresponds to the latest eLux version.1 Version Description Deployment eLux SDK VM 3.9 contains the eLux Builder Kit as an .ova template for eLux RP 6 (64-bit) In your VMware environment, use the Deploy OVF Template option to install the machine from the template. epkg for eLux SDK Command line tool for creating Install the epkg packages on an Ubuntu VM 3.9 eLux RP 6 packages system. The eLux-Builder-Kit is a development environment that allows skilled Linux developers or admin- istrators to package any software as .epm and .fpm files. You can also compile your own source code and/or kernel drivers. You can include any packages built with the eLux Builder Kit in an eLux image definition file (.idf) by using ELIAS. Alternatively, use our epkg tool to build eLux packages from the command line. You can also automate the process of building packages by using epkg. Using the eLux SDK requires knowledge of Network and communication hardware Administration of Linux operating systems Administration of eLux ELIAS features Logon The following system accounts are available: root – elux elux – elux The home directory of the user elux is /home/elux. Log on with user elux, either in the VMware console or remote via ssh. 1For example, eLux SDK VM 3.9 relates to eLux RP 62103 and 2104 4 1. About the eLux SDK VM Note Alternatively, click Applications > Internet > X11VNC Server after you have logged on to the VMware console and use a VNCviewer to connect. The machine is configured to use DHCP by default. Creating eLux packages When the system starts, the Mate Desktop is started automatically and you are logged in as user elux. Use the eLux Builder Kit. A good way to become familiar with the program is to build the pack- ages of the example workspace. For further information, see Example package. Alternatively, the command line tool epkg is provided. For further information, see The epkg tool. Windows Shared Folder (Samba) The samba4 server package is installed on the image but not yet configured. To configure the samba server, see https://help.ubuntu.com/lts/serverguide/samba-fileserver.html or use the command man smb.conf to read the official smb.conf manual. 1.1. Kernel development The kernel is patched and pre-configured. The compiled kernel modules can be found as Debian pack- ages under /usr/src/. For eLux RP 6, only the 64-bit version is supported. 1.2. System packages The eLux RP 6 system is based on Ubuntu 16.04 "Xenial". All packages modified or backported by Unicon are included in this image. Any additional package can be obtained with the usual Debian way ((apt-get oder aptitude). 5 1.3. Command line tool – only for SDK VM 3.x – epkg is a command line tool for building eLux packages which can also be used to automate the build- ing process. In our example workspace, under /home/elux/workspace/examples/build, you will find the build.sh script that you can use to build the example package. Converting packages During the build process, epkg sets up an eLux Builder Kit workspace. It allows you to easily edit the package meta data. To enable epkg to use the eLux Builder Kit, you need to convert the package tree. You can do so using epkg. For an example, see the convert folder and script: /home/elux/workspace/examples/convert/convert.sh After you have built the example package, the created workspace can be found under /home/elux/workspace/examples/build/tcpdump/output/.ebkworkspace. For ease of use, this workspace is also included in the recently used list of the File menu. You can now edit the meta data for the packages in the eLux Builder Kit, and then start the final build pro- cess. The final package files (.epm, .fpm) can be found in the output directory: /home/elux/workspace/examples/build/output/container/UC_RP6-1.0-1/ epkg also offers the option to install packages. They are copied from the output directory to a defined container directory (example: /home/containers). The file /usr/share/epkg/settings.ini holds the configuration for installing and signing pack- ages. For further information, see The epkg tool. 6 1. About the eLux SDK VM 1.4. Example packages For the eLux Builder Kit, we have included an example workspace that provides an EPM with FPMs: eLux debug: /home/elux/examples/packaging/debug/output/devel1 SDK The workspace contains examples for creating eLux packages from development tools such VM as gdb, file, strace, ltrace, valgrin, less, coredump, tcpdump, 3.9 vim, libpython, systemd-debug-shell, eluxbuild Building example packages 1. Open the example workspace (.ebkworkspace) of the specified directory. To do so, you can use the Recently used entry of the File menu. 2. Select the top level (the EPM). 3. Click the Build button. All packages of the workspace are built. The resulting package files (.epm, .fpm) can be found in the output directory: eLux SDK VM /home/elux/examples/packaging/devel/output/container/UC_ 3.9 RP6_X64-1.0-1/ Building a kernel module – for eLux SDK VM 3.5 and later versions– Under /home/elux/examples/compiling/kernel_module/, you will find a make file. Use the make command to build a kernel module which you can load into eLux. Important The kernel module stands in dependence to the kernel of the eLux version. For example, a ker- nel module built with the eLux SDK VM 3.5 will only work with eLux RP 6.7. 1from eLux SDK VM 3.6 7 2. Starting eLux Builder Kit 1. On the desktop, double-click the application icon of the eLux Builder Kit (EBKGUI), or at the com- mand prompt, enter ebkgui. 2. To sign your packages, edit the certificate settings as required. For further information, see eLux Builder Kit preferences. 3. Open an existing or create a new workspace. The eLux Builder Kit main window is displayed. Familiarize yourself with the interface (see main window) and try out the example. To start your own project, create a new workspace. Then define your packages, edit the package properties and the build settings, before you start the build process. 8 3. eLux Builder Kit interface 3. eLux Builder Kit interface 3.1. Main window Legend 1 File Browser 2 Workspace Browser Shows the structure of the currently opened workspace including EPMs, FPMs, directories, files and Symbolic Links 3 Properties Editor Shows the properties of the object selected in the Workspace Browser with Property and Value You can edit most of the properties directly in their field or by using the ... button in the Value field. Dimmed Properties cannot be modified. 4 Build settings 5 Output window 9 3.2. Menu options File menu Option Description New workspace Generates a new workspace Open workspace Opens an existing workspace Save Saves the currently opened workspace Import EPM folder Imports an EPM from another workspace into the opened workspace Export selected Exports an EPM from the workspace into any folder EPM Link to EPM folder Links an EPM from another workspace into the opened workspace Exit Closes the eLux Builder Kit application Recently used The workspaces opened most recently are made available for re-opening.