Running MultiNodes

Architecture

Install multi-nodes can be illustrated as below:

• WatchTower: When there is a difference between the local storage node image and the official storage node image, watchtower will automatically pull the new official image, create a new miner, and then delete the old one.

• Storage node: A storage node communicate with each other via HTTP. The ports configured in the config template are: 15001, 15002.

• Chain: A chain node. storage node query blockchain data through the chain node's 9944 port by default; chain nodes synchronize data among themselves through the default port: 30336.

• Watchdog: storage nodes monitor. can scrape node's data from different hosts and alert user when some exception occurs.

• Dashboard: The dashboard of storage node monitor. can display the storage node data in a web page.

Multi-miner Architecture

System requirements

Minimum Configuration Requirements:

Resource	Specification
Recommended OS	Linux 64-bit Intel / AMD
# of CPU Cores	≥ 4
Memory	≥ 8 GB
Bandwidth	≥ 20 Mbps
Public Network IP	required
Linux Kernel Version	5.11 or higher

Each storage node requires at least 4GB of RAM and 1 processor, and the chain node requires at least 2GB of RAM and 1 processor.

At least 10GB of RAM and 3 processors if running 2 storage nodes and 1 chain node at the same time

Storage environment requirements

Installation operation has certain requirements on the storage environment in the current host, and different configurations are required based on the disk configuration.

Multiple Disks

As shown in the figure below, where /dev/sda is the system disk, /dev/sdb and /dev/sdc is the data disk, users can directly partition and create file systems on the data disks, and finally mount the file systems to the working directory of the miner.

Multi Disk

fdisk /dev/sdb

# 2048: The starting sector of a new disk is usually set to 2048. This ensures that the partition boundaries are aligned with the physical sectors of the hard disk.
# the value after default: The default is the maximum sector value, which partitions the entire disk.

Enter and press Enter:
n
p
1
2048
the value after default
w

# create filesystem in /dev/vdb
sudo mkfs.ext4 /dev/sdb

Proceed anyway? (y,N) y

# create a diskPath of a storage node
sudo mkdir /mnt/cess_storage1

# mount filesystem
sudo mount /dev/sdb /mnt/cess_storage1

# auto mount when your reboot your server
sudo cp /etc/fstab /etc/fstab.bak

# modify <disk: /dev/sdb> <mount path: /mnt/cess_storage1>
sudo sh -c "echo `blkid /dev/sdb | awk '{print $2}' | sed 's/\"//g'` /mnt/cess_storage1 ext4 defaults 0 0 >> /etc/fstab"

Repeat the above steps to partition /dev/sdc and create a filesystem, then mount it to the file directory: /mnt/cess_storage2

In the case where a disk is divided into many partitions, when the disk is damaged, all storage nodes that use its partitions for work will be affected.

Single Disk

This procedure is suitable for environments with only one system disk.

Scene 1

As shown in the following example, if there is only one 50GB system disk, the Last sector value of partition /dev/sda3 of disk /dev/sda is already at its maximum value (50GB disk can not be partitioned anymore).

[cess@cess ~]# lsblk 
NAME   MAJ:MIN RM  SIZE RO TYPE MOUNTPOINT
sda    253:0    0   50G  0 disk 
├─sda1 253:1    0    2M  0 part 
├─sda2 253:2    0  200M  0 part /boot/efi
└─sda3 253:3    0 49.8G  0 part /

As shown above, the current system kernel is using this partition, so it can not modify the partition to build the running environment required for multi-nodes.

If the partition does not take up the entire disk and there is still storage space available for partitioning, you can configure the partition by referring to the configuration method of Multiple Disks.(In this situation, the running of multi-nodes will depend on this single disk)

Scene 2

As shown in the figure below, the current environment has only one /dev/nvme0n1 system disk with about 1.8T of storage space, which is partitioned three times, including /dev/nvme0n1p1, /dev/nvme0n1p2 and /dev/nvme0n1p3.

The current system relies on the virtual logical disk /dev/ubuntu-vg/ubuntu-lv created in the third partition /dev/nvme0n1p3. Since this virtual logical disk occupies only 100GB of storage space, you can configure a multi-nodes environment by using lvm to create multiple virtual logical volumes on the remaining space.

Single Disk

