Skip to content

Commit 329ea0c

Browse files
[DOCS] Information on minimum requirements for building (open-edge-platform#630)
* [DOCS] Add information on Minimum Hardware Requirements * Update docs/developer-guide/emt-system-requirements.md
1 parent 11a207f commit 329ea0c

3 files changed

Lines changed: 40 additions & 10 deletions

File tree

docs/developer-guide/emt-system-requirements.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ and workloads. It has been validated on the following platforms:
3535
| Intel® Arc™ B580 | NVIDIA® Tesla® P100 |
3636
| | GeForce RTX™ 3090 |
3737

38-
3938
## Recommended Hardware Configuration
4039

4140
### Edge Microvisor Toolkit Developer Node
@@ -54,11 +53,16 @@ and workloads. It has been validated on the following platforms:
5453
| Storage (SSD/NVMe or eMMC) | 64 GB | 512 GB | 1 TB |
5554
| Networking (Ethernet) | 1 GbE or higher | 1 GbE or higher | 1 GbE or higher |
5655

57-
5856
## Software Requirements
5957

6058
| Component | Edge Microvisor Toolkit Developer Node | Edge Microvisor Toolkit (Edge Manageability Framework or Standalone Node) |
6159
|------------------|-------------------------|-------------------------|
6260
| Kernel Version | Intel® Kernel 6.12 | Intel® Kernel 6.12 |
6361
| Bootloader | GRUB | Systemd-boot |
6462
| Update Mechanism | RPM-based with TDNF | Image-based A/B updates |
63+
64+
## Minimum Hardware Configuration for Building OS Image
65+
66+
| CPU | RAM | Storage |
67+
|---|---|---|
68+
| 13th, 14th Generation Intel® Core™ (Raptor Lake), <br> 4 cores | 32 GB <br> (25 GB free) | 250 GB (200 GB free) |

docs/developer-guide/get-started/emt-build-and-deploy.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ meet specific edge deployment needs. You can choose between:
1818
3. [Install the toolkit on an edge device.](#3-install-the-toolkit-on-an-edge-device)
1919
4. [Deploy AI solution.](#4-deploy-ai-solution)
2020

21+
22+
## Requirements
23+
24+
Make sure your machine meets the [minimum hardware configuration](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image).
25+
2126
## 1. Build the microvisor
2227

2328
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.
109114
> release, make sure to build it **without** the `REBUILD_PACKAGES=n` option to
110115
> perform a full local rebuild.
111116
>
112-
> Keep in mind, that it will take time (~18 hours on a machine with a 20+ core CPU).
117+
> Keep in mind, that it will take time
118+
>
119+
> - ~18 hours on a machine with a 20+ core CPU,
120+
> - ~24-36 hours on a machine meeting the
121+
> [minimum hardware requirements](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image).
113122
114123
1. Clone the release branch of edge-microvisor-toolkit repository:
115124

@@ -175,6 +184,13 @@ For example, to build a RAW image without real-time extensions, use `edge-image.
175184

176185
7. Rebuild RPM packages.
177186

187+
**Important**: On a machine with limited resources, meeting
188+
[minimum hardware configuration](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image),
189+
make sure to add `-j2 CONCURRENT_PACKAGE_BUILDS=4` parameters to avoid crashes.
190+
You can increase them to `-j4 CONCURRENT_PACKAGE_BUILDS=6`
191+
or even not include them at all when rebuilding the packages on a machine
192+
that greatly exceeds the minimum requirements.
193+
178194
```bash
179195
# Rebuild packages/RPMs local toolchain
180196
sudo make build-packages REBUILD_TOOLS=y VALIDATE_TOOLCHAIN_GPG=n

docs/developer-guide/get-started/emt-building-howto.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ git clone https://github.com/open-edge-platform/edge-microvisor-toolkit --branch
4444

4545
> **Note:**
4646
>
47-
> - Building the **entire toolchain** may take a lot of time. Adding the
47+
> - Building the **entire toolchain** may take time. Adding the
4848
> `REBUILD_TOOLCHAIN=y` parameter to the `make` command rebuilds
4949
> the entire toolchain.
5050
> - 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
7171

7272
3. Rebuild RPM packages.
7373

74+
**Important**: On a machine with limited resources, meeting
75+
[minimum hardware configuration](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image),
76+
make sure to add `-j2 CONCURRENT_PACKAGE_BUILDS=4` parameters to avoid crashes.
77+
You can increase them to `-j4 CONCURRENT_PACKAGE_BUILDS=6`
78+
or even not include them at all when rebuilding the packages on a machine
79+
that greatly exceeds the minimum requirements.
80+
7481
```bash
7582
# Rebuild packages/RPMs
7683
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]
104111

105112
**IMPORTANT**: To create an image from an older tag, for example the
106113
[3.0.20250718](https://github.com/open-edge-platform/edge-microvisor-toolkit/releases/tag/3.0.20250718)
107-
release tag, make sure to build it **without** the `REBUILD_PACKAGES=n` option.
114+
release tag, make sure to build it **without** the `REBUILD_PACKAGES=n` option
115+
to perform a full rebuild.
108116
Otherwise, the build process will download the latest available RPMs,
109117
which do not match those included in the older tag. It will cause a mismatch
110118
between versions of installed RPMS in the image and the available SPECs in
111119
Edge Microvisor Toolkit code.
112120

113-
To build an ISO image, run the following command:
121+
> **Note**: Keep in mind that performing a full rebuild will take time:
122+
>
123+
> - ~18 hours on a machine with a 20+ core CPU,
124+
> - ~24-36 hours on a machine meeting the
125+
> [minimum hardware requirements](../emt-system-requirements.md#minimum-hardware-configuration-for-building-os-image).
126+
127+
To build an ISO image, you can run the following command:
114128

115129
```bash
116130
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:
129143
sudo make image -j8 REBUILD_TOOLS=y CONFIG_FILE=./imageconfigs/edge-image-rt.json
130144
```
131145

132-
Keep in mind, that building without `REBUILD_PACKAGES=n` will perform a full
133-
rebuild based on the tag and take time (~18 hours on a machine with
134-
a 20+ core CPU).
135-
136146
## Customize Your Edge Microvisor Toolkit Image
137147

138148
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.

0 commit comments

Comments
 (0)