Skip to main content

Compute Node - CLI


Registering Iagon Compute Node using Compute Node CLI​

Iagon Compute Node CLI is a CLI application which allows users to share their computational power on the Iagon network to earn rewards.

This document provides step-by-step instructions to help you install and set up Iagon Compute Node CLI on your system. Currently only Linux-based OS are supported.


Installation​

You can download the Official Compute Node CLI binary from the Iagon's Github Release page. Once downloaded, navigate to the CLI binary and mark it as executable:

wget -qO- https://github.com/Iagonorg/Mainnet-Compute-Node/releases/download/v0.2.0-beta/install.sh | sudo bash

Iagon Compute Node depends on third party trusted packages to perform various benchmarks. These benchmarks help track the current performance and availability of the node in the Iagon Network for use. These packages don't come bundled with the Iagon Compute Node CLI binary and have to be installed by the user.

Minimum System Requirements​

  • OS: Linux (Ubuntu 22.04)
  • CPU Cores Count = 4
  • Memory = 8 GB
  • CPU base ClockSpeed = 2 Ghz
  • Storage = 100 GB
  • Sequential Read Speed = 5000 Mbps
  • Sequential Write Speed = 5000 Mbps
  • Random Read Speed = 300 Mbps
  • Random Write Speed = 300 Mbps
  • Maximum Ping = 100
  • Maximum latency = 100
  • Upload Speed = 150 Mbps
  • Download Speed = 150 Mbps
  • Memory Read Speed = 45000 Mbps
  • Memory Write Speed = 40000 Mbps
  • CPU EPS (Sysbench) Value = 60

Prerequisites​

Before installing the Compute Node CLI, ensure the following prerequisites are met:

Port Forwarding​

Enable port forwarding for both ssh server and the compute node binary on a static ip. These ports are to be provided during registration process and should be accessible from the internet.

OpenSSH Server​

OpenSSH Server is required for remote access of Compute Nodes. If not already installed, you can install it via apt:

sudo apt install openssh-server

After the installation, ensure that openssh server is running. The user is prompted to provide the ssh port and user credential duing the registration process from the CLI. For testing it is recommended to create a separate ssh user with minimum/restricted permissions.

FIO​

FIO is a powerful tool for testing I/O performance. Follow the installation instructions from FIO's Github repository, or install it via apt:

sudo apt install fio

Sysbench​

Sysbench is a versatile benchmarking tool for evaluating system CPU and memory performances. Installation instructions can be found on sysbench's Github repository, or you can install it via apt:

sudo apt install sysbench

Usage​

Once the binary and the necessary dependencies are installed, you can use the Compute Node CLI. There are various commands available in the CLI to make the on-boarding/registration process easier. The user can start the node and execute various test commands to check the hardware status of the node.


Commands​

Execute the following commands, as: ./iag-compute-cli some-command

  1. start Evaluate/Register the host machine as compute node or start compute node if already evaluated.

  2. stop Stop compute node (if already running)

  3. status Check running status of compute node

  4. check
    Check if the system adhere to prerequisite criteria

  5. info Extract basic information about the system

  6. test-node Test if the node is accessible from the internet

  7. clear-config
    Clear the configurations

  8. tasks Show the compute tasks running on the node.

  9. benchmark-memory
    Run memory tests and benchmark for the host machine

  10. benchmark-cpu Run cpu tests and benchmark for the host machine

  11. benchmark-storage Run storage i/o tests and benchmark for the host machine

  12. benchmark-network Run network tests and benchmark for the host machine

  13. help Display help for command


Node Integration​

Adding Node​

  • Navigate to the 'Provider' section to begin.
  • In the Provider dashboard, find 'Compute' on the left-hand menu bar.
  • Click on 'Compute node' to reach the page with the 'Add Node' button.
  • Click the 'Add Node' button to proceed to the screen displayed in the screenshot.
  • As shown in the UI, we have to add Auth key

Add-Auth-Key

  • After we add Auth key, we can view the details of the node

nodedetails

  • In the next step, we have to add "Node name" as shown in the picture.

nodedetails

  • In our next step, IAG balance and IAG amount to stake is displayed

balancestake


Metrics Collection Process​

  • Ping stamp -> 3 min
  • Performance metrics:
    • All: once a day
    • Memory: every 2 hr
    • CPU: every 3 hr
    • Storage: once a day
    • Network: every 5 hr

Content