Merge pull request lxc#493 from stgraber/main

Add VMware instructions

Author: stgraber

doc/.wordlist.txt

@@ -2,8 +2,10 @@ backend
 CDN
 CDROM
 Ceph
+CPUs
 customizations
 customizer
+datastore
 db
 dbx
 DCO
@@ -12,6 +14,7 @@ DHCP
 DNS
 ECDSA
 EOF
+ESXi
 FAT
 fibre
 formatters
@@ -37,8 +40,8 @@ MAC
 MACs
 MOK
 MTU
-Multipath
 multipath
+Multipath
 Netbird
 NTP
 NVMe
@@ -79,8 +82,9 @@ USBIP
 VirtualBox
 VLAN
 VLANs
-VPN
 VMware
+VPN
+vSphere
 WWN
 YAML
 Zabbly

doc/getting-started/installation/virtual-vmware.md

@@ -1 +1,98 @@
 # Installing in a VMware virtual machine
+
+IncusOS can be easily installed in a VMware virtual machine when running with vSphere.
+
+```{note}
+IncusOS requires the use of a virtual TPM device, this appears to require the use of vSphere and won't work on standalone ESXi.
+```
+
+## Get and import install media
+
+Follow the instructions to [get an IncusOS image](../download.md). This document will assume an ISO image is used.
+
+Once downloaded, upload the ISO image to a VMware datastore.
+
+![ISO upload in VMware datastore](../../images/vsphere-upload-vm.png)
+
+## Create a new virtual machine
+
+Pick a name and location.
+
+![Set VM name and location](../../images/vsphere-create-vm1.png)
+
+Pick a server to run the virtual machine on.
+
+![Set server](../../images/vsphere-create-vm2.png)
+
+Select a datastore for the root disk.
+
+![Select datastore](../../images/vsphere-create-vm3.png)
+
+Select the compatibility level (default is fine).
+
+![Pick compatibility level](../../images/vsphere-create-vm4.png)
+
+Select `Linux` and `Other 6.x or later Linux (64-bit)` as the operating system.
+
+![Select operating system](../../images/vsphere-create-vm5.png)
+
+Customize the virtual machine hardware, recommended changes are:
+
+- Set at least 4 CPUs and 4GiB of RAM
+- Add a NVMe controller
+- Set the root disk size to 50GiB and attach it to the NVMe controller
+- Detach the SCSI controller (now unused)
+- Attach a TPM module
+- Attach the previously uploaded ISO image to the CDROM device and make sure to have it connect on start-up
+
+![Customize the virtual machine](../../images/vsphere-create-vm6.png)
+
+In the options tab, under `Boot Options`, make sure that `Secure Boot` is enabled.
+
+![Enable Secure Boot](../../images/vsphere-create-vm7.png)
+
+In the additional options tab, add the following entries:
+
+- `uefi.secureBoot.kekDefault.file0` set to `secureboot-KEK-R1.der`
+- `uefi.secureBoot.dbDefault.file0` set to `secureboot-2025-R1.der`
+- `uefi.secureBoot.dbDefault.file1` set to `secureboot-2026-R1.der`
+
+Then complete the virtual machine creation.
+
+```{note}
+Do not start the virtual machine at this point or it will create a bad Secure Boot state.
+```
+
+## Upload the Secure Boot keys
+Open the datastore view and go to the virtual machine's folder.
+
+Then go to [`https://images.linuxcontainers.org/os/`](https://images.linuxcontainers.org/os/) and download:
+
+- `secureboot-KEK-R1.der`
+- `secureboot-2025-R1.der`
+- `secureboot-2026-R1.der`
+
+Once downloaded, upload those three files to the virtual machine's folder.
+
+![Upload Secure Boot keys](../../images/vsphere-upload-keys.png)
+
+## IncusOS installation
+
+Start the virtual machine, and IncusOS will begin its installation.
+
+```{note}
+VMware takes a very long time to hash the kernel image during boot.
+This leads to a black screen lasting around 3 minutes following the boot loader message.
+```
+
+![Installation](../../images/vsphere-install.png)
+
+Once installed, stop the virtual machine and edit its settings to disconnect the CDROM device.
+
+![Detach the ISO](../../images/vsphere-detach-iso.png)
+
+## IncusOS is ready for use
+
+Start the virtual machine, and IncusOS will perform its first boot configuration. Once complete, follow the instructions for [accessing the system](../access.md).
+
+![Installed system](../../images/vsphere-installed.png)