Difference between revisions of "Node Deployment Guide"

Revision as of 18:08, 17 March 2023

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 the respective manual.

In case you encounter any issues during the installation process, check the Possible Node Onboarding Errors page. Otherwise contact the Internet Computer Association

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

1. Download installation image

Download the IC-OS USB installer image here. This link will always provide the current blessed version. Do NOT use an old USB image.:
https://download.dfinity.systems/ic/efeb38b3bfa1133383e293a65ccce29263318ef0/setup-os/disk-img/disk-img.tar.gz
Download the corresponding checksum here:
https://download.dfinity.systems/ic/efeb38b3bfa1133383e293a65ccce29263318ef0/setup-os/disk-img/SHA256SUMS

2. 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
```

3. Create Bootable USB Stick

Mac OS X

Open the Terminal and type:
```
diskutil list
```
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
```
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

Open the Terminal and type
```
blkid
```
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
```
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

Download and install Rufus Portable
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.

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

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

6. UEFI Setup and Boot Menu

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

Resume from this point when you are finished.

7. IC-OS Installation

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.

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.

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.

Return to the Onboarding Document

@@ Line 38: / Line 38: @@
 # Open the Terminal and type:
 #: <syntaxhighlight lang="shell">diskutil list</syntaxhighlight>
-# All available drives should be shown. Identify which device corresponds to your USB stick.
+# All available drives should be shown. Identify which device corresponds to your USB stick. You may need to unmount the USB drive:
-# The following command is an example. Replace ''/dev/YOUR_USB_DEVICE'' with the device that corresponds to your USB stick. Replace ''YOUR_USER_NAME'' accordingly or with the whole path to the downloaded image. '''Warning:''' You risk losing your own data if you specify a wrong device.
+#:<syntaxhighlight lang="shell">sudo diskutil unmount /dev/YOUR_USB_DEVICE_MOUNTED_PARTITION # E.g. /dev/disk4s1</syntaxhighlight>
+# 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.
 #:<syntaxhighlight lang="shell">sudo dd if=/Users/YOUR_USER_NAME/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M</syntaxhighlight>
 === Linux / Ubuntu ===
 # Open the Terminal and type <syntaxhighlight lang="shell">blkid</syntaxhighlight>
-# All available drives should be shown. Identify which device corresponds to your USB stick.
+# All available drives should be shown. Identify which device corresponds to your USB stick. You may need to unmount the USB drive:
-# For this next command, 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.
+#:<syntaxhighlight lang="shell">sudo diskutil unmount /dev/YOUR_USB_DEVICE_MOUNTED_PARTITION # E.g. /dev/sdb1</syntaxhighlight>
+# 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.
 #: <syntaxhighlight lang="shell">sudo dd if=~/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M</syntaxhighlight>