|
|
| (56 intermediate revisions by 16 users not shown) |
| Line 1: |
Line 1: |
| − | This Node deployment runbook covers all steps necessary to install the Internet Computer Operating System (hereinafter called IC-OS).
| + | #REDIRECT [[Main Page]] |
| − | 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, we kindly ask you to send an email with the error message to:
| |
| − | | |
| − | | |
| − | 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 (A faster USB 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.
| |
| − | * It is recommended that you have a plan for providing details if troubleshooting assistance is needed. We recommend that you track the serial number (on the pull-out tab) for each server and compare the screenshots in the directions with each step. If assistance is needed, you will need to provide:
| |
| − | ** The serial number of the server in question
| |
| − | ** Which step was last completed
| |
| − | ** A screenshot or video showing any results that are different from what is expected.
| |
| − | ** Verification of the HSM key and config.ini file that is being used.
| |
| − | | |
| − | == I. Download installation image ==
| |
| − | | |
| − | # Download the IC-OS disk image here: <br> https://download.dfinity.systems/blessed/ic/f736069ae6a6e39a73f211c587705e0f8dfdfb06/setup-os/disk-img/disk-img.tar.gz <br> | |
| − | # Download the corresponding checksum here:<br> https://download.dfinity.systems/blessed/ic/f736069ae6a6e39a73f211c587705e0f8dfdfb06/setup-os/disk-img/SHA256SUMS
| |
| − | | |
| − | == II. 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 file downloaded in the previous step. '''Warning:''' Only continue if they are identical, otherwise please contact the Internet Computer Association.
| |
| − | * In the Terminal type:
| |
| − | *: <syntaxhighlight lang="shell">tar xzvf ~/Downloads/disk-img.tar.gz</syntaxhighlight>
| |
| − | | |
| − | === Linux / Ubuntu ===
| |
| − | * Open the Terminal and type:
| |
| − | *: <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 contact the Internet Computer Association.
| |
| − | * In the Terminal type:
| |
| − | *: <syntaxhighlight lang="shell">tar xzvf ~/Downloads/disk-img.tar.gz</syntaxhighlight>
| |
| − | | |
| − | === Windows ===
| |
| − | * Open PowerShell and type:
| |
| − | *: <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 contact the Internet Computer Association.
| |
| − | * In PowerShell type:
| |
| − | *: <syntaxhighlight lang="shell">tar xzvf .\Downloads\disk-img.tar.gz</syntaxhighlight>
| |
| − | | |
| − | === 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 IC-OS USB Stick ==
| |
| − | === Mac OS X ===
| |
| − | # Open the Terminal and type:
| |
| − | #: <syntaxhighlight lang="shell">diskutil list</syntaxhighlight>
| |
| − | # 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.
| |
| − | #:<syntaxhighlight lang="shell">dd if=~/Downloads/setup-os_<version>.img of=/dev/sda</syntaxhighlight>
| |
| − | | |
| − | === Linux / Ubuntu ===
| |
| − | # Open the Terminal and type
| |
| − | #: <syntaxhighlight lang="shell">blkid</syntaxhighlight>
| |
| − | # 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.
| |
| − | #: <syntaxhighlight lang="shell">dd if=~/Downloads/setup-os_<version>.img of=/dev/sda </syntaxhighlight>
| |
| − | | |
| − | === 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''
| |
| − | #: [[File:05.png|360px|screenshot]]
| |
| − | # You may see some warnings. Make sure you don't have any other USBs in your computer and chose ''OK''. '''Warning:''' You risk losing your own data if you specify a wrong drive.
| |
| − | #: [[File:06.png|360px|screenshot]]
| |
| − | #: [[File:07.png|360px|screenshot]]
| |
| − | # 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.
| |
| − | #: [[File:mac_01.png|480px|screenshot]]
| |
| − | # Double-click to open it in TextEdit.
| |
| − | # Overwrite the example with your the IPv6 prefix, subnet and gateway of your data center.
| |
| − | #: [[File:mac_02.png|480px|screenshot]]
| |
| − | # Once done, don’t forget to save the changes. If you need help, please do not hesitate to contact the Internet Computer Association.
| |
| − | #: [[File:mac_03.png|480px|screenshot]]
| |
| − | | |
| − | === Windows ===
| |
| − | # Open the ''Disk Management'' utility with a right click on the ''Start menu''
| |
| − | #: [[File:09-b.png|250px|screenshot]]
| |
| − | # Right click the ''CONFIG'' partition
| |
| − | # Select ''Change drive letter or paths...''
| |
| − | #: [[File:10-b.png|560px|screenshot]]
| |
| − | # Select any letter from the drop-down list
| |
| − | #: [[File:11-b.png|360px|screenshot]]
| |
| − | # Click ''OK''.
| |
| − | # You should now be able to see the CONFIG partition in your Windows Explorer. Select the ''config.ini'' configuration file.
| |
| − | #: [[File:12-b.png|560px|screenshot]]
| |
| − | # Click on ''Edit'' to open it in a text-only editor. '''Do not use an editor that will add formatting, as this could cause the installation to fail.'''
| |
| − | # Overwrite the example with your own IPv6 prefix, subnet and gateway.
| |
| − | #: [[File:13-b.png|560px|screenshot]]
| |
| − | # Once done, don’t forget to save the changes. If you need help, please do not hesitate to contact the Internet Computer Association.
| |
| − | #: [[File:14-b.png|560px|screenshot]]
| |
| − | | |
| − | === 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.
| |
| − | #: [[File:linux_01.png|560px|screenshot]]
| |
| − | # Double-click to open it in KWrite.
| |
| − | # Overwrite the example with your own IPv6 prefix, subnet and gateway.
| |
| − | #: [[File:linux_02.png|560px|screenshot]]
| |
| − | # Once done, don’t forget to save the changes. If you need help, please do not hesitate to contact the Internet Computer Association.
| |
| − | #: [[File:linux_03.png|560px|screenshot]]
| |
| − | | |
| − | == 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
| |
| − | #: [[File:08.png|580px|screenshot]]
| |
| − | | |
| − | == VI. UEFI - Enter System Setup and reset IDRAC password ==
| |
| − | # Reboot or power on the server.
| |
| − | # Watch for the ''blue screen'' with boot options in the top left corner.
| |
| − | # Press F2 a couple of times, once the options are listed.
| |
| − | # If your option is recognized by the system, it should be highlighting ''Entering System Setup''.
| |
| − | # In the System Setup, select iDRAC Settings and press enter.
| |
| − | #: [[File:rpviewer_(18).png|580px|screenshot]]
| |
| − | # Select User Configuration and press enter.
| |
| − | #: [[File:rpviewer_(19).png|580px|screenshot]]
| |
| − | # Select Change Password and press enter.
| |
| − | #: [[File:rpviewer_(21).png|580px|screenshot]]
| |
| − | # Enter in your desired password and select OK.
| |
| − | #: [[File:rpviewer_(22).png|580px|screenshot]]
| |
| − | # Select Back and Finish.
| |
| − | | |
| − | == VII. UEFI - System BIOS ==
| |
| − | #
| |
| − | #: In the System Setup, select ''System BIOS'' and press enter.
| |
| − | #: [[File:Select_System_Bios.png|580px|screenshot]]
| |
| − | #
| |
| − | #: In the System BIOS, select ''Processor Settings'' and press enter.
| |
| − | #: [[File:19.png|580px|screenshot]]
| |
| − | #
| |
| − | #: Set ''NUMA Nodes Per Socket'' to '''0'''
| |
| − | #: Set ''Minimum SEV non-ES ASID'' to '''253'''
| |
| − | #: Select ''back'' to return to System BIOS.
| |
| − | #: [[File:20.png|580px|screenshot]]
| |
| − | | |
| − | == VIII. UEFI - Boot Settings ==
| |
| − | #
| |
| − | #: Select ''Boot Settings'' and press ''enter''.
| |
| − | #: [[File:21.png|580px|screenshot]]
| |
| − | #
| |
| − | #: Set ''Boot Mode'' to '''UEFI'''
| |
| − | #: Select ''back'' to return to System BIOS.
| |
| − | #: [[File:22.png|580px|screenshot]]
| |
| − | | |
| − | == IX. UEFI - Integrated Devices ==
| |
| − | #
| |
| − | #: Select ''Integrated Devices'' and press ''enter''.
| |
| − | #: [[File:23.png|580px|screenshot]]
| |
| − | #
| |
| − | #: Set ''PCIe Preferred IO Bus'' to '''Enabled'''
| |
| − | #: Set ''Enhanced Preferred IO'' to '''Enabled'''
| |
| − | #: Set ''SR-IOV Global Enable'' to '''Enabled'''
| |
| − | #: Select ''back'' to return to System BIOS.
| |
| − | #: [[File:24.png|580px|screenshot]]
| |
| − | | |
| − | == X. UEFI - Miscellaneous Settings ==
| |
| − | #
| |
| − | #: Select ''Miscellaneous Settings'' and press ''enter''.
| |
| − | #: [[File:25.png|580px|screenshot]]
| |
| − | #
| |
| − | #: Set ''F1/F2 Prompt'' on Error to '''Disabled'''
| |
| − | #: Select ''back'' to return to System BIOS.
| |
| − | #: [[File:26.png|580px|screenshot]]
| |
| − | #
| |
| − | #: Select ''Finish'' and press ''enter''.
| |
| − | #: [[File:27.png|580px|screenshot]]
| |
| − | #
| |
| − | #: Select ''Yes'' to save the changes and press ''enter''.
| |
| − | #: [[File:28.png|580px|screenshot]]
| |
| − | #
| |
| − | #: Select ''OK'' and press ''enter''.
| |
| − | #: [[File:29.png|580px|screenshot]]
| |
| − | #
| |
| − | #: Confirm the exit and press ''enter''. The system will reboot now. '''Please do not unplug the IC-OS USB stick''' at this point.
| |
| − | | |
| − | == XI. Boot Manager - Enter Boot Manager ==
| |
| − | #
| |
| − | #: Watch for the Blue screen with boot options in the top left corner. Press ''F11'' a couple of times, once the options are listed.
| |
| − | #: [[File:16.png|580px|screenshot]]
| |
| − | #
| |
| − | #: If your option is recognized by the system, it should be highlighting Entering Boot Manager.
| |
| − | #: [[File:32.png|580px|screenshot]]
| |
| − | #
| |
| − | #: In the Boot Manager, select ''One-shot UEFI Boot Menu'' and press ''enter''.
| |
| − | #: [[File:33.png|580px|screenshot]]
| |
| − | #
| |
| − | #: In the Boot Menu, select your ''USB device'' and press ''enter''.
| |
| − | #: [[File:34.png|580px|screenshot]]
| |
| − | | |
| − | == XII. IC-OS - Installer Boot ==
| |
| − | #
| |
| − | #: Please wait while the USB Installer is booting up. This process can take up to 3 minutes.
| |
| − | #: [[File:35-d.png|780px|screenshot]]
| |
| − | #
| |
| − | #: The IC-OS installation starts. Please keep an eye on the progress. This part can take up to 10 minutes (the duration heavily depends on the speed of the IC-OS USB device).
| |
| − | #: If you encounter any issues, please send an email with the error message to: [email protected]. | |
| − | #: [[File:36-d.png|780px|screenshot]]
| |
| − | #
| |
| − | #: Once you get asked to insert the HSM, please remove the keyboard and instead insert the HSM USB device.
| |
| − | #: [[File:37.png|580px|screenshot]]
| |
| − | #
| |
| − | #: If the installation finished successfully, it will initiate a reboot. '''Please do not unplug the IC-OS USB stick or HSM USB device''' at this point.
| |
| − | #: [[File:38-d.png|780px|screenshot]]
| |
| − | | |
| − | == XIII. IC-OS - First Boot ==
| |
| − | #
| |
| − | #: 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.
| |
| − | #: [[File:39-d.png|780px|screenshot]]
| |
| − | #
| |
| − | #: '''Once you see this message, you may unplug the HSM USB device, IC-OS USB stick and VGA/Video.''' Your machine successfully joined the Internet Computer.
| |
| − | #: [[File:40-D.png|780px|screenshot]]
| |
| − | | |
| − | [[Node Provider Onboarding|Return to the Onboarding Document]] | |