Virtual machine for software development based on elux and for creating elux packages with the elux Builder Kit

Transcription

1 elux SDK VM for elux RP 5 and elux RP 6 Virtual machine for software development based on elux and for creating elux packages with the elux Builder Kit Last edited: Legal information 3 1. About the elux SDK VM Kernel development System packages The epkg tool Example package 7 2. Starting elux Builder Kit 8 3. elux Builder Kit interface Main window Menu options Context menus File Browser Build section Output Window :22

2 4. Package properties in the Properties Editor Creating individual packages in the elux Builder Kit Creating a new Workspace Creating a folder Defining new packages Creating a Symbolic link elux Builder Kit preferences Global tab Build tab EPM/FPM tab Invalid settings 23

3 0. Legal information 0. Legal information 2018 Unicon Software Entwicklungs- und Vertriebsgesellschaft mbh The information provided in this document is protected by copyright. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means, without the express consent of Unicon Software Entwicklungs- und Vertriebsgesellschaft mbh. Information in this document is subject to change without notice. Unicon Software Entwicklungs- und Vertriebsgesellschaft mbh disclaims all liability regarding correctness, completeness and topicality of the information contained herein and regarding 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 Community and the United States. All other trade names we refer to are service marks or trademarks of the respective manufacturers. Unicon Software Entwicklungs- und Vertriebsgesellschaft mbh Ludwig-Erhard-Allee Karlsruhe +49 (0)

4 1. About the elux SDK VM The elux SDK VM is a virtual machine equipped with Software Development Kit tools for elux RP 5 1 or elux RP 6 that we provide for our customers on request. The Linux system comes as a VMware image and runs on all VMware Server versions. The.zip file contains.vmx files that you can import into your VMware server application. The elux SDK VM is available in two versions: elux SDK VM 2.3 contains the elux Builder Kit for elux RP version 5.4 to 5.7 elux SDK VM 3.0 contains the elux Builder Kit for elux RP 6.x also contains the command line tool epkg The elux-builder-kit (EBKGUI) is a development environment that allows skilled Linux developpers or administrators to package any software as.epm and.fpm files. You can also compile your own source code and/or the kernel driver. Any packages built with the elux Builder Kit can be included in an elux image definition file (.idf) by using ELIAS. By using epkg, you can build elux packages from the command line alternatively. Also, you can automate the process of building packages. Using the elux SDK requires knowledge of Network and communication hardware Administration of Linux operating systems Administration of elux ELIAS features Login The following system accounts are available: root elux elux elux The home directory of the user elux is /home/elux. Log in as user elux, either in the VMware console or remote via ssh. Note Alternatively, click Applications > Internet > X11VNC Server after you have logged on to the vmware console and use a VNCviewer to connect to. 1 for elux RP 5.4 and later versions 4

5 1. About the elux SDK VM The machine is configured to use DHCP on 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 packages of the example workspace. For further information, see Example package. If you use elux RP 6 and the SDK VM 3.0, you can use the command line tool epkg alternatively. 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 or read the official smb.conf manual by using the command man smb.conf 1.1. Kernel development The kernel is patched and pre-configured. The compiled kernel modules can be found as Debian packages under /usr/src/. For both SDK versions, either a 32-bit package version and a 64-bit package version is provided. Only one of the packages can be installed at the same time: The 32-bit package must be used to compile 32-bit kernel modules for default elux installations. The 64-bit package must be used to compile 64-bit kernel modules for UEFI installations. elux SDK VM 2.3 (elux RP 5.4 bis 5.7) Kernel (directory) elux SDK VM 3.0 (elux RP 6.x) (/usr/src/linux-elux ) (/usr/src/linux-elux ) Installing a package dpkg -i /usr/src/linux-elux-x32_ unicon1_ i386.deb OR dpkg -i /usr/src/linux-elux-x64_ unicon1_ i386.deb Uninstalling a package dpkg -r linux-elux-x32 OR dpkg -r linux-elux-x64 dpkg -i /usr/src/linux-elux-x32_ _ i386.deb OR dpkg -i /usr/src/linux-elux-x64_ _ i386.deb 5

