Attention

You are viewing an older version of the documentation. The latest version is v3.3.

acrn-sos

The following section is applicable to:

This section provides the steps to build an ECI acrn-sos (ECI-A) image.

Prerequisite

Make sure that you complete the steps in Setting up ECI Build before proceeding to build an ECI acrn-sos image.

Building ECI ``acrn-sos`` Image

The ECI acrn-sos Yocto target image provides the ACRN Hypervisor, service OS (SOS), and software utilities to manage virtual machines (VMs).

Important

ACRN is only supported on specific target platforms. For a list of platforms that support ACRN, refer to Validated Hardware Platforms. To build ACRN for non-supported platforms, refer to Compiling ACRN for different platforms.

1. Run the setup script:

   $ ./setup.sh
   

   

2. A list of pre-configured use cases will be displayed. Select custom to start configuring a custom build.

   

3. A list of available build targets will be displayed. Select acrn-sos from the list.

   

4. There are multiple methods to launch virtual machines (VMs) on ACRN. The table below describes the available options. Select the desired option from the list. Note: It is recommended to select VM Launch Scripts for novice users of ACRN.

   

   VM Launch Method	Description
   VM Launch Scripts	Utilize scripts to launch VMs with generic configurations (ex: CPU, Memory). These scripts are always included in the target image. For detailed information on which launch scripts are available and what usage they are best suited for, see section VM launch scripts. Note: This option is the simplest method and is recommended for novice users of ACRN.
   VM Profile Tool	The VM Profile Tool is a menu-based interactive guide which generates a VM profile for use by automation scripts included in the target image. This tool allows a user to customize VM configurations (ex: CPU, Memory) while ensuring a valid configuration for the desired target hardware platform. For detailed information on launching VMs using the VM Profile Tool, see section VM Profile Tool.

   VM Launch ScriptsVM Profile Tool

   1. After selecting VM Launch Scripts, a menu will appear with the available target hardware platforms. The ACRN hypervisor is compiled based on the selected target hardware platform. On the following prompt, select the target hardware platform to compile for using the arrow keys to move the selection and spacebar to toggle the state. When complete, press the enter key to finalize the selection.

      

      The following table lists the available options:

      Target Hardware Platform	Description
      Maxtang WHL i7	Maxtang PC with Whiskey Lake Core-i7
      Maxtang WHL i5	Maxtang PC with Whiskey Lake Core-i5
      Vecow SPC-5200 WHL i7	Vecow PC with Whiskey Lake Core-i7
      Vecow SPC-7100 TGL i7	iEi Tank PC with Kaby Lake Core-i5
      K700 CFL i7	Karbon 700 with Coffee Lake (Refresh) Core-i7
      EHL-CRB Atom	Elkhart Lake Customer Reference Board
      TGL-RVP i7	Tiger Lake Reference Validation Platform

   2. On the following prompt, it is possible to modify the build configuration of the acrn-sos target image. Select/deselect features to be included in the image using the arrow keys to move the selection and spacebar to toggle the state. When complete, press the enter key to finalize the selection.

      

      The following table lists the available options:

      Feature Option	Description
      SDK (build tools and dev pkgs)	Adds GCC and Make to the target image.
      Intel® Castle Lake Dependencies	Adds kernel modules and tools necessary to support an Intel® Castle Lake Client.
      Intel® Time Coordinated Computing	Enables Intel® Time Coordinated Computing Tools (Intel® TCC Tools) features. Attention Intel TCC Tools features are only supported on 11th Gen Intel® Core™ and Intel Atom® x6000E Series processors.
      Trusted VM	Embed a pre-launched VM to manage TPM access.
      Secure Boot	Creates a signed bootloader and boot artifacts for use with Secure Boot.
      Kubernetes	Adds binaries required to join a Kubernetes cluster.
      Kernel source	Adds kernel source & header files to the target image.
      *Experimental*	Enables experimental features.

   3. The setup script will begin downloading and configuring the assets needed to build the target image. Depending on the feature options selected and state of the build environment, a few notifications may occur. Some of these notifications are described below.

      If the setup script is not building the target for the first time, the script will prompt: Build directory ecs-acrn-sos already exists. Do you want to clean the cached build? y/[n]

      

      Press n to retain the target build cache, or press y to delete target build cache.

      Note

      It is recommended that you delete the target build cache if the target source was modified or the previous build was incomplete. Retaining the target build cache will reduce the build time, but might cause build errors if the target source was modified or the previous build was incomplete. If build errors occur, rerun the setup script and choose y at this prompt.

      For all other notifications, click the following links:

      • Build Notifications
        • CODESYS Linux runtime package not found
        • Build directory already exists
        • Detected lock files for target
        • System memory below recommended minimum

   4. After setting up the build target, a prompt will appear: Do you want to run an automated build? y/[n]. Note: Automated builds give the option to automatically build and embed ECI images as ACRN VMs. It is recommended to perform an automated build for novice ACRN users.

      
      Automated BuildManual Build

      1. To perform an automated build, press y at the prompt.

         

      2. After selecting to perform an automated build, a prompt will appear asking Embed an ECI image for use as an ACRN VM?. This prompt gives the ability to automatically build an ECI image and have it embedded into the ACRN image so that it can be launched as a VM using the VM launch scripts. To embed an ECI image as an ACRN VM, select Yes at the prompt.

         Note: The embedded ECI image will automatically be built with the following feature options enabled: SSH Server, EC Protocol Bridge, Desktop Environment / Graphics, and Intel® Time Coordintated Computing. This automated build will overwrite any existing build.

         

      3. If Yes was selected to embed an ECI image, a menu will appear with the available ECI image options. Select an ECI image to build and embed as an ACRN VM.

         

The build typically takes a very long time. A Linux build system with the recommended specifications might take about 1-2 hours to complete. A Linux build system with the minimum specifications might take over 6 hours to complete. Refer Linux Build System for the recommended specifications.

After the build completes, refer to Installing ECI-A to create a bootable USB flash drive to install the ECI-A image.