# use command: vgs to show current volume group, and find that the current volume group name is: ubuntu-vg, VFree displays the remaining storage space of the current volume group.
$ vgs
cess@cess:/home/cess# vgs
  VG        #PV #LV #SN Attr   VSize   VFree
  ubuntu-vg   1   1   0 wz--n- <1.82t  1.7T

# use command: lvcreate to create a 100GB logic volume named cess_storage from volume group: ubuntu-vg
$ sudo lvcreate -L 100g -n cess_storage ubuntu-vg -y
# use command: lvcreate to create logic volume named cess_storage from all remaining space of volume group: ubuntu-vg
# sudo lvcreate -l 100%FREE -n cess_storage ubuntu-vg -y

# use command: lvdisplay to display logic volume your have created, name: cess_storage, path: /dev/ubuntu-vg/cess_storage
$ sudo lvdisplay
cess@cess:/home/cess# lvdisplay
  --- Logical volume ---
  LV Path                /dev/ubuntu-vg/ubuntu-lv
  LV Name                ubuntu-lv
  VG Name                ubuntu-vg
  LV UUID                zxJiPj-Anon-CG3r-XEIJ-Nydi-xxxx-U6oWqW
  LV Size                100.00 GiB
   
  --- Logical volume ---
  LV Path                /dev/ubuntu-vg/cess_storage
  LV Name                cess_storage
  VG Name                ubuntu-vg
  LV UUID                33Z2eL-AVma-oV4V-1vnE-G3YC-xxxx-wtzxHs
  LV Size                <1.72 TiB

# create filesystem in /dev/ubuntu-vg/cess_storage
$ sudo mkfs.ext4 /dev/ubuntu-vg/cess_storage

# create a diskPath of a storage node
sudo mkdir /cess

# mount filesystem
sudo mount /dev/ubuntu-vg/cess_storage /cess

# auto mount when your reboot your server
sudo cp /etc/fstab /etc/fstab.bak
# modify <lv path>, <diskPath>, <filesystem type>
sudo sh -c "echo `blkid /dev/ubuntu-vg/cess_storage | awk '{print $2}' | sed 's/\"//g'` /cess ext4 defaults 0 0 >> /etc/fstab"

Warning: If create multiple logic volumes on a single disk by lvm, then mount multiple logic volumes on different diskPath, when the disk is damaged, all nodes relying on lvm will be affected!

1. Download and install multi-nodes client

sudo wget https://github.com/CESSProject/cess-multiminer-admin/archive/latest.tar.gz
sudo tar -xvf latest.tar.gz
cd cess-multiminer-admin-latest
sudo bash ./install.sh

2. Customize your own configuration

After executing the above installation command, customize your own config file at: /opt/cess/mineradm/config.yaml.

• UseSpace: Storage capacity of the storage node, measured in GB.

• UseCpu: Number of logical cores used by the storage node.

• TeeList: The public key of tee node, storage node will not use public tee nodes on chain if set custom tee nodes in config.yaml.

• port: Storage node use that port to communicat with each other, the port of each storage node must be different and not occupied by other process.

• apiendpoint: An external IP address or domain which can be accessed by internet, default value: hostPublicIP:port.

• diskPath: Absolute system path where the storage node run, requiring a file system to be mounted at this path.

• earningsAcc: Used to receive mining rewards. Get earningsAcc and mnemonic
• mnemonic: Account mnemonic, consisting of 12 words, with each storage node requiring a different mnemonic, set mnemonic as node's signatureAcc in /opt/cess/mineradm/config.yaml.

• stakingAcc: Used to pay for staking TCESS. 4000 TCESS at least is required for stakingAcc(Get TCESS). SignatureAcc also can be a stakingAcc when delete property: stakingAcc or make it empty in /opt/cess/mineradm/config.yaml.
• chainWsUrl: As an RPC node for blockchain synchronization. The priority of miners[].chainWsUrl is higher than node.chainWsUrl in /opt/cess/mineradm/config.yaml.

• backupChainWsUrls: Backup RPC nodes that can be official RPC nodes or other RPC nodes you know. The priority of miners[].backupChainWsUrls is higher than node.backupChainWsUrls in /opt/cess/mineradm/config.yaml.

• Timeout: Timeout about storage miner transaction with chain.

• watchdog.enable: Enable watchdog to monitor the health of the storage node.