6 1.2. System packages The elux RP 5 system is based on Linux Mint 16 "Petra". The elux RP 6 system is based on Ubuntu "Xenial". The system is based on Ubuntu "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) The epkg tool only for SDK VM 3.0 epkg is a command line tool for building elux packages which can also be used to automate the building 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. So, you can easily edit the package meta data. To enable epkg to use the elux Builder Kit, the package tree needs to be converted. This can be done by 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 the 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 process. The final package files (.epm,.fpm) can be found in the output directory: /home/elux/workspace/examples/build/output/container/uc_rp / 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 packages. 6

7 1. About the elux SDK VM 1.4. Example package For the elux Builder Kit, we have included an example workspace under /home/elux/workspace/examples/ that provides an EPM with FPMs: elux SDK VM 2.3 elux SDK VM 3.0 acrobat flashplayer: /home/elux/workspace/examples/pkg_acroflash_example tcpdump: /home/elux/workspace/examples/build/tcpdump/output/tcpdump Building example packages 1. Open the example workspace (.ebkworkspace) of the specified directory. To do so, you can use the Recently usedentry of the File menu. The example EPM is shown in the Workspace Browser. The top level is selected. 2. 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 2.3 elux SDK VM 3.0 /home/containers/uc_rp / /home/elux/workspace/examples/build/output/container/uc_rp / In the example workspace of elux SDK VM 3.0, in the Build folder, you will find an additional example of how to build a package by using epkg. For further information, see The epkg tool. 7

8 2. Starting elux Builder Kit 1. On the desktop, double-click the application icon of the elux Builder Kit (EBKGUI), or at the command prompt, enter ebkgui. 2. If you want 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. Get familiar with the interface (see main window) and play with 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

9 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 und 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

10 3.2. Menu options File menu New workspace Open workspace Save Import EPM folder Export selected EPM Link to EPM folder Exit Recently used workspaces Generates a new workspace Opens an existing workspace Saves the currently opened workspace Imports an EPM from another workspace into the opened workspace Exports an EPM from the workspace into any folder Links an EPM from another workspace into the opened workspace Closes the elux Builder Kit application The workspaces opened most recently are made available for re-opening. In addition, an example workspace is shown. Edit menu Reload workspace Strip file Calculate FPM-Size Calculate all sizes Create Symbolic Link Move FPM up Move FPM down Reloads the currently open workspace Executes the strip command for the selected file Calculates the size and number of files of the selected FPM Calculates the size and number of the files of all FPMs Creates a new Symbolic Link Moves the selected FPM up by one position Moves the selected FPM down by one position Build menu Build Workspace Build selected Builds all packages of the current workspace Builds only the package of the currently selected object. If the workspace is selected, this corresponds to the Build Workspace command. If an EPM is selected, the EPM and its FPMs are built. Settings menu Preferences Opens the Settings dialog 10

11 3. elux Builder Kit interface Sign Settings Opens the Settings dialog and jumps to the settings for signing packages Tools menu EBKViewer Fix FPM SORT_ID Starts the EBKViewer, if installed Fixes problems with the sorting order of FPMs Log menu Clear output window View build log file Delete build log file Deletes the contents of the output window Opens the build log file of the currently opened workspace and displays it. Deletes the build log file of the currently opened workspace 3.3. Context menus For the Workspace Browser and the File Browser, context menus provide quick access to frequently used commands. Context menus in the Workspace Browser The Workspace Browser provides a context menu for EPMs, FPMs, directories and files. (EPM) Add new FPM Delete EPM Build EPM but not its FPMs Hand down Adds a new FPM for the EPM Deletes the EPM Generates only the EPM without its FPMs This feature is only available in the context menu. The values of the properties Version and Release of the subordinate FPMs are overwritten by the EPM values. This feature is only available in the context menu. (FPM) Add new Folder Delete FPM Beschreibung Adds a new directory Deletes the FPM 11

