Difference between revisions of "Node Deployment Guide"

From Internet Computer Wiki
Jump to: navigation, search
(→‎1. Download installation image: Instructions for downloading clarified.)
m
 
(65 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
This runbook covers all steps necessary to install the Internet Computer Operating System (IC-OS) on [[Node Provider Machine Hardware Guide#Gen 2 Node Machine requirements|Gen-2 hardware]]. Gen-1 hardware Node Providers should use the [[Node Provider Documentation#Onboarding for accepted node providers|Gen-1 runbooks]].
+
This runbook covers all steps necessary to install the Internet Computer Operating System (IC-OS).
  
 
The physical machine is expected to be racked and stacked according to its respective manual.
 
The physical machine is expected to be racked and stacked according to its respective manual.
  
−
If you encounter issues through any of these steps, check the [[Node Provider Troubleshooting]] page. If that does not solve your problem, you are encouraged to ask for assistance in the [[Node Provider Matrix channel]].
+
To complete these steps, you are expected to be physically present in the data center your machine(s) reside<(s). Once you successfully onboarded your first node, you can bring up the other nodes in parallel.
  
−
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]].
+
If you encounter issues during any of these steps, consult the [[Troubleshooting Node Deployment Errors]] page.
  
−
== Requirements ==
+
==1. Choose onboarding path (HSM vs. no HSM)==
−
* 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.)
+
If you chose the [[Node Provider Onboarding#5. Choose onboarding path .28HSM vs no HSM.29|HSM Node Provider Onboarding Path]], follow the [[NitroKey HSM installation runbook]] to onboard your nodes.
−
* The <code>node_operator_private_key.pem</code> for your data center (Acquired from [[Node Provider Onboarding#5. Setup the Node Operator keys|Node Provider Onboarding step 5. Setup the Node Operator keys]])
 
  
−
== 1. Download installation image ==
+
If you chose to onboard '''without''' a Nitrokey HSM, '''continue to the next step.'''
−
Download both the '''IC-OS USB Installer Image''' and the '''corresponding checksum''' from the [[IC OS Download|IC-OS Download Page]]
 
  
−
== 2. Verify checksum and unarchive file ==
+
==2. Obtain requirements ==
−
=== Mac OS X ===
+
*A USB (3.0 speed that can hold at least 4GB) to put the image file on.
−
# Open the Terminal and type:  
+
**Faster USBs will allow the process to go much faster.
−
#: <syntaxhighlight lang="shell">shasum -a 256 ~/Downloads/disk-img.tar.gz</syntaxhighlight>
+
*The <code>node_operator_private_key.pem</code> for your data center (Acquired from [[Node Provider Onboarding#6. Setup the Node Operator keys|Node Provider Onboarding step 6]])
−
# 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 [[Node Provider Matrix channel]].
+
* It is recommended that each server have a label with the BMC's MAC address for ease of identification in future dashboard upgrades.
−
#: Open the Terminal and type: <syntaxhighlight lang="shell">tar xzvf ~/Downloads/disk-img.tar.gz</syntaxhighlight>
+
 
 +
== 3. Download installation image==
 +
Download the latest release of the '''IC-OS USB Installer Image''' and the '''corresponding checksum''' from the [https://dashboard.internetcomputer.org/releases Internet Computer Dashboard Releases].
 +
 
 +
* '''Note that you should always use a release from the last 6 weeks (newer is better) in order to ensure that your node can correctly correct to the network.'''
 +
 
 +
== 4. Verify checksum and unarchive file==
 +
===Mac OS X ===
 +
#Open the Terminal and type:  
 +
#:<syntaxhighlight lang="shell">shasum -a 256 ~/Downloads/disk-img.tar.gz</syntaxhighlight>
 +
#Compare the calculated checksum with the '''IC-OS installation image checksum''' file downloaded in the previous step. '''Warning:''' Only continue if they are identical, otherwise please post your issue in the [[Node Provider Matrix channel]].
 +
#:Open the Terminal and type: <syntaxhighlight lang="shell">tar xzvf ~/Downloads/disk-img.tar.gz</syntaxhighlight>
  
−
=== Linux / Ubuntu ===
+
===Linux / Ubuntu===
−
# Open the Terminal and type:  
+
#Open the Terminal and type:  
−
#: <syntaxhighlight lang="shell">sha256sum ~/Downloads/disk-img.tar.gz</syntaxhighlight>
+
#:<syntaxhighlight lang="shell">sha256sum ~/Downloads/disk-img.tar.gz</syntaxhighlight>
−
# 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 [[Node Provider Matrix channel]].
+
#Compare the calculated checksum with the '''IC-OS installation image checksum''' file downloaded in the previous step. '''Warning:''' Only continue if they are identical, otherwise please post your issue in the [[Node Provider Matrix channel]].
−
#: Open the Terminal and type: <syntaxhighlight lang="shell">tar xzvf ~/Downloads/disk-img.tar.gz</syntaxhighlight>
+
#:Open the Terminal and type: <syntaxhighlight lang="shell">tar xzvf ~/Downloads/disk-img.tar.gz</syntaxhighlight>
  
−
=== Windows ===
+
===Windows===
−
# Open PowerShell and type:  
+
#Open PowerShell and type:  
−
#: <syntaxhighlight lang="shell">Get-FileHash -Algorithm SHA256 .\Downloads\disk-img.tar.gz</syntaxhighlight>
+
#:<syntaxhighlight lang="shell">Get-FileHash -Algorithm SHA256 .\Downloads\disk-img.tar.gz</syntaxhighlight>
−
# 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 [[Node Provider Matrix channel]].
+
#Compare the calculated checksum with the '''IC-OS installation image checksum''' file downloaded in the previous step. '''Warning:''' Only continue if they are identical, otherwise please post your issue in the [[Node Provider Matrix channel]].
−
#: Open PowerShell and type: <syntaxhighlight lang="shell">tar xzvf .\Downloads\disk-img.tar.gz</syntaxhighlight>
+
#:Open PowerShell and type: <syntaxhighlight lang="shell">tar xzvf .\Downloads\disk-img.tar.gz</syntaxhighlight>
  
−
== 3. Create Bootable USB Stick ==
+
==5. Create Bootable USB Stick ==
−
=== Mac OS X ===
+
===Mac OS X===
 
# Open the Terminal and type:  
 
# Open the Terminal and type:  
−
#:<syntaxhighlight lang="shell">diskutil list</syntaxhighlight>  
+
#:<syntaxhighlight lang="shell">diskutil list</syntaxhighlight>
−
# All available drives should be shown. Identify which device corresponds to your USB stick. You may need to unmount the USB drive:
+
#All available drives should be shown. Identify which device corresponds to your USB stick. You may need to unmount the USB drive:
 
#:<syntaxhighlight lang="shell">sudo diskutil unmount /dev/YOUR_USB_DEVICE_MOUNTED_PARTITION # E.g. /dev/disk4s1</syntaxhighlight>
 
#:<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.  
+
#Replace ''/dev/YOUR_USB_DEVICE'' with the device that corresponds to your USB stick. Additionally, replace the path to your downloaded IC-OS ''disk.img'' file. '''Warning:''' You risk losing your own data if you specify a wrong drive.
−
#:<syntaxhighlight lang="shell">sudo dd if=/Users/YOUR_USER_NAME/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M</syntaxhighlight>  
+
#:<syntaxhighlight lang="shell">sudo dd if=/Users/YOUR_USER_NAME/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M status=progress</syntaxhighlight>If you get a “device is busy” error from the dd command, you can try running the following command to unmount all of the partitions on the disk, then re-run the dd command:
 +
#:<syntaxhighlight lang="shell">sudo diskutil unmountDisk /dev/YOUR_USB_DEVICE # E.g. /dev/disk4</syntaxhighlight>
  
−
=== Linux / Ubuntu ===
+
=== Linux / Ubuntu===
−
# Open the Terminal and type  
+
#Open the Terminal and type  
 
#:<syntaxhighlight lang="shell">blkid</syntaxhighlight>
 
#:<syntaxhighlight lang="shell">blkid</syntaxhighlight>
 
# All available drives should be shown. Identify which device corresponds to your USB stick. You may need to unmount the USB drive:
 
# All available drives should be shown. Identify which device corresponds to your USB stick. You may need to unmount the USB drive:
 
#:<syntaxhighlight lang="shell">sudo diskutil unmount /dev/YOUR_USB_DEVICE_MOUNTED_PARTITION # E.g. /dev/sdb1</syntaxhighlight>
 
#:<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.  
+
#Replace ''/dev/YOUR_USB_DEVICE'' with the device that corresponds to your USB stick. Additionally, replace the path to your downloaded IC-OS ''disk.img'' file. '''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>  
+
#:<syntaxhighlight lang="shell">sudo dd if=/home/YOUR_USER_NAME/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M status=progress</syntaxhighlight>
  
−
=== Windows ===
+
===Windows===
−
# Download and install [https://rufus.ie/en/ Rufus Portable]
+
#Download and install [https://rufus.ie/en/ Rufus Portable]
−
# Start Rufus  
+
#Start Rufus
−
# Select the USB stick under device and select the previously downloaded IC-OS disk image and press start  
+
#Select the USB stick under device and select the previously downloaded IC-OS disk image and press start  
−
#: [[File:05.png|480px|screenshot]]
+
#:[[File:05.png|480px|screenshot]]
−
# You may see some warnings. Make sure you don't have any other USBs in your computer and chose OK
+
#You may see some warnings. Make sure you don't have any other USBs in your computer and chose OK
−
#: [[File:06.png|480px|screenshot]]
+
#:[[File:06.png|480px|screenshot]]
−
#: [[File:07.png|480px|screenshot]]
+
#:[[File:07.png|480px|screenshot]]
 
# The "Ready" bar will go from left to right as it completes.
 
# The "Ready" bar will go from left to right as it completes.
  
−
== 4. Add configuration ==
+
==6. 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.
+
===A. Open Config.ini in a text editor===
−
#: [[File:mac_01.png|580px|screenshot]]
+
 
−
# Double-click to open it in TextEdit.
+
===='''Mac OS X'''====
−
# Insert your IPv6 prefix, subnet and gateway.
+
 
−
#:[[File:mac_02.png|580px|screenshot]]
+
#Open Finder. You should now be able to see the CONFIG partition. If it's not visible, remove the USB and insert it again.
−
#:* The IPv6 prefix should consist of four groups of hexadecimal digits, separated by colons (':'). Each group can contain up to four hex digits.
+
#:[[File:mac_01.png|580px|screenshot]]
−
#:* For example, a valid prefix could look like this: <code>2a00:fb01:400:100</code>
+
#Double-click <code>config.ini</code> to open it in TextEdit.
−
#:* '''Important:'''
+
 
−
#:** The prefix should not have a trailing ':'
+
 
−
#:** IPv6 CIDR notation allows for a double colon ('::') to represent consecutive groups of zeroes in an address. However, the prefix configuration in this context does '''not''' support '::'. The '::' shorthand should '''not''' be used. Even if some groups are all zeros, they must be explicitly written out.
+
===='''Linux'''====
−
# Once done, don’t forget to save the changes. If you need help, please do not hesitate to post your issue in the [[Node Provider Matrix channel]].
+
 
−
#:[[File:mac_03.png|580px|screenshot]]
+
#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.
−
# Copy <code>node_operator_private_key.pem</code> from [[Node Provider Onboarding#5.%20Setup%20the%20Node%20Operator%20keys|Node Provider Onboarding step 5. Setup the Node Operator keys]] to the <code>CONFIG</code> partition. This file should have the name <code>node_operator_private_key.pem</code>, and sit next to <code>config.ini</code>, NOT inside the <code>ssh_authorized_keys</code> folder.
+
#:[[File:linux_01.png|580px|screenshot]]
 +
#Double-click <code>config.ini</code> to open it in KWrite.
 +
 
 +
 
 +
===='''Windows'''====
  
−
=== Windows ===
+
#Open the Disk Management utility with a right click on the Start menu  
−
# Open the Disk Management utility with a right click on the Start menu  
+
#:[[File:09-b.png|300px|screenshot]]#:
−
#: [[File:09-b.png|300px|screenshot]]#:
+
#Right click the CONFIG partition
−
# Right click the CONFIG partition  
 
 
# Select Change drive letter or paths...
 
# Select Change drive letter or paths...
−
#: [[File:10-b.png|780px|screenshot]]
+
#:[[File:10-b.png|780px|screenshot]]
 
# Select any letter from the drop-down list  
 
# Select any letter from the drop-down list  
−
#: [[File:11-b.png|480px|screenshot]]
+
#:[[File:11-b.png|480px|screenshot]]
−
# Click OK.
+
#Click OK.
−
# You should now be able to see the CONFIG partition in your Windows Explorer. Select the config.ini configuration file  
+
#You should now be able to see the CONFIG partition in your Windows Explorer. Select the <code>config.ini</code> configuration file  
−
#: [[File:12-b.png|780px|screenshot]]
+
#:[[File:12-b.png|780px|screenshot]]
−
# Click on Edit to open it.
+
#Click on Edit to open it.
−
# Insert your IPv6 prefix, subnet and gateway.  
+
 
−
#:[[File:13-b.png|580px|screenshot]]
+
===B. Edit Config.ini===
 +
 
 +
Edit the config.ini file to add your network configuration.
 +
 
 +
Note that '''all Node Providers are requested to deploy two nodes with IPv4 and a domain name for every data center they operate in'''. Node Providers should deploy IPv4 to the '''first two nodes in their first rack'''.
 +
# Insert your IPv6 prefix and gateway.
 +
#:[[File:IPv6 config ini.png|780px|screenshot]]
 
#:* The IPv6 prefix should consist of four groups of hexadecimal digits, separated by colons (':'). Each group can contain up to four hex digits.
 
#:* The IPv6 prefix should consist of four groups of hexadecimal digits, separated by colons (':'). Each group can contain up to four hex digits.
−
#:* For example, a valid prefix could look like this: <code>2a00:fb01:400:100</code>
+
#:*For example, a valid prefix could look like this: <code>2a00:fb01:400:200</code>
 +
#:*'''Important:'''
 +
#:**The prefix should not have a trailing ':'
 +
#:**IPv6 CIDR notation allows for a double colon ('::') to represent consecutive groups of zeroes in an address. However, the  prefix configuration in this context does '''not''' support '::'. The '::' shorthand should '''not''' be used. Even if some groups are all zeros, they must be explicitly written out.
 +
#[Optional] Insert your IPv4 info and domain name.
 +
#:[[File:IPv4 config ini.png|780px|screenshot]]
 +
#:* Configuring your node with IPv4 settings is optional, but if you do configure your node with IPv4 settings, you must also define the domain name for your node.
 
#:*'''Important:'''
 
#:*'''Important:'''
−
#:** The prefix should not have a trailing ':'
+
#:**Please note that you '''must use a unique IPv4 address for each node you deploy'''. This means that you cannot use a single IC-OS installation image to deploy multiple nodes (like you are able to do when just configuring IPv6 nodes).  '''After each IPv4 node deployment, you must plug your IC-OS Installation USB stick back into your laptop and return to [[Node Deployment Guide#6. Add configuration|step 6]] in the node deployment guide to reconfigure your installation image.'''
−
#:** IPv6 CIDR notation allows for a double colon ('::') to represent consecutive groups of zeroes in an address. However, the  prefix configuration in this context does '''not''' support '::'. The '::' shorthand should '''not''' be used. Even if some groups are all zeros, they must be explicitly written out.
+
#:**You can add, remove, or update your node’s IPv4 address and domain name after completing node deployment using dfx commands. See [[Updating your node's IPv4 and domain name|here]] for details.
−
# Once done, don’t forget to save the changes. If you need help, please do not hesitate to post your issue in the [[Node Provider Matrix channel]].
+
#Save the changes.  
−
#:[[File:14-b.png|580px|screenshot]]
+
#:*If you have trouble saving this file directly, you may need to save to a known location first, then copy the file into place.
−
# Copy <code>node_operator_private_key.pem</code> from [[Node Provider Onboarding#5. Setup the Node Operator keys|Node Provider Onboarding step 5. Setup the Node Operator keys]] to the <code>CONFIG</code> partition. This file should have the name <code>node_operator_private_key.pem</code>, and sit next to <code>config.ini</code>, NOT inside the <code>ssh_authorized_keys</code> folder.
+
#:*:[[File:mac_03.png|580px|screenshot]]
 +
 
 +
===C. Copy Node Operator private key to config partition===
  
−
=== Linux ===
+
#Copy <code>node_operator_private_key.pem</code> (created in [[Node Provider Onboarding#6. Setup the Node Operator keys|Node Provider Onboarding step 6]]) to the <code>CONFIG</code> partition. This file should have the name <code>node_operator_private_key.pem</code>, and sit next to <code>config.ini</code>, NOT inside the <code>ssh_authorized_keys</code> folder.
−
# 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.
 
−
#: [[File:linux_01.png|580px|screenshot]]
 
−
# Double-click to open it in KWrite.
 
−
# Insert your IPv6 prefix, subnet and gateway.
 
−
#:[[File:linux_02.png|580px|screenshot]]
 
−
#:* The IPv6 prefix should consist of four groups of hexadecimal digits, separated by colons (':'). Each group can contain up to four hex digits.
 
−
#:* For example, a valid prefix could look like this: <code>2a00:fb01:400:100</code>
 
−
#:*'''Important:'''
 
−
#:** The prefix should not have a trailing ':'
 
−
#:** IPv6 CIDR notation allows for a double colon ('::') to represent consecutive groups of zeroes in an address. However, the  prefix configuration in this context does '''not''' support '::'. The '::' shorthand should '''not''' be used. Even if some groups are all zeros, they must be explicitly written out.
 
−
# Once done, don’t forget to save the changes. If you need help, please do not hesitate to post your issue in the [[Node Provider Matrix channel]].
 
−
#:[[File:linux_03.png|580px|screenshot]]
 
−
# Copy <code>node_operator_private_key.pem</code> from [[Node Provider Onboarding#5. Setup the Node Operator keys|Node Provider Onboarding step 5. Setup the Node Operator keys]] to the <code>CONFIG</code> partition. This file should have the name <code>node_operator_private_key.pem</code>, and sit next to <code>config.ini</code>, NOT inside the <code>ssh_authorized_keys</code> folder.
 
  
−
== 5. Connect Crash Cart ==
+
==7. 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.  
+
#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
 
# Plug-in the VGA/Video, keyboard and IC-OS USB stick
−
#: [[File:08.png|580px|screenshot]]
+
#:[[File:08.png|580px|screenshot]]
 +
 
 +
==8. UEFI Setup and Boot Menu==
 +
 
 +
 
 +
Make sure that server date/time is set to UTC (Universal Time Coordinated)
  
−
== 6. UEFI Setup and Boot Menu ==
 
 
Use the related page below to set up the BIOS/UEFI according to your hardware vendor.
 
Use the related page below to set up the BIOS/UEFI according to your hardware vendor.
  
−
* [[IC OS Installation - UEFI Configuration - Dell]]
+
*[[Node Provider Machine Hardware Guide#Gen 2 Node Machine requirements|Gen2 hardware]]
−
* [[IC OS Installation - UEFI Configuration - Supermicro]]
+
**[[IC-OS Installation - UEFI Configuration - Gen2 Dell]]
−
<!--
+
**[[IC-OS Installation - UEFI Configuration - Gen2 Supermicro]]
−
* * [[IC OS Installation - UEFI Configuration - ASUS]]
+
**[[IC-OS Installation - UEFI Configuration - Gen2 Gigabyte]]
−
* [[IC OS Installation - UEFI Configuration - Gigabyte]]
+
**[[IC-OS Installation - UEFI Configuration - Gen2 ASUS]]
−
* [[IC OS Installation - UEFI Configuration - HPE]]
+
*[[Node Provider Machine Hardware Guide#Gen 1 Node Machine requirements|Gen1 hardware]]
−
-->'''Important:''' Do NOT enable the RAID bios setting. Doing so will cause issues with the IC-OS installation.
+
**[[IC-OS Installation - UEFI Configuration - Gen1 Dell|IC-OS Installation - UEFI Configuration - Gen1 Dell (Poweredge R6525)]]
 +
**[[IC-OS Installation - UEFI Configuration - Gen1 Supermicro]]
 +
***
 +
'''Important:''' Do NOT enable the RAID bios setting. Doing so will cause issues with the IC-OS installation.
  
 
Resume from this point when you are finished configuring the BIOS.
 
Resume from this point when you are finished configuring the BIOS.
  
−
== 7. IC-OS Installation ==
+
== 9. IC-OS Installation==
−
# Please wait while the USB Installer is booting up. This process can take up to 3 minutes.
+
#Please wait while the USB Installer is booting up. This process can take up to 3 minutes.
−
#: [[File:35-sm.png|580px|screenshot]]
+
#:[[File:35-sm.png|580px|screenshot]]
−
# 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.
+
#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 [[Troubleshooting Node Deployment Errors]] page if you encounter any errors.
 
#:[[File:36-sm.png|580px|screenshot]]
 
#:[[File:36-sm.png|580px|screenshot]]
−
# If the installation finished successfully, it will initiate a reboot.  
+
#If the installation finished successfully, it will initiate a reboot.  
 
#:[[File:38-sm.png|580px|screenshot]]<br />
 
#:[[File:38-sm.png|580px|screenshot]]<br />
−
== 8. First Boot ==
+
==10. First Boot==
−
Please remember to check the [[Possible Node Onboarding Errors]] page if you encounter any errors onboarding.
+
Please remember to check the [[Troubleshooting Node Deployment Errors]] page if you encounter any errors.
−
'''Do NOT re-try the onboarding after proceeding to this section, as this can cause duplication within the registry.'''
+
#Once you see this message, you may unplug the USB stick and VGA/Video.  
−
# Once you see this message, you may unplug the USB stick and VGA/Video. You can ignore the message to remove the HSM, as you did not use an HSM to onboard your nodes.  
+
#:[[File:Node join message.png|580px|screenshot]]
−
#:[[File:40-sm.png|580px|screenshot]]
 
  
−
Congratulations! Your machine successfully joined the Internet Computer! Again, once you see this message, '''do NOT re-try the onboarding after proceeding to this section, as this can cause duplication within the registry.''' The machine has joined the IC and the Node Provider will start receiving rewards!
+
Congratulations! Your machine successfully joined the Internet Computer! The machine has joined the IC and the Node Provider will start receiving rewards!
  
−
== 9. Verify node onboarding ==
+
==11. Verify node onboarding==
  
−
# Verify that your node was successfully onboarded by checking its status on the [https://dashboard.internetcomputer.org/ dashboard] is set to either “Awaiting Subnet” or “Active in Subnet”.  
+
#Verify that your node was successfully onboarded by checking its status on the [https://dashboard.internetcomputer.org/ dashboard] is set to either “Awaiting Subnet” or “Active in Subnet”.  
−
#* The dashboard can be searched by your Node Provider principal. There, you should see the Node ID of your node (Node ID outputted in step 8).  
+
#*The dashboard can be searched by your Node Provider principal. There, you should see the Node ID of your node (Node ID is outputted in step 10).
−
#* If the status of your node is not either “Awaiting Subnet” or “Active in Subnet”, or if it is not listed under your Node Provider principal, you should contact the [[Node Provider Matrix channel]] for assistance.
+
#*If the status of your node is not either “Awaiting Subnet” or “Active in Subnet”, or if it is not listed under your Node Provider principal, you should consult the [[Troubleshooting Node Deployment Errors]] page.
−
#*:[[File:Dashboard-node-verification.png|thumb|998x998px]]
+
#*:[[File:Node onboarding verification.png|680px|screenshot]]
 +
#If deploying with IPv4, verify that IPv4 was successfully configured
 +
#*Ten minutes after the <code>Join request successful!</code> message, you should see another log indicating a successful IPv4 deployment:
 +
#*:[[File:IPv4 log.jpg|680px|screenshot]]
 +
#*If your log says <code>IPv4: none configured</code>, then your IPv4 deployment failed.

Latest revision as of 20:25, 22 April 2024

This runbook covers all steps necessary to install the Internet Computer Operating System (IC-OS).

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

To complete these steps, you are expected to be physically present in the data center your machine(s) reside<(s). Once you successfully onboarded your first node, you can bring up the other nodes in parallel.

If you encounter issues during any of these steps, consult the Troubleshooting Node Deployment Errors page.

1. Choose onboarding path (HSM vs. no HSM)

If you chose the HSM Node Provider Onboarding Path, follow the NitroKey HSM installation runbook to onboard your nodes.

If you chose to onboard without a Nitrokey HSM, continue to the next step.

2. Obtain 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 node_operator_private_key.pem for your data center (Acquired from Node Provider Onboarding step 6)
  • It is recommended that each server have a label with the BMC's MAC address for ease of identification in future dashboard upgrades.

3. Download installation image

Download the latest release of the IC-OS USB Installer Image and the corresponding checksum from the Internet Computer Dashboard Releases.

  • Note that you should always use a release from the last 6 weeks (newer is better) in order to ensure that your node can correctly correct to the network.

4. 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 IC-OS installation image checksum file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please post your issue in the 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 IC-OS installation image checksum file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please post your issue in the 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 IC-OS installation image checksum file downloaded in the previous step. Warning: Only continue if they are identical, otherwise please post your issue in the Node Provider Matrix channel.
    Open PowerShell and type: 
    tar xzvf .\Downloads\disk-img.tar.gz

5. 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. Replace /dev/YOUR_USB_DEVICE with the device that corresponds to your USB stick. Additionally, replace the path to your downloaded IC-OS disk.img file. Warning: You risk losing your own data if you specify a wrong drive. 
    sudo dd if=/Users/YOUR_USER_NAME/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M status=progress
    If you get a “device is busy” error from the dd command, you can try running the following command to unmount all of the partitions on the disk, then re-run the dd command:
    sudo diskutil unmountDisk /dev/YOUR_USB_DEVICE # E.g. /dev/disk4

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. Additionally, replace the path to your downloaded IC-OS disk.img file. Warning: You risk losing your own data if you specify a wrong drive. 
    sudo dd if=/home/YOUR_USER_NAME/Downloads/disk.img of=/dev/YOUR_USB_DEVICE bs=1M status=progress

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
    screenshot
  4. You may see some warnings. Make sure you don't have any other USBs in your computer and chose OK
    screenshot
    screenshot
  5. The "Ready" bar will go from left to right as it completes.

6. Add configuration

A. Open Config.ini in a text editor

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.
    screenshot
  2. Double-click config.ini to open it in TextEdit.


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.
    screenshot
  2. Double-click config.ini to open it in KWrite.


Windows

  1. Open the Disk Management utility with a right click on the Start menu
    screenshot#:
  2. Right click the CONFIG partition
  3. Select Change drive letter or paths...
    screenshot
  4. Select any letter from the drop-down list
    screenshot
  5. Click OK.
  6. You should now be able to see the CONFIG partition in your Windows Explorer. Select the config.ini configuration file
    screenshot
  7. Click on Edit to open it.

B. Edit Config.ini

Edit the config.ini file to add your network configuration.

Note that all Node Providers are requested to deploy two nodes with IPv4 and a domain name for every data center they operate in. Node Providers should deploy IPv4 to the first two nodes in their first rack.

  1. Insert your IPv6 prefix and gateway.
    screenshot
    • The IPv6 prefix should consist of four groups of hexadecimal digits, separated by colons (':'). Each group can contain up to four hex digits.
    • For example, a valid prefix could look like this: 2a00:fb01:400:200
    • Important:
      • The prefix should not have a trailing ':'
      • IPv6 CIDR notation allows for a double colon ('::') to represent consecutive groups of zeroes in an address. However, the prefix configuration in this context does not support '::'. The '::' shorthand should not be used. Even if some groups are all zeros, they must be explicitly written out.
  2. [Optional] Insert your IPv4 info and domain name.
    screenshot
    • Configuring your node with IPv4 settings is optional, but if you do configure your node with IPv4 settings, you must also define the domain name for your node.
    • Important:
      • Please note that you must use a unique IPv4 address for each node you deploy. This means that you cannot use a single IC-OS installation image to deploy multiple nodes (like you are able to do when just configuring IPv6 nodes). After each IPv4 node deployment, you must plug your IC-OS Installation USB stick back into your laptop and return to step 6 in the node deployment guide to reconfigure your installation image.
      • You can add, remove, or update your node’s IPv4 address and domain name after completing node deployment using dfx commands. See here for details.
  3. Save the changes.
    • If you have trouble saving this file directly, you may need to save to a known location first, then copy the file into place.
      screenshot

C. Copy Node Operator private key to config partition

  1. Copy node_operator_private_key.pem (created in Node Provider Onboarding step 6) 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.

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

8. UEFI Setup and Boot Menu

Make sure that server date/time is set to UTC (Universal Time Coordinated)

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

Important: Do NOT enable the RAID bios setting. Doing so will cause issues with the IC-OS installation.

Resume from this point when you are finished configuring the BIOS.

9. IC-OS Installation

  1. Please wait while the USB Installer is booting up. This process can take up to 3 minutes.
    screenshot
  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 Troubleshooting Node Deployment Errors page if you encounter any errors.
    screenshot
  3. If the installation finished successfully, it will initiate a reboot.
    screenshot

10. First Boot

Please remember to check the Troubleshooting Node Deployment Errors page if you encounter any errors.

  1. Once you see this message, you may unplug the USB stick and VGA/Video.
    screenshot

Congratulations! Your machine successfully joined the Internet Computer! The machine has joined the IC and the Node Provider will start receiving rewards!

11. Verify node onboarding

  1. Verify that your node was successfully onboarded by checking its status on the dashboard is set to either “Awaiting Subnet” or “Active in Subnet”.
    • The dashboard can be searched by your Node Provider principal. There, you should see the Node ID of your node (Node ID is outputted in step 10).
    • If the status of your node is not either “Awaiting Subnet” or “Active in Subnet”, or if it is not listed under your Node Provider principal, you should consult the Troubleshooting Node Deployment Errors page.
      screenshot
  2. If deploying with IPv4, verify that IPv4 was successfully configured
    • Ten minutes after the Join request successful! message, you should see another log indicating a successful IPv4 deployment:
      screenshot
    • If your log says IPv4: none configured, then your IPv4 deployment failed.
Retrieved from "https://wiki.internetcomputer.org/w/index.php?title=Node_Deployment_Guide&oldid=7720"