TFGrid Stack Suite: Dashboard Apps for Grid Guardians

[mik-tf]

Guardians and TFGrid Full Stack Suite

Table of Contents

• Introduction
• The TFGrid Stack Suite
• Grid Stack Suite steps
• Guardians Tasks
  • Specs and UX

---

Introduction

We propose a complete overview of how to complete the Guardians program.

The TFGrid Stack Suite

A guardian needs to run a full TFGrid stack. The stack is composed of 3 parts.

• Dashboard suite
  • official TF:
    • https://dashboard.grid.tf/
  • dashboard
  • graphql
  • metrics
  • etc.
• Bootstrap Generator
  • official TF:
    • https://bootstrap.grid.tf/
• Flist Hub
  • official TF:
    • https://hub.grid.tf/

We propose to develop 3 apps on the Dashboard for the TFGrid Stack. Those 3 apps constitute the TFGrid Stack Suite.

Ideally, we can have all 3 parts combined into one app, i.e. one Dashboard app (TFGrid Stack Suite) deploys the whole TFGrid Stack.

Grid Stack Suite steps

• create procedures and documentation for 3 parts
  • for micro VM ubuntu 22.04
  • develop docker version
  • transfer docker to flist version
  • create new dashboard app using the flist and the closest dashboard app as template

Guardians Tasks

Guardians deploy the TFGrid Stack Suite on all networks: dev, qa, test and main.

Specs and UX

The guardian only needs to use the Dashboard to deploy the complete TFGrid Stack Suite.

• Specs of dashboard guardian app suites
  • 3 parts: dashboard suite, bootstrap generator, flist hub
    • a guardian deploys the 3 parts with the same main url as the basis
  • deployment process for all 3 parts
    • select node to deploy on
      • with ipv4, ipv6
    • enter the domain
      • e.g. threefold.pro
    • the flist/app does the rest

Status

• Dashboard suite flist + app are done: PR: added dashboard suite app tfgrid-sdk-ts#3164
• Boot generator flist + app are done: PR: Added zos boot generator app tfgrid-sdk-ts#3143

Todo

• Flist hub flist + app
• Make sure everything is 100% OK with all apps and their respective flists.
• Currently we use ubuntu but ideally we use alpine for simplicity and maintenance

[xmonader]

1- What is so special about bootstrap and 0hub to be in separate apps? from guardian's perspective I expect I deploy the whole thing from the same app?

2- I'd use a different name other than "Dashboard", I expected "Grid Stack" solution that someone can deploy directly

[mik-tf]

1. OK we can merge them together if you think it's better. In that case, I will add the 0hub when it's ready.
2. I wanted to make a distinction that the grid is: dashboard suite + 0hub + bootstrap. But I can call it Grid Stack instead of Dashboard Suite. It doesn't seem fitting to put 0hub, bootstrap and grid stack (dashboard suite) in the same app as the grid stack needs to be deployed for main, dev, test, qa nets and 0hub and bootstrap only need 1 instance (no different network).

[mik-tf]

Closing in favor of docker compose no dashboard app approach