• watchdog.apiUrl: A public url that can access to the watchdog service, user can set a dns resolution and proxy service to these watchdog server. default value: http://<host public ip>:$port.

• watchdog.port: Watchdog server listen at this port.

• watchdog.hosts: Watchdog server can scrape nodes data from these hosts, ip is the host ip, port is the port which docker daemon listen. TLS configuration must be set if scrape data from a host in a public network. how to set docker daemon tls
• watchdog.alert: Enable alert or not. Watchdog will send alert to the email address you set in watchdog.alert.email.receiver and send webhook to the webhook url you set in watchdog.alert.webhook if alert enable.

/opt/cess/mineradm/config.yaml Template as below:

## node configurations template
node:
  ## the mode of node: multiminer
  mode: "multiminer"
  ## the profile of node: devnet/testnet/mainnet
  profile: "testnet"
  # default chain url for storage node, can be overwritten in miners[] as below
  chainWsUrl: "ws://127.0.0.1:9944/"
  # default backup chain urls for storage node, can be overwritten in miners[] as below
  backupChainWsUrls: [ "wss://testnet-rpc.cess.network" ]

## chain configurations
## set option: '--skip-chain' or '-s' to skip installing chain (mineradm install --skip-chain)
## if set option: --skip-chain, please set official chain in miners[].chainWsUrl or others chains you know
chain:
  ## the name of chain node
  name: "cess"
  ## the port of chain node
  port: 30336
  ## listen rpc service at port 9944
  rpcPort: 9944

## storage nodes configurations  (multi nodes mode)
miners:
  - name: "miner1"
    # Use this endpoint to receive/send file, can be a domain or ip:port, default value: hostPublicIp:port
    apiendpoint: ""
    # storage miner listen at this port
    port: 15001
    # Maximum space used in each miner, the unit is GiB
    # The declaration space on chain is auto set by the value of `UseSpace after round up to the closest TB` when the miner first run
    # If set UseSpace 2300, that means declare 3 TiB space on the chain
    # If set UseSpace 300, that means declare 1 TiB space on the chain
    UseSpace: 1000
    # Number of cpu's processor used, 0 means use all
    UseCpu: 2
    # earnings account
    earningsAcc: "cXxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    # Staking account
    # If you fill in the staking account, the staking will be paid by the staking account you set,
    # otherwise the staking will be paid by the signatureAcc(mnemonic).
    stakingAcc: ""
    # Signature account mnemonic
    # each miner's mnemonic should be different
    mnemonic: "aaaaa bbbbb ccccc ddddd eeeee fffff ggggg hhhhh iiiii jjjjj kkkkk lllll"
    # miner work at this path
    diskPath: "/mnt/cess_storage1"
    # The rpc endpoint of the chain
    # `official chain: "wss://testnet-rpc.cess.network"`
    chainWsUrl: "ws://127.0.0.1:9944"
    backupChainWsUrls: [ "wss://testnet-rpc.cess.network" ]
    # Timeout about storage miner transaction with chain 
    Timeout: 12
    # Tee public key, can get this key from the starting log of cifrost container
    # Attention: Storage miner will not use public tee nodes on chain if set custom tee nodes in config.yaml
    # TeeList:
    #  - 0x3222602a6be742ec9edc3c31cb48dd8a48001bc6efba6c2ed59cd728cdf46a55
    #  - 0x.....

  - name: "miner2"
    apiendpoint: ""
    port: 15002
    UseSpace: 1000
    UseCpu: 2
    earningsAcc: "cXxxx"
    stakingAcc: ""
    mnemonic: "xxx"
    diskPath: "/mnt/cess_storage2"
    chainWsUrl: "ws://127.0.0.1:9944"
    backupChainWsUrls: [ "wss://testnet-rpc.cess.network" ]
    Timeout: 12
    
    
