diff --git a/doc/source/installation_guide/index.rst b/doc/source/installation_guide/index.rst index a07db3c9d..5e19d0454 100644 --- a/doc/source/installation_guide/index.rst +++ b/doc/source/installation_guide/index.rst @@ -113,6 +113,30 @@ be deployed, include: The recommended minimum requirements for the physical servers are described later in each StarlingX Deployment Options guide. +^^^^^^^^^^^^^^^^^^^^^^^^ +NVMe Drive as Boot Drive +^^^^^^^^^^^^^^^^^^^^^^^^ + +To use a Non-Volatile Memory Express (NVMe) drive as the boot drive for any of +your nodes, you must configure your host and adjust kernel parameters during +installation: + +- Configure the host to be in UEFI mode. +- Edit the kernel boot parameter. After you are presented with the StarlingX + ISO boot options and after you have selected the preferred installation option + (e.g. Standard Configuration / All-in-One Controller Configuration), press the + TAB key to edit the Kernel boot parameters. Modify the **boot_device** and + **rootfs_device** from the default **sda** so that it is the correct device + name for the NVMe drive (e.g. "nvme0n1"). + + :: + + vmlinuz rootwait console=tty0 inst.text inst.stage2=hd:LABEL=oe_iso_boot + inst.ks=hd:LABEL=oe_iso_boot:/smallsystem_ks.cfg boot_device=nvme0n1 + rootfs_device=nvme0n1 biosdevname=0 usbcore.autosuspend=-1 inst.gpt + security_profile=standard user_namespace.enable=1 initrd=initrd.img + + ******************* Virtual Environment *******************