tfgrid/info_tfgrid
30
3
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Activity
a567404ef3
info_tfgrid/collections/manual/documentation/developers/grid_deployment/snapshots_archive.md
mik-tf a567404ef3 new book manual
2024-04-15 17:42:25 +00:00

6.9 KiB
Raw Blame History

Snapshots for Grid Backend Services

Table of Contents

Introduction

To facilitate deploying grid backend services, we provide snapshots to significantly reduce sync time. This can be setup anywhere from scratch. Once all services are synced, one can use the scripts to create snapshots automatically.

Prerequisites

There are a few prerequisites to properly run the ThreeFold services.

Services

There are 3 grid backend services that collect enough data to justify creating snapshots:

  • ThreeFold blockchain - TFChain
  • Graphql - Indexer
  • Graphql - Processor

ThreeFold Public Snapshots

ThreeFold hosts all available snapshots at: https://bknd.snapshot.grid.tf/. Those snapshots can be downloaded with rsync:

  • Mainnet: 
    rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshots/tfchain-mainnet-latest.tar.gz .  
rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshots/indexer-mainnet-latest.tar.gz .  
rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshots/processor-mainnet-latest.tar.gz .
  • Testnet: 
    rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshotstest/tfchain-testnet-latest.tar.gz .  
rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshotstest/indexer-testnet-latest.tar.gz .  
rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshotstest/processor-testnet-latest.tar.gz .
  • Devnet: 
    rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshotsdev/tfchain-devnet-latest.tar.gz .  
rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshotsdev/indexer-devnet-latest.tar.gz .  
rsync -Lv --progress --partial rsync://bknd.snapshot.grid.tf:34873/gridsnapshotsdev/processor-devnet-latest.tar.gz .

Let's now see how to use those snapshots to run the services via scripts.

Deploy the Services with Scripts

You can deploy the 3 individual services using known methods such as Docker. To facilitate the process, scripts are provided that run the necessary docker commands.

The first script creates the snapshots, while the second and third scripts serve to start and stop all services.

You can use the start script to start all services and then set a cron job to execute periodically the snapshot creation script. This will ensure that you always have the latest version available on your server.

Start All the Services

You can start all services by running the provided scripts.

  • Download the script.
    • Main net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/mainnet/startall.sh
    • Test net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/testnet/startall.sh
    • Dev net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/devnet/startall.sh
  • Set the permissions of the script 
    chmod +x startall.sh
  • Run the script to start all services via docker engine. 
    ./startall.sh

Stop All the Services

You can stop all services by running the provided scripts.

  • Download the script.
    • Main net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/mainnet/stopall.sh
    • Test net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/testnet/stopall.sh
    • Dev net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/devnet/stopall.sh
  • Set the permissions of the script 
    chmod +x stopall.sh
  • Run the script to stop all services via docker engine. 
    ./stopall.sh

Create the Snapshots

You can set a cron job to execute a script running rsync to create the snapshots and generate logs at a given interval.

  • First download the script.
    • Main net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/mainnet/create_snapshot.sh
    • Test net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/testnet/create_snapshot.sh
    • Dev net 
      wget https://github.com/threefoldtech/grid_deployment/blob/development/grid-snapshots/devnet/create_snapshot.sh
  • Set the permissions of the script 
    chmod +x create_snapshot.sh
  • Make sure to a adjust the snapshot creation script for your specific deployment
  • Set a cron job 
    crontab -e
    • Here is an example of a cron job where we execute the script every day at 1 AM and send the logs to /var/log/snapshots/snapshots-cron.log. 
      0 1 * * * sh /opt/snapshots/create-snapshot.sh > /var/log/snapshots/snapshots-cron.log 2>&1

Expose the Snapshots with Rsync

We use rsync with a systemd service to expose the snapshots to the community.

Create the Service Configuration File

To setup a public rsync server, create and edit the following file:

/etc/rsyncd.conf

pid file = /var/run/rsyncd.pid
lock file = /var/run/rsync.lock
log file = /var/log/rsync.log
port = 34873
max connections = 20
exclude = lost+found/
transfer logging = yes
use chroot = yes
reverse lookup = no

[gridsnapshots]
path = /storage/rsync-public/mainnet
comment = THREEFOLD GRID MAINNET SNAPSHOTS
read only = true
timeout = 300
list = false

[gridsnapshotstest]
path = /storage/rsync-public/testnet
comment = THREEFOLD GRID TESTNET SNAPSHOTS
read only = true
timeout = 300
list = false

[gridsnapshotsdev]
path = /storage/rsync-public/devnet
comment = THREEFOLD GRID DEVNET SNAPSHOTS
read only = true
timeout = 300
list = false

Start the Service

Start and enable via systemd:

systemctl start rsync
systemctl enable rsync
systemctl status rsync

If you're interested about hosting your own instance of the grid to strenghten the ThreeFold ecosystem, make sure to read the next section, Guardians of the Grid.