diff --git a/docs/developer-guide/emt-system-requirements.md b/docs/developer-guide/emt-system-requirements.md index df18cd887e..9dfc0f0beb 100644 --- a/docs/developer-guide/emt-system-requirements.md +++ b/docs/developer-guide/emt-system-requirements.md @@ -35,7 +35,6 @@ and workloads. It has been validated on the following platforms: | Intel® Arc™ B580 | NVIDIA® Tesla® P100 | | | GeForce RTX™ 3090 | - ## Recommended Hardware Configuration ### Edge Microvisor Toolkit Developer Node @@ -54,7 +53,6 @@ and workloads. It has been validated on the following platforms: | Storage (SSD/NVMe or eMMC) | 64 GB | 512 GB | 1 TB | | Networking (Ethernet) | 1 GbE or higher | 1 GbE or higher | 1 GbE or higher | - ## Software Requirements | Component | Edge Microvisor Toolkit Developer Node | Edge Microvisor Toolkit (Edge Manageability Framework or Standalone Node) | @@ -62,3 +60,9 @@ and workloads. It has been validated on the following platforms: | Kernel Version | Intel® Kernel 6.12 | Intel® Kernel 6.12 | | Bootloader | GRUB | Systemd-boot | | Update Mechanism | RPM-based with TDNF | Image-based A/B updates | + +## Minimum Hardware Configuration for Building OS Image + +| CPU | RAM | Storage | +|---|---|---| +| 13th, 14th Generation Intel® Core™ (Raptor Lake),
4 cores | 32 GB
(25 GB free) | 250 GB (200 GB free) | \ No newline at end of file diff --git a/docs/developer-guide/get-started/emt-build-and-deploy.md b/docs/developer-guide/get-started/emt-build-and-deploy.md index 345136e4a3..b079718c31 100644 --- a/docs/developer-guide/get-started/emt-build-and-deploy.md +++ b/docs/developer-guide/get-started/emt-build-and-deploy.md @@ -18,6 +18,11 @@ meet specific edge deployment needs. You can choose between: 3. [Install the toolkit on an edge device.](#3-install-the-toolkit-on-an-edge-device) 4. [Deploy AI solution.](#4-deploy-ai-solution) + +## Requirements + +Make sure your machine meets the [minimum hardware configuration](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image). + ## 1. Build the microvisor If you want to create your own custom standalone node, follow the instructions below to build @@ -109,7 +114,11 @@ For example, to build a RAW image without real-time extensions, use `edge-image. > release, make sure to build it **without** the `REBUILD_PACKAGES=n` option to > perform a full local rebuild. > -> Keep in mind, that it will take time (~18 hours on a machine with a 20+ core CPU). +> Keep in mind, that it will take time +> +> - ~18 hours on a machine with a 20+ core CPU, +> - ~24-36 hours on a machine meeting the +> [minimum hardware requirements](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image). 1. Clone the release branch of edge-microvisor-toolkit repository: @@ -175,6 +184,13 @@ For example, to build a RAW image without real-time extensions, use `edge-image. 7. Rebuild RPM packages. + **Important**: On a machine with limited resources, meeting + [minimum hardware configuration](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image), + make sure to add `-j2 CONCURRENT_PACKAGE_BUILDS=4` parameters to avoid crashes. + You can increase them to `-j4 CONCURRENT_PACKAGE_BUILDS=6` + or even not include them at all when rebuilding the packages on a machine + that greatly exceeds the minimum requirements. + ```bash # Rebuild packages/RPMs local toolchain sudo make build-packages REBUILD_TOOLS=y VALIDATE_TOOLCHAIN_GPG=n diff --git a/docs/developer-guide/get-started/emt-building-howto.md b/docs/developer-guide/get-started/emt-building-howto.md index 86c8eb5050..ba6e27f8fb 100644 --- a/docs/developer-guide/get-started/emt-building-howto.md +++ b/docs/developer-guide/get-started/emt-building-howto.md @@ -44,7 +44,7 @@ git clone https://github.com/open-edge-platform/edge-microvisor-toolkit --branch > **Note:** > - > - Building the **entire toolchain** may take a lot of time. Adding the + > - Building the **entire toolchain** may take time. Adding the > `REBUILD_TOOLCHAIN=y` parameter to the `make` command rebuilds > the entire toolchain. > - It is recommended to start from a clean build directory and remove @@ -71,6 +71,13 @@ git clone https://github.com/open-edge-platform/edge-microvisor-toolkit --branch 3. Rebuild RPM packages. + **Important**: On a machine with limited resources, meeting + [minimum hardware configuration](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image), + make sure to add `-j2 CONCURRENT_PACKAGE_BUILDS=4` parameters to avoid crashes. + You can increase them to `-j4 CONCURRENT_PACKAGE_BUILDS=6` + or even not include them at all when rebuilding the packages on a machine + that greatly exceeds the minimum requirements. + ```bash # Rebuild packages/RPMs sudo make build-packages REBUILD_TOOLS=y VALIDATE_TOOLCHAIN_GPG=n @@ -104,13 +111,20 @@ You can find more information about specific parameters in the [build variables] **IMPORTANT**: To create an image from an older tag, for example the [3.0.20250718](https://github.com/open-edge-platform/edge-microvisor-toolkit/releases/tag/3.0.20250718) -release tag, make sure to build it **without** the `REBUILD_PACKAGES=n` option. +release tag, make sure to build it **without** the `REBUILD_PACKAGES=n` option +to perform a full rebuild. Otherwise, the build process will download the latest available RPMs, which do not match those included in the older tag. It will cause a mismatch between versions of installed RPMS in the image and the available SPECs in Edge Microvisor Toolkit code. -To build an ISO image, run the following command: +> **Note**: Keep in mind that performing a full rebuild will take time: +> +> - ~18 hours on a machine with a 20+ core CPU, +> - ~24-36 hours on a machine meeting the +> [minimum hardware requirements](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image). + +To build an ISO image, you can run the following command: ```bash sudo make iso -j8 REBUILD_TOOLS=y CONFIG_FILE=./imageconfigs/full.json @@ -129,10 +143,6 @@ To build a RAW image with real-time extensions, use the following command: sudo make image -j8 REBUILD_TOOLS=y CONFIG_FILE=./imageconfigs/edge-image-rt.json ``` -Keep in mind, that building without `REBUILD_PACKAGES=n` will perform a full -rebuild based on the tag and take time (~18 hours on a machine with -a 20+ core CPU). - ## Customize Your Edge Microvisor Toolkit Image To add packages to the default image, you can define your own `packagelist.json` file, pointing to RPMs that should be included in the image.