12 (FPM) Create Symbolic Link Calculate size and files Move down/up (File) Delete File Strip Edit Beschreibung Creates a Symbolic Link to a file or directory Calculates the size and number of files Moves the selected FPM down/up by one position Deletes the file from the FPM Executes the strip command for the selected file Opens the file for editing in an external editor (see preferences). This option is available for every file, even binary files. This feature is only available in the context menu. Context menus in the File Browser The File Browser provides a context menu for directories and files. Directory File Add selected Add with path Adds the object with its content to the FPM or directory selected in the Workspace Browser Adds the object with its superior directories to the FPM or directory selected in the Workspace Browser Set as base dir Defines the top level of the File Browser Edit Opens file for editing in an external editor 3.4. File Browser The File Browser is used to add files and directories to an FPM. In addition to files and directories, the browser also displays the size in bytes, date/time of the last changes and the access rights (in octal numeral system). Adding a file or directory to an FPM 1. In the Workspace Browser, select the relevant FPM or subordinate directory. 2. In the File Browser, to add an object with its content, right-click the relevant file or directory, and on the context menu,click Add selected. 3. In the File Browser, to add an object with its superior directories, right-click the relevant file or directory, and on the context menu,click Add with path. Files and directories that you add, keep the following properties: 12

13 3. elux Builder Kit interface Date and time of the last change Owner Group File permissions Defining top level of File Browser On the context menu of the relevant directory, click Set as base dir. 13

14 3.5. Build section The Build section helps you define some options such as whether the packages are signed and packed into a ZIP archive. These settings are saved within the workspace and are applied when the workspace is loaded. Build - Container Output Directory Build s Target container Target directory where the created packages, signatures and the zip archive are copied to. elux Builder Kit automatically creates subdirectories having the container s name in the output directory Sign packages The created packages are to be signed and will be verified in ELIASfor a valid signature. only available if the path for the signing program eluxsign and the key and certificae are defined in the preferences Create ZIP archives For each EPM, a separate ZIP archive is created. The archive contains the EPM, all FPMs and the signatures for the EPM and FPMs. Build View Log Starts the build process for the selected EPM or FPM in the Workspace Browser. If the whole workspace is selected, the build is executed for all contained packages. Displays the log file of the workspace The log file includes detailed information about the creation of packages Output Window In the output window, elux Builder Kit displays status messages such as Progress of the current build process Creation of a new workspace Loading/Saving a workspace Deleting messages from the output window Select the menu option Log > Clear output window. 14

15 4. Package properties in the Properties Editor 4. Package properties in the Properties Editor Some package properties (meta data) can be edited directly in the fields of the Properties Editors. Other properties require a specific editor to be modified. Then, for the selected property, a button is shown in the Value field. To edit a property of an EPMs or FPM which requires a specific editor, click., Pre-/Postinstall, Pre-/Postuninstall and Comment For these properties, a plain text editor is used. Enter or modify text and confirm with Save. Requires and Conflicts Note The Requires property of an EPM always includes the entry %ELUX_BASEREQ. The entry specifies that the package being created requires an installed elux-baseos. Property entries list Lists the defined entries for Requires or Conflicts. Format: Package name Operator Version If you select an entry, you edit it in the Entry settings section. Delete New Entry The selected entry is deleted. Creates a new entry NewEntry 15

