Skip to content

Commit

Permalink
Merge pull request #573 from threefoldtech/development_tfrobot
Browse files Browse the repository at this point in the history
TFRobot App Dashboard Guide
  • Loading branch information
khaledyoussef24 authored Jun 27, 2024
2 parents 64e9611 + 3a4c5fd commit 3a21151
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
- [Static Website](documentation/dashboard/solutions/static_website.md)
- [Subsquid](documentation/dashboard/solutions/subsquid.md)
- [Taiga](documentation/dashboard/solutions/taiga.md)
- [TFRobot](documentation/dashboard/solutions/tfrobot.md)
- [Umbrel](documentation/dashboard/solutions/umbrel.md)
- [WordPress](documentation/dashboard/solutions/wordpress.md)
- [Your Contracts](documentation/dashboard/deploy/your_contracts.md)
Expand Down
1 change: 1 addition & 0 deletions src/documentation/dashboard/deploy/applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ Easily deploy your favourite applications on the ThreeFold grid with a click of
- [Static Website](../solutions/static_website.md)
- [Subsquid](../solutions/subsquid.md)
- [Taiga](../solutions/taiga.md)
- [TFRobot](../solutions/tfrobot.md)
- [Umbrel](../solutions/umbrel.md)
- [WordPress](../solutions/wordpress.md)
Binary file modified src/documentation/dashboard/img/applications_landing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 56 additions & 0 deletions src/documentation/dashboard/solutions/tfrobot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<h1> TFRobot </h1>

<h2>Table of Contents</h2>

- [Introduction](#introduction)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Deployment](#deployment)
- [Deployed Instances Table](#deployed-instances-table)

***

## Introduction

[TFRobot](https://github.com/threefoldtech/tfgrid-sdk-go/blob/development/tfrobot/README.md) is tool designed to automate mass deployment of groups of VMs on the ThreeFold Grid, with support of multiple retries for failed deployments.

## Features

- **Mass Deployment:** Deploy groups of VMs on the grid simultaneously.
- **Mass Cancellation:** Cancel simultaneously all VMs on the grid defined in the configuration file.
- **Load Deployments:** Load simultaneously groups of VMs deployed with TFRobot.
- **Customizable Configurations:** Define node groups, VMs groups and other configurations through YAML or JSON files.

## Prerequisites

- Make sure you have a [wallet](../wallet_connector.md)
- From the sidebar click on **Applications**
- Click on **TFRobot**

## Deployment

![ ](./img/solutions_tfrobot.png)

- Enter an Application Name.

- Select a capacity package:
- **Small**: {cpu: 1, memory: 2, diskSize: 25 }
- **Medium**: {cpu: 2, memory: 4, diskSize: 50 }
- **Large**: {cpu: 4, memory: 16, diskSize: 100 }
- Or choose a **Custom** plan

- `Dedicated` flag to retrieve only dedeicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`
- `Country`
- `Farm Name`
- Click on `Load Nodes`
- Select the node you want to deploy on
- Click `Deploy`

## Deployed Instances Table

At all time, you can see a list of all of your deployed instances:

![ ](./img/tfrobot1.png)

0 comments on commit 3a21151

Please sign in to comment.