# nodes monitor service, send alert with email/webhook when nodes is down or get punishment
watchdog:
  # enable storage nodes monitor or not
  enable: false
  # external: run with 0.0.0.0 or 127.0.0.1
  external: false
  # apiUrl: watchdog-web request this apiUrl to fetch data from watchdog: <public_ip:13081 or a domain>
  apiUrl: ""
  # watchdog server listen http port at: 13081 (watchdog-web listen at 13080)
  port: 13081
  # the interval of scrape data from chain for each storage node, 30 <= scrapeInterval <= 300
  scrapeInterval: 60
  # watchdog can scrape nodes data from this hosts
  hosts:
    - ip: 127.0.0.1 # 127.x, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16
      # make sure docker daemon listen at 2375: https://docs.docker.com/config/daemon/remote-access/
      # will be bind at 127.0.0.1:2375 when install mineradm
      port: 2375
    # Configure remote access for Docker daemon in public network must use tls to make sure mnemonic safe
    # set ca/crt/key path if the ip no belongs to [ 127.x, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 ]
    - ip: 1.1.1.1 # 1.1.1.1 is a public IP
      # make sure docker daemon tls listen at 2376: https://docs.docker.com/engine/security/protect-access/
      port: 2376
      # please make sure each file name is unique, can get help from: https://doc.cess.network/cess-miners/storage-miner/troubleshooting
      # will mount this files from host to container automatically
      ca_path: /etc/docker/tls/1.1.1.1_ca.pem
      cert_path: /etc/docker/tls/1.1.1.1_cert.pem
      key_path: /etc/docker/tls/1.1.1.1_key.pem
  alert:
    # enable alert or not
    enable: false
    # send webhook to alert someone
    webhook:
      - https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
      - https://discordapp.com/api/webhooks/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    # send email to alert someone
    email:
      smtp_endpoint: smtp.example.com
      smtp_port: 80
      smtp_account: [e-mail]
      smtp_password: my_pwd
      receive_addr:
        - [e-mail]
        - [e-mail]

3. Generate configuration

The following command will generate config.yaml for each storage node and generate docker-compose.yaml based on the file located at: /opt/cess/mineradm/config.yaml.

sudo mineradm config generate

• Generate each storage node configuration at $diskPath/miner/config.yaml. For example, miner1's configuration generate at: /mnt/cess_storage1/miner/config.yaml

• Generate docker-compose.yaml at /opt/cess/mineradm/build/docker-compose.yaml

• If set enable watchdog service, its config will be generated at /opt/cess/mineradm/build/watchdog/config.yaml

Leave watchdog.apiUrl empty in /opt/cess/mineradm/config.yaml can set this value as http://<your public ip>:13081 automatically.

If you want access to the watchdog dashboard via a domain, please set your domain in /opt/cess/mineradm/config.yaml: watchdog.apiUrl and then re-run command: mineradm config generate. Set your domain as apiUrl in /opt/cess/mineradm/build/docker-compose.yaml: watchdog-web.environment.NEXT_PUBLIC_API_URL also has the same effect.

A nginx proxy example as below:

server {
  listen 80;
  server_name mydomain.com;
  location / {
	proxy_pass http://127.1:13081;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  }
}

4. Installation

Install all services

Install watchTower, rpc node, watchdog, watchdog-web and storage nodes services

sudo mineradm install

Skip install rpcnode

If an official RPC node or other known RPC node is configured in the configuration file, you can skip starting a local RPC node with --skip-chain.

sudo mineradm install --skip-chain

5. Common Operations

Stop all services

  sudo mineradm stop

Stop one or more specific service

Such as execute sudo mineradm stop miner1 miner2 to stop miner1 and miner2

  sudo mineradm stop [miner name]

Stop and remove all services

  sudo mineradm down

Stop and remove one or more specific service

Such as execute sudo mineradm down miner1 to remove miner1

  sudo mineradm down [miner name]

Restart all services

  sudo mineradm restart

Restart one or more specific service

Such as execute sudo mineradm restart miner1 to restart miner1

  sudo mineradm restart [miner name]

Get version information

  sudo mineradm version

Check services status

  sudo mineradm status

Pull and update images

  sudo mineradm pullimg

Check local disk usage

  sudo mineradm tools space-info

View all storage nodes status

If you get the result of you are not registered as a storage miner yet..., please allow several hours for the rpc node block synchronization when you first run.

  sudo mineradm miners stat

Increase all storage nodes staking

Only all storage nodes signatureAcc(mnemonic) is the same as its stakingAcc can use this command, otherwise can only transfer staking to stakingAcc in browser manually.

Such as execute sudo mineradm miners increase staking 4000 to increase all storage nodes staking

  sudo mineradm miners increase staking $deposit_amount

Increase a specific storage node's staking

Make sure that the storage node's signatureAcc(mnemonic) is the same as its stakingAcc can use this command, otherwise can only transfer staking to stakingAcc in browser manually.

Such as sudo mineradm miners increase staking miner1 4000

  sudo mineradm miners increase staking $miner_name $deposit_amount

Increase all storage nodes declaration space

space_amount unit: TiB, The declaration space on chain is auto set by the value of UseSpace after round up to the closest TB when the storage node first run

Before increase declaration space, please make sure that the storage node have sufficient TCESS in stakingAcc. For example, increase staking from 4000 to 8000 before increase declaration space from 1 Tib to 2 TiB

Execute: sudo mineradm miners stat to check current declaration space at first

After increase staking in stakingAcc, then execute sudo mineradm miners increase space 2 to increase all storage nodes staking declaration space to 2 TiB

  sudo mineradm miners increase space $space_amount

Increase a specific storage node's declaration space

space_amount unit: TiB, command usage as same as above

  sudo mineradm miners increase space $miner_name $space_amount

Change all storage nodes UseSpace

UseSpace unit: GiB

The UseSpace in each storage node is less or equal to declaration space, the storage node can only use storage space less or equal to UseSpace

If set UseSpace to 2100 when storage node first run, that means the storage node declare 3 TiB space on the chain, if set UseSpace to 300 when storage node first run, that means declare 1 TiB space on the chain(at least 1 TB)

Example 1: The miner1's disk size is 1.5 TiB in current, but only set 800 GiB UseSpace for running, then you can run sudo mineradm tools set use-space miner1 1200 to increase UseSpace to 1200 GiB

Example 2: The miner1's disk size is 1.5 TiB in current, and set 1400 GiB UseSpace for running, so you can run sudo mineradm tools set use-space mienr1 1000 to decrease miner1's UseSpace to 1000 GiB if the result of used space with mineradm miners stat is less than 1000 GiB

If only declare 1 TiB on the chain, but set UseSpace greater than 1024 GiB, the additional UseSpace in storage node can not be used

  sudo mineradm tools set use-space $UseSpace

Change a specific storage node's UseSpace

UseSpace unit: GiB, command usage as same as above

  sudo mineradm tools set use-space $miner_name $UseSpace

Query all storage nodes reward

  sudo mineradm miners reward

Claim all storage nodes reward

  sudo mineradm miners claim

Claim a specific storage node's reward

Such as sudo mineradm miners claim miner1

  sudo mineradm miners claim $miner_name

Update a storage node's earnings account

Such as change miner1's earningsAcc to $earnings_account: sudo mineradm miners update account miner1 $earnings_account

  sudo mineradm miners update account $miner_name $earnings_account

Update all storage nodes earnings account

  sudo mineradm miners update account $earnings_account

The process of exiting the CESS network will last for hours, and forcing an exit in the middle of the process might make the storage node being punished.

Make all storage nodes exit the network of cess

  sudo mineradm miners exit

Make a specific storage node exit the network of cess

Such as sudo mineradm miners exit miner1

  sudo mineradm miners exit $miner_name

Withdraw all storage nodes staking

After all storage nodes has exited CESS Network (see above), run

  sudo mineradm miners withdraw

Withdraw a specific storage node's staking

After this node has exited CESS Network (see above), run

  sudo mineradm miners withdraw $miner_name

Remove the local chain data

  sudo mineradm purge

6. Upgrade mineradm client

Upgrade the mineradm client by execute command as below:

cd /tmp
sudo wget https://github.com/CESSProject/cess-multiminer-admin/archive/latest.tar.gz -O /tmp/latest.tar.gz
sudo tar -xvf latest.tar.gz
cd cess-multiminer-admin-latest
sudo bash ./install.sh --no-rmi --retain-config --skip-dep --keep-running

After the program update is completed, please regenerate your configuration as below:

sudo cat /opt/cess/mineradm/.old_config.yaml > /opt/cess/mineradm/config.yaml
sudo mineradm config generate

Options help:

    -n | --no-rmi              do not remove the corresponding image when uninstalling/upgrade the old services
    -r | --retain-config       retain old config at: /opt/cess/mineradm/.old_config.yaml when upgrade mineradm
    -s | --skip-dep            skip install the dependencies
    -k | --keep-running        do not stop the services if cess services is running