16 Packagename Name of the entry The name must correspond to the name of another existing package. Operator Operator that applies to the version defined in Version If the version of a package is irrelevant, select the operator <none>. The entry then is applied to all versions of the package in Packagename. Version Specifies the version of the package defined in Packagename. License To obtain a valid license for your package, please contact Unicon Software Entwicklungs- und Vertriebsgesellschaft mbh by sales@unicon-software.com. Save Clear Enabled only if all three entry fields have been filled correctly Deletes the current license To finally delete the license, click Save. Containers In this editor, you define for which container the EPM or FPM will be created. The setting affects only the current package. Installoption only für FPMs Mandatory Install Beschreibung FPM must be installed Choose between two sub-options: as default The FPM, but can be deselected in ELIAS. optional The FPM is not installed by default, but can be selected in ELIAS for the installation. Force uninstall instead of update uindependent of Mandatory or Install Before an FPM package is installed, elux is forced to first uninstall the old FPM package, if available, instead of performing an update. 16

17 5. Creating individual packages in the elux Builder Kit 5. Creating individual packages in the elux Builder Kit To create your own packages, first define a new workspace and then EPM und FPM packages including meta data Creating a new Workspace 1. Click File > New Workspace. 2. Edit the following fields: Workspace name Workspace directory Use workspace name to create a subdirectory Name of the new workspace Target directory for the new workspace In the selected target directory, a subdirectory with the workspace s name is created. The workspace will be saved in this subdirectory. Important: If you clear this option, the target directory must be empty. 3. Confirm with OK. The new workspace is created and loaded into the Workspace Browser. Subsequently, you can create EPMs and FPMs, see Defining new packages Creating a folder 1. In the Workspace Browser, select the relevant FPM or one of its subfolders. 2. Click Add or right-click the object and click Add new folder on the context menu. 3. Enter a nemae for the folder and confirm with Finish. Continue to create folders or or add files to this folder by using the File Browser. 17

18 5.3. Defining new packages EPMs and FPMs are added as objects to an existing workspace. Rules for naming packages Allowed characters are a-z, A-Z, 0-9, _ We recommend that you avoid uppercase letters. Package names must be unique. A package name may only exist once, regardless of whether it is an EPM or FPM. Package names are composed of the following elements: <name>-<version>-<release>.<container>.[epm fpm] Beispiel: baseosrp uc_rp6-1.0.epm Do not rename package files after the build process Adding an EPM 1. In the Workspace Browser, select the workspace object (top level). 2. Click Add or Right-click the workspace object, and on the context menu, click Add new EPM. 3. Enter a name for the EPM and confirm with Finish. Subsequently, edit the properties of the EPM in the Properties Editor, see Package properties in the Properties Editor. Also, you can add further EPMs or FPMs to this EPM Adding an FPM 1. In the Workspace Browser, select the relevant EPM. 2. Click Add. or Right-click the EPM Object, and on the context menu, click Add new RPM. 3. Enter a name for the FPM and confirm with Finish. 4. Select the FPM in the Workspace Viewer to edit the FPM properties with the Properties Editor. You can also create additional FPMs or add files, directories and Symbolic Linkto the FPM. To add objects to the FPM, use the File Browser. For further information, see File Browser. Subsequently, edit the properties of the FPM in the Properties Editor, see Package properties in the Properties Editor. 18

19 5. Creating individual packages in the elux Builder Kit Also, you can add further FPMs or add a symbolic link to the FPM Creating a Symbolic link A Symbolic Link is a kind of pointer to a file or directory located in a different location. A symbolic link can only be created directly in an FPM or in one of its subfolders. 1. Select the relevant FPM or one of its subfolders. 2. Click the icon on the toolbar or select the Create symbolic link option by right-clicking the FPM or its subfolder on the context menu. 3. Edit the following fields: Content dialog box Name of symbolic link Enter the target to which the symbolic link will point Select link target Name for the symbolic link By default, the name is automatically taken over from the entry in [2] or [3]. If you want to create a name yourself or customize the automatically generated one, deactivate the Generate symbolic name automatically option. Enter the link target. If you want the link to point to a file or folder within the current FPM, use the Select link target button instead. Displays a list of all files and folders of the current FPM. The correct path of the selected object will then automatically be copied to Enter the target Confirm your entries with OK. The link is created and shown in the corresponding subfolder. When you select the link, you can check the target in the Properties Editor. 19

