IC OS Installation Runbook - Supermicro
This runbook covers all steps necessary to install the Internet Computer Operating System (hereinafter called IC-OS).
The physical machine is expected to be racked and stacked according to the respective manual.
In case you encounter any issues during the installation process, note that you can check the Possible Node Onboarding Errors page.
Many thanks for your efforts in building the Internet Computer.
Requirements
- A USB (3.0 speed that can hold at least 4GB) to put the image file on (Faster USBs will allow the process to go much faster.)
- The Nitrokey HSM for your data center.
- A USB hub is helpful at some data centers, so you may wish to have one available.
I. Download installation image
Follow the instructions on the IC-OS Download Page
II. Verify checksum and unarchive file
Mac OS X
- Open the Terminal and type:
shasum -a 256 ~/Downloads/disk-img.tar.gz
- Compare the calculated checksum with the file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please contact the Internet Computer Association.
- Open the Terminal and type:
tar xzvf ~/Downloads/disk-img.tar.gz
Linux / Ubuntu
- Open the Terminal and type:
sha256sum ~/Downloads/disk-img.tar.gz
- Compare the calculated checksum with the file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please contact the Internet Computer Association.
- Open the Terminal and type:
tar xzvf ~/Downloads/disk-img.tar.gz
Windows
- Open PowerShell and type:
Get-FileHash -Algorithm SHA256 .\Downloads\disk-img.tar.gz
- Compare the calculated checksum with the file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please contact the Internet Computer Association.
- Open PowerShell and type:
tar xzvf .\Downloads\disk-img.tar.gz
All Operating Systems
- Compare the calculated checksum with the one provided by the DFINITY foundation. Only continue if they are identical, otherwise please contact the DFINITY foundation.
III. Create Bootable USB Stick
Mac OS X
- Open the Terminal and type:
diskutil list
- The diskutil command simply shows all available drives. Verify the drive that identifies your USB stick.
- In this next command, edit /dev/sda if needed so that it refers to your USB stick and not any other drive. Warning: You risk losing your own data if you specify a wrong drive.
dd if=~/Downloads/disk.img of=/dev/sda bs=1M
Linux / Ubuntu
- Open the Terminal and type
blkid
- The blkid command simply shows all available drives. Verify the drive that identifies your USB stick.
- In this next command, edit /dev/sda if needed so that it refers to your USB stick and not any other drive. Warning: You risk losing your own data if you specify a wrong drive.
dd if=~/Downloads/disk.img of=/dev/sda bs=1M
Windows
- Download Rufus Portable from: https://rufus.ie/en/
- Start Rufus
- Select the USB stick under device and select the previously downloaded IC-OS disk image and press start
- You may see some warnings. Make sure you don't have any other USBs in your computer and chose OK
- The "Ready" bar will go from left to right as it completes.
IV. Add configuration
Mac OS X
- Open Finder. You should now be able to see the CONFIG partition. If it's not visible, remove the USB and insert it again.
- Double-click to open it in TextEdit.
- Insert your IPv6 prefix, subnet and gateway.
- Once done, don’t forget to save the changes. If you need help, please do not hesitate to contact the Internet Computer Association.
Windows
- Open the Disk Management utility with a right click on the Start menu
- Right click the CONFIG partition
- Select Change drive letter or paths...
- Select any letter from the drop-down list
- Click OK.
- You should now be able to see the CONFIG partition in your Windows Explorer. Select the config.ini configuration file
- Click on Edit to open it.
- Insert your IPv6 prefix, subnet and gateway.
- Once done, don’t forget to save the changes. If you need help, please do not hesitate to contact the Internet Computer Association.
Linux
- Open the File Manager. You should now be able to see the CONFIG partition. If it's not visible, remove the USB and insert it again.
- Double-click to open it in KWrite.
- Insert your IPv6 prefix, subnet and gateway.
- Once done, don’t forget to save the changes. If you need help, please do not hesitate to contact the Internet Computer Association.
V. Connect Crash Cart
- In order to configure the UEFI and initiate the installation of the IC-OS, please connect a crash cart to the physical machine.
- Plug-in the VGA/Video, keyboard and IC-OS USB stick
VI. UEFI - Enter Setup
- Reboot or power on the server.
- Watch for the screen with the Supermicro logo and boot options underneath it. Press DEL (delete) a couple of times, once the options are listed.
- If your option is recognized by the system, it will say: Entering Setup…
VII. UEFI - Advanced Settings
- Change to the Advanced menu. Then select Boot Feature and press enter
- Set Wait For "F1" If Error to Disabled ; press ESC (escape) to return to previous menu
- Select ACPI Settings and press enter
- Set PCI AER Support to Enabled ; set NUMA Nodes Per Socket to NPS0 ; press ESC (escape) to return to previous menu
- Select CPU Configuration and press enter
- Set SMEE to Enabled; press ESC (escape) to return to previous menu
- Select NB Configuration and press enter
- Set 4-link xGMI max speed to Auto; press ESC (escape) to return to previous menu
- Select PCIe/PCI/PnP Configuration and press enter
- Set SR-IOV Support to Enabled; Set NVMe Firmware Source to AMI Native Support; Set M.2 (ACPI) Firmware Source to AMI Native Support; Press ESC (escape) to return to previous menu
VIII. UEFI - Boot Settings
- Change to the Boot menu; Set Boot Mode Select to UEFI
- Change to Save & Exit menu, then select Save Changes and Reset and press enter
- Select Yes and press enter. The system will now reboot. Please do not unplug the IC-OS USB stick at this point.
IX. Booting the USB image
Please remember to check the Possible Node Onboarding Errors page if you encounter any errors onboarding.
- Watch for the screen with the Supermicro logo and boot options underneath it. Press F11 a couple of times, once the options are listed.
- If your option is recognized by the system, it should be saying Invoking Boot Menu
- In the Boot Menu, select the first partition on the USB device and press enter
- Please wait while the USB Installer is booting up. This process can take up to 3 minutes.
- The IC-OS installation starts. Please keep an eye on the progress. This part can take up to 8 minutes. Please remember to check the Possible Node Onboarding Errors page if you encounter any errors.
- Once you get asked to insert the HSM, please remove the keyboard and instead insert the HSM USB device.
- If the installation finished successfully, it will initiate a reboot. Please do not unplug the USB stick or HSM USB device at this point.
- You may see an error at the end of installation with text "psc failed", "snp_leak_pages" or similar errors with "snp". This will occur after the "Reached target Reboot" message (which may have scrolled off screen). This is a known issue.
- If this happens power off the machine and power on manually. The rest of the process will continue as normal.
X. First Boot
Please remember to check the Possible Node Onboarding Errors page if you encounter any errors onboarding. *Do NOT re-try the onboarding after proceeding to this section, as this can cause duplication within the registry.
- The first boot of the IC-OS still requires the HSM USB device. Please wait until further instructions. This step can take up to 2 minutes.
- Once you see this message, you may unplug the HSM USB device, USB stick and VGA/Video. Your machine successfully joined the Internet Computer.
- Record the first five characters of the node principal that is shown on the screen so the Node Provider can identify the node in the public dashboard.