Node Deployment Guide

This runbook covers all steps necessary to install the Internet Computer Operating System (IC-OS) on Gen-2 hardware. Gen-1 hardware Node Providers should use the Gen-1 runbooks.

The physical machine is expected to be racked and stacked according to its respective manual.

In case you encounter any issues during the installation process, check the Possible Node Onboarding Errors page. Otherwise, post your issue in the IC Node Provider Matrix channel.

Many thanks for your efforts in building the Internet Computer.

Note: the following instructions are for onboarding nodes without using a NitroKey HSM. If you wish to follow the legacy procedure to onboard using a NitroKey HSM, follow the NitroKey HSM installation runbook.

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 or node_operator_private_key.pem for your data center.
• [Optional] A USB hub
  • This is helpful at some data centers for simultaneously connecting keyboard, mouse, Nitrokey, etc..

1. Download installation image

Follow the instructions on the IC-OS Download Page

2. Verify checksum and unarchive file

Mac OS X

1. Open the Terminal and type:

   shasum -a 256 ~/Downloads/disk-img.tar.gz
   

2. Compare the calculated checksum with the file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please post your issue in the IC Node Provider Matrix channel.

   Open the Terminal and type:

   tar xzvf ~/Downloads/disk-img.tar.gz
   

Linux / Ubuntu

1. Open the Terminal and type:

   sha256sum ~/Downloads/disk-img.tar.gz
   

2. Compare the calculated checksum with the file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please post your issue in the IC Node Provider Matrix channel.

   Open the Terminal and type:

   tar xzvf ~/Downloads/disk-img.tar.gz
   

Windows

1. Open PowerShell and type:

   Get-FileHash -Algorithm SHA256 .\Downloads\disk-img.tar.gz
   

2. Compare the calculated checksum with the file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please post your issue in the IC Node Provider Matrix channel.

   Open PowerShell and type:

   tar xzvf .\Downloads\disk-img.tar.gz
   

3. Create Bootable USB Stick

Mac OS X

1. Open the Terminal and type:

   diskutil list
   

2. All available drives should be shown. Identify which device corresponds to your USB stick. You may need to unmount the USB drive:

   sudo diskutil unmount /dev/YOUR_USB_DEVICE_MOUNTED_PARTITION # E.g. /dev/disk4s1
   

3. The file path is an example. Use the absolute path to the downloaded image. Warning: You risk losing your own data if you specify a wrong device.

   sudo dd if=/Users/YOUR_USER_NAME/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M
   

Linux / Ubuntu

1. Open the Terminal and type

   blkid
   

2. All available drives should be shown. Identify which device corresponds to your USB stick. You may need to unmount the USB drive:

   sudo diskutil unmount /dev/YOUR_USB_DEVICE_MOUNTED_PARTITION # E.g. /dev/sdb1
   

3. Replace /dev/YOUR_USB_DEVICE with the device that corresponds to your USB stick. Warning: You risk losing your own data if you specify a wrong drive.

   sudo dd if=~/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M
   

Windows

1. Download and install Rufus Portable
2. Start Rufus
3. Select the USB stick under device and select the previously downloaded IC-OS disk image and press start

   

4. You may see some warnings. Make sure you don't have any other USBs in your computer and chose OK

   

   

5. The "Ready" bar will go from left to right as it completes.

4. Add configuration

Mac OS X

1. Open Finder. You should now be able to see the CONFIG partition. If it's not visible, remove the USB and insert it again.

   

2. Double-click to open it in TextEdit.
3. Insert your IPv6 prefix, subnet and gateway.

   

4. Once done, don’t forget to save the changes. If you need help, please do not hesitate to post your issue in the IC Node Provider Matrix channel.

   

5. If onboarding without a NitroKey HSM, copy node_operator_private_key.pem from Node Provider Onboarding step 5. Setup the Node Operator keys to the CONFIG partition. This file should have the name node_operator_private_key.pem, and sit next to config.ini, NOT inside the ssh_authorized_keys folder.

Windows

1. Open the Disk Management utility with a right click on the Start menu

   #:

2. Right click the CONFIG partition
3. Select Change drive letter or paths...

   

4. Select any letter from the drop-down list

   

5. Click OK.
6. You should now be able to see the CONFIG partition in your Windows Explorer. Select the config.ini configuration file

   

7. Click on Edit to open it.
8. Insert your IPv6 prefix, subnet and gateway.

   

9. Once done, don’t forget to save the changes. If you need help, please do not hesitate to post your issue in the IC Node Provider Matrix channel.

   

10. If onboarding without a NitroKey HSM, copy node_operator_private_key.pem from Node Provider Onboarding step 5. Setup the Node Operator keys to the CONFIG partition. This file should have the name node_operator_private_key.pem, and sit next to config.ini, NOT inside the ssh_authorized_keys folder.

Linux

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

   

2. Double-click to open it in KWrite.
3. Insert your IPv6 prefix, subnet and gateway.

   

4. Once done, don’t forget to save the changes. If you need help, please do not hesitate to post your issue in the IC Node Provider Matrix channel.

   

5. If onboarding without a NitroKey HSM, copy node_operator_private_key.pem from Node Provider Onboarding step 5. Setup the Node Operator keys to the CONFIG partition. This file should have the name node_operator_private_key.pem, and sit next to config.ini, NOT inside the ssh_authorized_keys folder.

5. Connect Crash Cart

1. In order to configure the UEFI and initiate the installation of the IC-OS, please connect a crash cart to the physical machine.
2. Plug-in the VGA/Video, keyboard and IC-OS USB stick

   

6. UEFI Setup and Boot Menu

Use the related page below to set up the BIOS/UEFI according to your hardware vendor.

• IC OS Installation - UEFI Configuration - Dell
• IC OS Installation - UEFI Configuration - Supermicro

Resume from this point when you are finished.

7. IC-OS Installation

1. Please wait while the USB Installer is booting up. This process can take up to 3 minutes.

   

2. The IC-OS installation starts. Please keep an eye on the progress. This part can take up to 10 minutes. Please remember to check the Possible Node Onboarding Errors page if you encounter any errors.

   

3. If using a NitroKey HSM, once you get asked to insert the HSM, please remove the keyboard and instead insert the HSM USB device.

   

4. If the installation finished successfully, it will initiate a reboot. Please do not unplug the USB stick or HSM USB device (if in use) at this point.

   

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

1. The first boot of the IC-OS still requires the HSM USB device (if in use). Please wait until further instructions. This step can take up to 2 minutes.

   

2. Once you see this message, you may unplug the HSM USB device (if in use), USB stick and VGA/Video. Your machine successfully joined the Internet Computer!

   

Return to the Onboarding Document