20 6. elux Builder Kit preferences The Settings > Preferences dialog allows you to set various preferences. Also, on the Build tab, you can configure the certificates if you want to sign your packages. If you have defined invalid settings, a message is shown. For further information, see Invalid settings. Note Be careful because for elux SDK VM 2.3, the Cancel button does not work as expected. The settings will not be undone Global tab Add a comment to the Workspace, EPM or FPM when adding or deleting items elux Builder Kit automatically adds a comment to the superior element (Workspace, EPM or FPM) when one of the following actions is carried out: Action Add Delete Create Import Link...a file to an FPM...a folder to an FPM...an EPM from a workspace...an FPM from an EPM...a file from an FPM...a folder from an FPM...an EPM in a workspace...an FPM in an EPM...an EPM from a workspace other than the current one...an EPM from a workspace other than the current one The comments have the following format: DATE TIME: [ACTION] ELEMENTTYPE <ELEMENTNAME> (USER) Format DATE TIME ACTION ELEMENTTYPE current date current time type of action (ADD, CREATE, DELETE, IMPORT, LINK) element type where the action has been performed (EPM, FPM, FILE, DIRECTORY) 20

21 6. elux Builder Kit preferences Format ELEMENTNAME USER element name name of the user who has performed the action Further options Increment release of EPMs/FPMs when they were changed The release number of an EPM or FPM is automatically incremented as soon as you modify at least one property of the EPM/FPM. Incrementing the release number is not performed immediately, but when the workspace is saved for the first time or when you click the Build button. Before the release number is incremented by elux Builder Kit, a message is shown. If you confirm with Yes, the release numbers of all modified EPM/FPMs are incremented by one counter Restrictions The action of adding files or folders to an FPM is not registered as a change by the elux Builder Kit. The previous release number of the modified EPM/FPM must be numeric. If the previous release number is not numeric, elux Builder Kit sets a 0. Open last workspace on startup Use external text editor When elux Builder Kit is started, the workspace most recently used is automatically opened. Text files are edited by using an external editor. By default, elux Builder Kit opens an Xterm shell and starts the vi editor. Alternatively, select another edtor by clicking he Browse button or start an editor from the command line. Restrictions elux Builder Kit cannot distinguish text files from binary files. Thus, it is possible to open all files in the defined editor. The selected editor must accept the file to be edited as a transfer parameter. Defaults Resets the settings to the default values for the current tab 21

22 6.2. Build tab Strip Zip location eluxbuildrc location Temp folder eluxsign location Signature key Signature certificate Parameters for the strip command to a file Path to the zip program Path to the eluxbuildrc file Note that elux Builder Kit needs the write permission for this file! Folder for temporary files. Path to the eluxsign program which is required to sign the created packages Path to your key file Path to your certificate file Note To enable the signing of packages, all of the signature settings (eluxsign location, Signature Key, Signature Certificate) must be specified correctly. If one of the settings is incorrect, signing will be deactivated EPM/FPM tab Use default properties Copyright Vendor elux Builder Kit transfers the values entered under Copyright and Vendor to the corresponding properties when you create new EPMs or FPMs. Text that is set for each new EPM or FPM for the Copyright property. Text that is set for each new EPM or FPM for the Vendor property. 22

23 6. elux Builder Kit preferences 6.4. Invalid settings If you make incorrect settings and confirm with OK, a message is displayed and the incorrect settings are colored red. Important If you click Cancel, the invalid settings are undone and the preferences are reset to the former ones. 1. Confirm with OK. 2. Correct the incorrect settings. 3. Click OK to save the settings. Value must be valid No value allowed Strip command no yes Zip location yes nein elxubuildrc yes nein Temp folder yes nein eluxsign location yes yes Signature Key yes yes Signature Certificate yes yes 23