Skip to content

Commit a00c0ea

Browse files
committed
fix: add notes about only UEFI being supported
Signed-off-by: Sergei Lukianov <[email protected]>
1 parent 6edebd7 commit a00c0ea

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

docs/install-upgrade/install.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@
55
* A machine with access to the Internet to use Fabricator and build installer with at least 8 GB RAM and 25 GB of disk space
66
* An 16 GB USB flash drive, if you are not using virtual media
77
* Have a machine to function as the Fabric Control Node. [System Requirements](./requirements.md) as well as IPMI access to it to install
8-
the OS.
8+
the OS. Only UEFI is supported.
99
* A management switch with at least 1 10GbE port is recommended
1010
* Enough [Supported Switches](./supported-devices.md) for your Fabric
1111

12+
!!! tip "Control nodes on virtual machines"
13+
Running control nodes on virtual machines is possible, although not officially supported. If you use virtual
14+
machines, make sure to use UEFI boot.
15+
1216
## Overview of Install Process
1317

1418
This section is dedicated to the Hedgehog Fabric installation on bare-metal control node(s) and switches, their
@@ -34,11 +38,11 @@ The main steps to install Fabric are:
3438

3539
## Build Control Node configuration and Installer
3640
Hedgehog has created a command line utility, called `hhfab`, that helps generate the wiring diagram and fabric configuration,
37-
validate the supplied configurations, and generate an installation image (.img or .iso) suitable
41+
validate the supplied configurations, and generate an installation image (.img or .iso) suitable
3842
for writing to a USB flash drive or mounting via IPMI virtual media. The first `hhfab` command to
39-
run is `hhfab init`. This will generate the main configuration file, `fab.yaml`. `fab.yaml` is
40-
responsible for almost every configuration of the fabric with the exception of the wiring. Each
41-
command and subcommand have usage messages, simply supply the `-h` flag to your command or sub
43+
run is `hhfab init`. This will generate the main configuration file, `fab.yaml`. `fab.yaml` is
44+
responsible for almost every configuration of the fabric with the exception of the wiring. Each
45+
command and subcommand have usage messages, simply supply the `-h` flag to your command or sub
4246
command to see the available options. For example `hhfab vlab -h` and `hhfab vlab gen -h`.
4347

4448
### HHFAB commands to make a bootable image

docs/install-upgrade/requirements.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ In order to provision and manage the switches that comprise the fabric, an out o
66

77
## Control Node
88

9+
- Only UEFI is supported
910
- Fast SSDs for system/root is mandatory for Control Nodes
1011
- NVMe SSDs are recommended
1112
- DRAM-less NAND SSDs are not supported (e.g. Crucial BX500)
@@ -16,7 +17,7 @@ In order to provision and manage the switches that comprise the fabric, an out o
1617

1718
In internal testing Hedgehog uses a server with the following specifications:
1819

19-
- CPU - AMD EPYC 4344P
20+
- CPU - AMD EPYC 4344P
2021
- Memory - 32 GiB DDR5 ECC 4800MT/s
2122
- Storage - PCIe Gen 4 NVMe M.2 400GB
2223
- Network - AOC-STG-i4S Intel X710-BM1 controller

0 commit comments

Comments
 (0)