Make sure and check out the START-HERE document.
IMPORTANT: This guide is specifically for Equinix Machines from the Solana Reserve pool accessed through the Solana Foundation Server Program. https://solana.foundation/server-program
You must be running Ubuntu 20.04
So you have your shiny new beast of a server. Let's make it a Shadow Operator RPC Node.
First things first - OS security updates
apt update
apt upgrade
apt dist-upgrade
create user sol
adduser sol
usermod -aG sudo sol
su - sol
Partition hard drive for RPC Partition NVME into 420gb (swap) and ~3000gb (ledger and accounts)
Utilize gdisk to create the swap partition (nvme0n1p2) first, and then take the remaining space for the ledger partition (nvme0n1p1)
Hit enter
after each entry, or enter
where it says "enter" :)
sudo gdisk /dev/nvme0n1
n, 2, enter (default first sector), +420G, 8200 (linux swap), n, 1, enter (first available sector), enter (max sector available), 8300, w, y
Now make filessytems, directories, delete and make new swap, etc:
sudo fdisk -l
sudo mkfs -t ext4 /dev/nvme0n1p1
sudo mount /dev/nvme0n1p1 /mt
sudo mkswap /dev/nvme0n1p2
Discover the swap directory, turn it off, turn on the new swap partition:
sudo swapon --show
You need to look at the directory and pick the correct /dev/sd*
It could be /dev/sdb2 or /dev/sdc2 so edit the next line below to the proper sd**
It will almost always be the one showig 1.9GB of swap size
sudo swapoff /dev/sda2
Next is editing the swappiness to 30 and turning our new swap partition on..
echo 'vm.swappiness=30' | sudo tee --append /etc/sysctl.conf > /dev/null
sudo sysctl -p
sudo swapon /dev/nvme0n1p2
Capture nvme0n1p1 and nvme0n1p2 UUIDs to edit into /etc/fstab
Let's take a look at the file first to get an idea of what is needed here.
sudo nano /etc/fstab
You should see something similar to this:
UUID=e6eafc79-85c3-4208-82ac-41b73d75cd31 / ext4 errors=remount-ro 0 1
UUID=4b8f8a7b-8b8f-4984-a341-5770f8b365a1 none swap none 0 0
These are the default OS drives and should be left alone. Do not overwrite them. You will need to add the two new UUID's of the two partitions you just made (nvmeon1p1 and nvme0n1p2).
lsblk -f
Copy the section that looks similar to the below nvme0n1 partition tree and paste it into a notepad (or VScode, etc) so that you can copy/paste into fstab properly. We just need the UUID's so in the example below copy "5c24e241-239c-4aa5-baa6-fbb6fb44a847" and "87645b08-85c2-4fe2-9974-1bda4de317d9" and note which partition each belongs to (/mt and swap respectively). Your UUIDs will be different! DO NOT COPY THESE DIRECTLY FROM THIS GUIDE!
nvme0n1
├─nvme0n1p1 ext4 5c24e241-239c-4aa5-baa6-fbb6fb44a847 2.8T 0% /mt
└─nvme0n1p2 swap 1 87645b08-85c2-4fe2-9974-1bda4de317d9 [SWAP]
These UUID above need to be edited into the fstab config below
sudo nano /etc/fstab
Leave the first UUID alone (OS related), on the swap partition line, while your UUID values will be different, edit the existing one to have the UUID of your swap partition from the step above.
UUID=87645b08-85c2-4fe2-9974-1bda4de317d9 none swap none 0 0
Now append these lines under whatever current UUIDs are listed as the ones already in the file are boot/OS related. also make sure UUID is correct as they can change:
#GenesysGo RPC Config
UUID=5c24e241-239c-4aa5-baa6-fbb6fb44a847 /mt auto nosuid,nodev,nofail 0 0
save / exit
ctrl+o
enter ctrl+x
The complete file should look like this (but with your own UUIDs):
UUID=e6eafc79-85c3-4208-82ac-41b73d75cd31 / ext4 errors=remount-ro 0 1
UUID=37215cf2-244c-4f2e-98f9-6f327694fe7e none swap none 0 0
#GenesysGo RPC Config
UUID=5c24e241-239c-4aa5-baa6-fbb6fb44a847 /mt auto nosuid,nodev,nofail 0 0
Now make sure everything is mounted:
sudo mount --all --verbose
Finish making directories and setting permissions:
sudo mkdir -p /mt/ledger/validator-ledger
sudo mkdir -p /mt/accounts/solana-accounts
sudo mkdir ~/log
sudo chown -R sol:sol /mt/*
sudo chown sol:sol ~/log
Set up the firewall / ssh
sudo snap install ufw
sudo ufw enable
sudo ufw allow ssh
Dump this entire command block for basic Node function:
sudo ufw allow 53;sudo ufw allow 8899/tcp;sudo ufw allow 8900/tcp;sudo ufw allow 8000:8012/udp
These additional rules are in preparation for more Protocol features. Just drop this expanded rules block when there is a request from the team to expand ports:
sudo ufw allow 53;sudo ufw allow 8899;sudo ufw allow 8899/tcp;sudo ufw allow 8900/tcp;sudo ufw allow 9900/udp;sudo ufw allow 9900/tcp;sudo ufw allow 9900;sudo ufw allow 8900;sudo ufw allow 8000:8012/udp
sh -c "$(curl -sSfL https://release.solana.com/v1.16.15/install)"
It will ask you to map the PATH just copy and paste the command below:
export PATH="/home/sol/.local/share/solana/install/active_release/bin:$PATH"
You are now able to join Solana gossip which is an overarching network communication layer which all RPCs and Validators chatter in. If you see a steam of logs, and no errors then have officially connected directly to the Solana network.
solana-gossip spy --entrypoint entrypoint.mainnet-beta.solana.com:8001
If your machine is gossiping without any errors it can be spun up on the mainnet to start reading the chain data.
Exit gossip with ctrl + c
Now create keys.
RPCs use throw away keys. These keys allow and RPC to be fully functional but do not need funds and do not need to be saved (because you can just make new ones if you need to ). You do not need to set a password for the keys. No need to copy seed phrases. You do not need a wallet-keypair if just RPC. Do not move SOL into these wallets. This is not a validator
solana-keygen new -o ~/validator-keypair.json
solana config set --keypair ~/validator-keypair.json
solana-keygen new -o ~/vote-account-keypair.json
Making system services (sol.service) and the startup script.
This is the solana-validator start up shell script which the system service (sol.service) will reference
sudo nano ~/start-validator.sh
Edit this into start-validator.sh:
#!/bin/bash
PATH=/home/sol/.local/share/solana/install/active_release/bin:/usr/sbin:/usr/bin:/sbin:/bin:/snap/bin
export RUST_BACKTRACE=1
exec solana-validator \
--identity ~/validator-keypair.json \
--entrypoint entrypoint.mainnet-beta.solana.com:8001 \
--entrypoint entrypoint2.mainnet-beta.solana.com:8001 \
--entrypoint entrypoint3.mainnet-beta.solana.com:8001 \
--entrypoint entrypoint4.mainnet-beta.solana.com:8001 \
--entrypoint entrypoint5.mainnet-beta.solana.com:8001 \
--known-validator 7cVfgArCheMR6Cs4t6vz5rfnqd56vZq4ndaBrY5xkxXy \
--known-validator DDnAqxJVFo2GVTujibHt5cjevHMSE9bo8HJaydHoshdp \
--known-validator Ninja1spj6n9t5hVYgF3PdnYz2PLnkt7rvaw3firmjs \
--known-validator wWf94sVnaXHzBYrePsRUyesq6ofndocfBH6EmzdgKMS \
--known-validator 7Np41oeYqPefeNQEHSv1UDhYrehxin3NStELsSKCT4K2 \
--known-validator GdnSyH3YtwcxFvQrVVJMm1JhTS4QVX7MFsX56uJLUfiZ \
--known-validator DE1bawNcRJB9rVm3buyMVfr8mBEoyyu73NBovf2oXJsJ \
--known-validator CakcnaRDHka2gXyfbEd2d3xsvkJkqsLw2akB3zsN1D2S \
--rpc-port 8899 \
--dynamic-port-range 8002-8020 \
--no-port-check \
--gossip-port 8001 \
--no-untrusted-rpc \
--no-voting \
--private-rpc \
--rpc-bind-address 0.0.0.0 \
--enable-cpi-and-log-storage \
--enable-rpc-transaction-history \
--enable-rpc-bigtable-ledger-storage \
--rpc-bigtable-timeout 300 \
--account-index program-id \
--account-index spl-token-owner \
--account-index spl-token-mint \
--rpc-pubsub-enable-vote-subscription \
--no-duplicate-instance-check \
--wal-recovery-mode skip_any_corrupted_record \
--vote-account ~/vote-account-keypair.json \
--log ~/log/solana-validator.log \
--accounts /mt/accounts/solana-accounts \
--ledger /mt/ledger/validator-ledger \
--limit-ledger-size 500000000 \
--rpc-send-default-max-retries 1 \
--rpc-send-retry-ms 2000 \
--rpc-send-service-max-retries 1 \
--account-index-exclude-key kinXdEcpDQeHPEuQnqmUgtYykqKGVFq6CeVX5iAHJq6 \
Save / exit ctrl+0
then ctrl+x
Make this shell file executable.
sudo chmod +x ~/start-validator.sh
Change the ownership to user sol
sudo chown sol:sol start-validator.sh
Create the Solana system service - sol.service (run on boot, auto-restart when sys fail)
sudo nano /etc/systemd/system/sol.service
Edit this into file:
[Unit]
Description=Solana Validator
After=network.target
StartLimitIntervalSec=0
[Service]
Type=simple
Restart=always
RestartSec=1
User=sol
LimitNOFILE=1000000
LogRateLimitIntervalSec=0
Environment="PATH=/bin:/usr/bin:/home/sol/.local/share/solana/install/active_release/bin"
ExecStart=/home/sol/bin/validator.sh
[Install]
WantedBy=multi-user.target
Save / exit ctrl+0
then ctrl+x
Now start manual tunning
sudo bash -c "cat >/etc/sysctl.d/21-solana-validator.conf <<EOF
# Increase UDP buffer sizes
net.core.rmem_default = 134217728
net.core.rmem_max = 134217728
net.core.wmem_default = 134217728
net.core.wmem_max = 134217728
# Increase memory mapped files limit
vm.max_map_count = 1000000
# Increase number of allowed open file descriptors
fs.nr_open = 1000000
EOF"
] Increase systemd and session file limits
Add
LimitNOFILE=1000000
to the [Service] section of your systemd service file, if you use one, otherwise add
DefaultLimitNOFILE=1000000
to the [Manager] section of /etc/systemd/system.conf.
sudo systemctl daemon-reload
sudo bash -c "cat >/etc/security/limits.d/90-solana-nofiles.conf <<EOF
# Increase process file descriptor count limit
* - nofile 1000000
EOF"
sudo systemctl daemon-reload
Create log rotation for ~/log/solana-validator.log
sudo nano /etc/logrotate.d/solana
Edit this into file:
/home/sol/log/solana-validator.log {
su sol sol
daily
rotate 1
missingok
postrotate
systemctl kill -s USR1 sol.service
endscript
}
Save / exit ctrl+0
then ctrl+x
Reset log rotate
sudo systemctl restart logrotate
Set CPU to performance mode (YMMV with Equinix hardware - careful with this if you are adapting these configs to different hardware!!)
sudo apt-get install cpufrequtils
echo 'GOVERNOR="performance"' | sudo tee /etc/default/cpufrequtils
sudo systemctl disable ondemand
Modifications to sysctl.conf
sudo nano /etc/sysctl.conf
Edit into bottom of file
# other tunings suggested by Triton One
# sysctl_optimisations:
vm.max_map_count=1000000
kernel.hung_task_timeout_secs=300
vm.stat_interval=10
vm.dirty_ratio=40
vm.dirty_background_ratio=10
vm.dirty_expire_centisecs=36000
vm.dirty_writeback_centisecs=3000
vm.dirtytime_expire_seconds=43200
kernel.timer_migration=0
# A suggested value for pid_max is 1024 * <# of cpu cores/threads in system>
kernel.pid_max=49152
net.ipv4.tcp_fastopen=3
# solana systuner
net.core.rmem_max=134217728
net.core.rmem_default=134217728
net.core.wmem_max=134217728
net.core.wmem_default=134217728
Save / exit ctrl+0
then ctrl+x
sudo systemctl enable --now sol.service
sudo systemctl status sol.service
Note that you may need to type :q (i.e. colon followed by q) to get back to the shell prompt.
Or you can run with the bash (prefer the above - this option to use bash is just for debugging). If you are newer to Linux, and do not yet know how to use tmux, or screen then you should read up on terminal multiplexers.
tmux
bash start-validator.sh
Tail the log to make sure it's fetching snapshot and working
sudo tail -f ~/log/solana-validator.log
The result should be a log stream that is attempting to find trusted Solana nodes to download your very first snapshot. A snapshot is a fragment of the total ledger and will allow your machines to identity ledger state and race to the tip if the chain. It can take up to 20 minutes to download a snapshot and begin catching up. The catchup can take up to 45 minutes as well. You can run healthchecks to know when the machine is on the top of the chain (healthy and ready to serve data) by using some of the below commands:
Healthcheck - you want this to return the work "Ok"
If can also return a 'behind by x number of slots" which means it behind the "tip" of the chain by that many slots. Nodes can sometimes fall a little behind and that's normal. Anything above about 100 behind mean you will risk serving stale data.
It can take half an hour before this healthcheck reports slots. Prior it may just say "connection refused." That's normal, give the RPC time to download the data, index the data, and catch up to the top of the chain.
curl http://localhost:8899 -k -X POST -H "Content-Type: application/json" -d '
{"jsonrpc":"2.0","id":1, "method":"getHealth"}
'
Tracking root slot
timeout 120 solana catchup --our-localhost=8899 --log --follow --commitment root
curl for getBlockProduction - this is a simple curl and calls for a little bit larger JSON data response. It should be nearly instant. If it isn't there is a problem.
curl http://localhost:8899 -k -X POST -H "Content-Type: application/json" -H "Referer: SSCLabs" -d '{"jsonrpc":"2.0","id":1, "method":"getBlockProduction"}
'