Setting Up an External Passive Relay Node

This quick start guide walks through setting up an external relay node with the help of CNTOOLs.

PreviousIncreasing Swap File Size NextSetting Up WireGuard

Last updated 3 months ago

Major credits and appreciation to the fine folks at Cardano Community Guild Operators for creating and maintaining CNtool, a most helpful swiss army knife for pool operators. You MUST be familiar with how ADA staking works and possess fundamental Linux system administration skills before continuing this guide.

Relay nodes do not have any keys, so they cannot produce blocks. Instead, relays act as proxies between the core network nodes and the Internet, establishing a security perimeter around the core, block-producing network nodes. Since external nodes cannot communicate with block-producing nodes directly, relay nodes ensure that the integrity of the core nodes and the blockchain remains intact, even if one or more relays become compromised.

Prerequisites

A different server/VM (not located on the same machine as your block-producer node)

Running the prereqs.sh Script

Installs prerequisite dependencies and creates folder structure.

sudo apt-get install curl net-tools

mkdir "$HOME/tmp";cd "$HOME/tmp"
# Install curl
# CentOS / RedHat - sudo dnf -y install curl
# Ubuntu / Debian - sudo apt -y install curl
curl -sS -o prereqs.sh https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/prereqs.sh
chmod 755 prereqs.sh

# Ensure you can run sudo commands with your user before execution
# You can check the syntax for prereqs.sh using command below:
#
# ./prereqs.sh -h
# Usage: prereqs.sh [-o] [-s] [-i] [-g] [-p]
# Install pre-requisites for building cardano node and using cntools
# -o    Do *NOT* overwrite existing genesis and topology.json files (Default: will overwrite)
# -s    Skip installing OS level dependencies (Default: will check and install any missing OS level prerequisites)
# -i    Interactive mode (Default: silent mode)
# -g    Connect to guild network instead of public network (Default: connect to public cardano network)
# -p    Copy Transitional Praos config as default instead of Combinator networks (Default: copies combinator network)

# You can use one of the options above, if you'd like to defer from defaults (below).
# Running without any parameters will run script in silent mode with OS Dependencies, and overwriting existing files.

./prereqs.sh

Reload environment variables.

. "${HOME}/.bashrc"

Familiarize yourself with the folder structure created by CNtools.

To clone the git repository, type:

cd ~/git
git clone https://github.com/input-output-hk/cardano-node
cd cardano-node

To compile binaries, type the following commands where <NodeVersion> is the node version number or branch that you want to build:

git fetch --tags --all
git pull
# For example, to build node version 1.26.2 type git checkout 1.26.2
git checkout <NodeVersion>


$CNODE_HOME/scripts/cabal-build-all.sh

To install the compiled binaries, type:

sudo cp $HOME/.cabal/bin/cardano* /usr/local/bin

To verify that the correct Cardano node and command line versions are installed, type:

cardano-node version
cardano-cli version

Using systemd services to run your Cardano nodes offers the following benefits:

Auto-start your node when the computer reboots due to maintenance, power outage, etc.
Automatically restart crashed node processes.
Maximize your stake pool up-time and performance.

sudo bash -c "cat << 'EOF' > /etc/systemd/system/cnode.service
[Unit]
Description=Cardano Node
After=network.target

[Service]
Type=simple
Restart=on-failure
RestartSec=5
User=$USER
LimitNOFILE=1048576
WorkingDirectory=$CNODE_HOME/scripts
ExecStart=/bin/bash -l -c \"exec $CNODE_HOME/scripts/cnode.sh\"
ExecStop=/bin/bash -l -c \"exec kill -2 \$(ps -ef | grep [c]ardano-node.*.${CNODE_HOME} | tr -s ' ' | cut -d ' ' -f2)\"
KillSignal=SIGINT
SuccessExitStatus=143
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cnode
TimeoutStopSec=5
KillMode=mixed

[Install]
WantedBy=multi-user.target
EOF"

sudo systemctl daemon-reload
sudo systemctl enable cnode.service

Nice work. Your node is now managed by the reliability and robustness of systemd. Below are some commands for using systemd.

To confirm that the node service is active, type:

sudo systemctl is-active cnode

To display the status of the node service, type:

sudo systemctl status cnode

To restart the node service, type:

sudo systemctl reload-or-restart cnode

To stop the node service, type:

sudo systemctl stop cnode

To filter logs, type:

journalctl --unit=cnode --since=yesterday

journalctl --unit=cnode --since=today

journalctl --unit=cnode --since='2020-07-29 00:00:00' --until='2020-07-29 12:00:00'

To start the relay node, type:

sudo systemctl start cnode

To install Guild LiveView, type:

cd $CNODE_HOME/scripts
curl -s -o gLiveView.sh https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/gLiveView.sh
curl -s -o env https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/env
chmod 755 gLiveView.sh

To run Guild Liveview, type:

./gLiveView.sh

Sample output of Guild Live View

For more information, refer to the official Guild Live View docs.

Modify the localRoots section of the topology.json file to configure your relay node's connections to your other relays and your block producer node. For more details, see the topic Configuring Topology.

Specific to your networking setup or cloud provider settings, ensure your relay node's port 6000 is open and reachable.

Additionally, if you have prometheus-node-exporter installed for providing Grafana statistics, then you need to open ports 9100 and 12798. Do not forget to update prometheus.yml on your prometheus server (aka relaynode1). Restart the prometheus service so that the new relay node appears in your dashboard.

Finally, add your new relay node IP/port information to the localRoots section of the topology.json file for your existing block producer and/or relay nodes. For more details, see the topic Configuring Topology.

Example snippet to add to your block producer's topology file. Add a comma to separate the nodes where appropriate.

 {
    "address": "<relay node public ip address>",
    "port": 6000
 }

To refresh topology configurations for a node, you need to restart the node.

To restart nodes:

Type:

sudo systemctl reload-or-restart cnode

Repeat step 1 for each node having updated topology configurations.

On the Guild LiveView screen, press P to view the peer list. You should see the connection to other node's IP address.

Did you find our guide useful? Send us a signal with a tip and we'll keep updating it.

It really energizes us to keep creating the best crypto guides.

Hang out and chat with our stake pool community on Telegram @ https://t.me/coincashew

Setting Up an External Passive Relay Node

Prerequisites

Running the prereqs.sh Script

Building the Cardano Node and Command Line Interface

Using systemd Services

Example systemd Commands

Filtering Logs

Starting the Relay Node

Configuring and Reviewing the Relay Node Topology File

Configuring Port Forwarding and/or Firewall

Configuring Topology for Existing Nodes

Restarting Nodes

Testing the Connection