Skip to content

Rename Dirs for Optimal Presentation #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ The TFGrid full stack is composed of:

For each of the Threefold Grid networks (Devnet, QAnet, Testnet & Mainnet), the respective grid backend can be deployed using docker compose.

Have a look at the [documentation](./docker-compose/readme.md) to get started.
Have a look at the [documentation](./grid-backend/readme.md) to get started.

## TFGrid Zero-OS Hub

The Zero-OS Hub is used to distribute Flist files. Users use Flists to deploy workloads on 3Nodes.

Have a look at the [documentation](./grid-hub/readme.md) to get started.
Have a look at the [documentation](./grid-hub-bootstrap/readme.md) to get started.

## TFGrid Zero-OS Bootstrap Generator

The bootstrap service is used to create ZOS bootstrap images. Farmers use bootstrap images to set up 3Nodes on the TFGrid.

Have a look at the [documentation](./grid-hub/readme.md) to get started.
Have a look at the [documentation](./grid-hub-bootstrap/readme.md) to get started.

## TFChain Validator

Expand All @@ -53,6 +53,8 @@ Have a look at the [documentation](./tfchain-validator/readme.md) to get started

Daily TFGrid and TFChain validator snapshots can be found at [https://bknd.snapshot.grid.tf/](https://bknd.snapshot.grid.tf/).

To set up your own TFGrid and TFChain validator snapshot creation, read [this documentation](./grid-snapshots/readme.md).
To set up your own TFGrid snapshot creation, read [this documentation](./grid-backend-snapshots/readme.md).

> Note: You can also use Rsync to download the snapshots. Read [this section](./grid-snapshots/readme.md#threefold-public-rsync) for more information.
To set up your own TFChain validator snapshot creation, read [this documentation](./tfchain-validator-snapshots/readme.md).

> Note: You can also use Rsync to download the snapshots. Read [this section](./grid-backend-snapshots/readme.md#threefold-public-rsync) for more information.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ln -s processor-devnet-$(date '+%Y-%m-%d').tar.gz processor-devnet-latest.tar.gz


## Send over to Grid-snapshots server and set ln
scp /storage/rsync-public/tfchain-devnet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/devnet/
scp /storage/rsync-public/indexer-devnet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/devnet/
scp /storage/rsync-public/processor-devnet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/devnet/
ssh grid-snapshots sh /opt/snapshots/devnet-set-ln.sh
scp /storage/rsync-public/tfchain-devnet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/devnet/
scp /storage/rsync-public/indexer-devnet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/devnet/
scp /storage/rsync-public/processor-devnet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/devnet/
ssh grid-backend-snapshots sh /opt/snapshots/devnet-set-ln.sh
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ln -s processor-qanet-$(date '+%Y-%m-%d').tar.gz processor-qanet-latest.tar.gz


## Send over to Grid-snapshots server and set ln
scp /storage/rsync-public/tfchain-qanet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/qanet/
scp /storage/rsync-public/indexer-qanet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/qanet/
scp /storage/rsync-public/processor-qanet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/qanet/
ssh grid-snapshots sh /opt/snapshots/qanet-set-ln.sh
scp /storage/rsync-public/tfchain-qanet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/qanet/
scp /storage/rsync-public/indexer-qanet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/qanet/
scp /storage/rsync-public/processor-qanet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/qanet/
ssh grid-backend-snapshots sh /opt/snapshots/qanet-set-ln.sh
4 changes: 2 additions & 2 deletions grid-snapshots/readme.md → grid-backend-snapshots/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

## Introduction

To facilitate the deployment of 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.
To facilitate the deployment of grid backend services, we provide TFGrid backend 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.

## ThreeFold Public Rsync

Expand Down Expand Up @@ -121,7 +121,7 @@ crontab -e
```

```sh
0 1 * * * sh /root/code/grid_deployment/grid-snapshots/mainnet/create_snapshot.sh > /var/log/snapshots/snapshots-cron.log 2>&1
0 1 * * * sh /root/code/grid_deployment/grid-backend-snapshots/mainnet/create_snapshot.sh > /var/log/snapshots/snapshots-cron.log 2>&1
```

This example will execute the script every day at 1 AM and send the logs to /var/log/snapshots/snapshots-cron.log
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ln -s processor-testnet-$(date '+%Y-%m-%d').tar.gz processor-testnet-latest.tar.


## Send over to Grid-snapshots server and set ln
scp /storage/rsync-public/tfchain-testnet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/testnet/
scp /storage/rsync-public/indexer-testnet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/testnet/
scp /storage/rsync-public/processor-testnet-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/testnet/
ssh grid-snapshots sh /opt/snapshots/testnet-set-ln.sh
scp /storage/rsync-public/tfchain-testnet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/testnet/
scp /storage/rsync-public/indexer-testnet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/testnet/
scp /storage/rsync-public/processor-testnet-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/testnet/
ssh grid-backend-snapshots sh /opt/snapshots/testnet-set-ln.sh
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions tfchain-validator-snapshots/devnet/create_snapshot.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ rm tfchain-devnet-validator-latest.tar.gz
ln -s tfchain-devnet-validator-$(date '+%Y-%m-%d').tar.gz tfchain-devnet-validator-latest.tar.gz

## Send over to Grid-snapshots server and set ln
scp /storage/rsync-public/tfchain-devnet-validator-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/devnet/
ssh grid-snapshots sh /opt/snapshots/devnet-validator-set-ln.sh
scp /storage/rsync-public/tfchain-devnet-validator-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/devnet/
ssh grid-backend-snapshots sh /opt/snapshots/devnet-validator-set-ln.sh
4 changes: 2 additions & 2 deletions tfchain-validator-snapshots/mainnet/create_snapshot.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ rm tfchain-mainnet-validator-latest.tar.gz
ln -s tfchain-mainnet-validator-$(date '+%Y-%m-%d').tar.gz tfchain-mainnet-validator-latest.tar.gz

## Send over to Grid-snapshots server and set ln
scp /storage/rsync-public/tfchain-mainnet-validator-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/mainnet/
ssh grid-snapshots sh /opt/snapshots/mainnet-validator-set-ln.sh
scp /storage/rsync-public/tfchain-mainnet-validator-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/mainnet/
ssh grid-backend-snapshots sh /opt/snapshots/mainnet-validator-set-ln.sh
4 changes: 2 additions & 2 deletions tfchain-validator-snapshots/qanet/create_snapshot.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ rm tfchain-qanet-validator-latest.tar.gz
ln -s tfchain-qanet-validator-$(date '+%Y-%m-%d').tar.gz tfchain-qanet-validator-latest.tar.gz

## Send over to Grid-snapshots server and set ln
scp /storage/rsync-public/tfchain-qanet-validator-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/qanet/
ssh grid-snapshots sh /opt/snapshots/qanet-validator-set-ln.sh
scp /storage/rsync-public/tfchain-qanet-validator-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/qanet/
ssh grid-backend-snapshots sh /opt/snapshots/qanet-validator-set-ln.sh
16 changes: 16 additions & 0 deletions tfchain-validator-snapshots/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<h1>TFChain Validator Snapshots</h1>

<h2>Table of Contents</h2>

- [Introduction](#introduction)
- [TODO](#todo)

---

## Introduction

To facilitate the deployment of grid backend services, we provide TFChain validator 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.

## TODO

> Fill info with validator snapshot process
4 changes: 2 additions & 2 deletions tfchain-validator-snapshots/testnet/create_snapshot.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ rm tfchain-testnet-validator-latest.tar.gz
ln -s tfchain-testnet-validator-$(date '+%Y-%m-%d').tar.gz tfchain-testnet-validator-latest.tar.gz

## Send over to Grid-snapshots server and set ln
scp /storage/rsync-public/tfchain-testnet-validator-$(date '+%Y-%m-%d').tar.gz grid-snapshots:/storage/rsync-public/testnet/
ssh grid-snapshots sh /opt/snapshots/testnet-validator-set-ln.sh
scp /storage/rsync-public/tfchain-testnet-validator-$(date '+%Y-%m-%d').tar.gz grid-backend-snapshots:/storage/rsync-public/testnet/
ssh grid-backend-snapshots sh /opt/snapshots/testnet-validator-set-ln.sh