restructured manual

This commit is contained in:
2024-04-29 18:23:19 +00:00
parent 7bd1e7a0d8
commit 60b6c802ed
2351 changed files with 247 additions and 67649 deletions

View File

@@ -41,12 +41,3 @@ You can access the ThreeFold Dashboard on different TF Chain networks.
- Regarding browser support, we're only supporting Google Chrome browser (and thus Brave browser) at the moment with more browsers to be supported soon.
- Deploys one thing at a time.
- Might take sometime to deploy a solution like Peertube, so you should wait a little bit until it's fully running.
## Dashboard Backups
If the main Dashboard URLs are not working for any reason, the following URLs can be used. Those Dashboard URLs are fully independent of the main Dashboard URLs shown above.
- [https://dashboard.02.dev.grid.tf](https://dashboard.02.dev.grid.tf) for Dev net
- [https://dashboard.02.qa.grid.tf](https://dashboard.02.qa.grid.tf) for QA net
- [https://dashboard.02.test.grid.tf](https://dashboard.02.test.grid.tf) for Test net
- [https://dashboard.02.grid.tf](https://dashboard.02.grid.tf) for Main net

View File

@@ -18,7 +18,6 @@ Easily deploy your favourite applications on the ThreeFold grid with a click of
- [ownCloud](../solutions/owncloud.md)
- [Peertube](../solutions/peertube.md)
- [Presearch](../solutions/presearch.md)
- [Static Website](../solutions/static_website.md)
- [Subsquid](../solutions/subsquid.md)
- [Taiga](../solutions/taiga.md)
- [Umbrel](../solutions/umbrel.md)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

View File

@@ -5,11 +5,12 @@ Here you will find everything related to deployments on the ThreeFold grid. This
- Checking the cost of a deployment using [Pricing Calculator](./pricing_calculator.md)
- Finding a node to deploy on using the [Node Finder](./node_finder.md)
- Deploying your desired workload from [Virtual Machines](../solutions/vm_intro.md), [Orchestrators](./orchestrators.md), or [Applictions](./applications.md)
- Renting your own node on the ThreeFold grid from [Dedicated Machines](./dedicated_machines.md)
- Consulting [Your Contracts](./your_contracts.md) on the TFGrid
- Finding or publishing Flists from [Images](./images.md)
- Updating or generating your SSH key from [SSH Keys](./ssh_keys.md)
![](../img/dashboard_deploy.png)
![](../img/sidebar_2.png)
***
@@ -19,6 +20,7 @@ Here you will find everything related to deployments on the ThreeFold grid. This
- [Node Finder](./node_finder.md)
- [Virtual Machines](../solutions/vm_intro.md)
- [Orchestrators](./orchestrators.md)
- [Dedicated Machines](./dedicated_machines.md)
- [Applications](./applications.md)
- [Your Contracts](./your_contracts.md)
- [Images](./images.md)

View File

@@ -2,119 +2,39 @@
<h2>Table of Contents</h2>
- [Overview](#overview)
- [Filters](#filters)
- [Node Details](#node-details)
- [Gateway Nodes](#gateway-nodes)
- [Dedicated Nodes](#dedicated-nodes)
- [Reservation](#reservation)
- [Billing \& Pricing](#billing--pricing)
- [Discounts](#discounts)
- [GPU Nodes](#gpu-nodes)
- [GPU Support](#gpu-support)
- [GPU Support Links](#gpu-support-links)
- [Nodes](#nodes)
- [GPU Support](#gpu-support)
***
## Overview
## Nodes
The Node Finder page provides a more detailed view for the nodes available on the ThreeFold grid with detailed information and statistics about nodes.
The Node Finder page provides a more detailed view for the nodes available on the ThreeFold grid With detailed information and statistics about any of the available nodes.
![](../img/dashboard_node_finder.png)
![](../img/nodes.png)
## Filters
You can get a node with the desired specifications using the filters available in the nodes page.
You can use the filters to narrow your search and find a node with the desired specifications.
![](../img/nodes_filters.png)
![](../img/dashboard_node_finder_filters_1.png)
You can see all of the node details by clicking on a node record.
![](../img/dashboard_node_finder_filters_2.png)
![](../img/nodes_details.png)
You can use the toggle buttons to filter your search.
## GPU Support
- Dedicated nodes
- Gateways nodes
- GPU nodes
- Rentable nodes
![GPU support](../img/gpu_filter.png)
You can choose a location for your node, with filters such as region and country. This can be highly useful for edge cloud projects.
- A new filter for GPU supported node is now available on the Nodes page.
- GPU count
- Filtering capabilities based on the model / device
Filtering nodes by their status (up, down, standby) can also improve your search.
On the details pages is shown the card information and its status (`reserved` or `available`) also the ID thats needed to be used during deployments is easily accessible and has a copy to clipboard button.
If your deployment has some minimum requirements, you can easily filter relevant nodes with the different resource filters.
![GPU details](../img/gpu_details.png)
## Node Details
Heres an example of how it looks in case of reserved
You can see all of the node details when you click on its row.
![GPU details](../img/gpu_details_reserved.png)
![](../img/dashboard_node_finder_node_view.png)
Note that the network speed test displayed in the Node Finder is updated every 6 hours.
## Gateway Nodes
To see only gateway nodes, enable **Gateways** in the filters.
![](../img/dashboard_node_finder_gateways.png)
## Dedicated Nodes
Dedicated machines are 3Nodes that can be reserved and rented entirely by one user. The user can thus reserve an entire node and use it exclusively to deploy solutions. This feature is ideal for users who want to host heavy deployments with the benefits of high reliability and cost effectiveness.
To see only dedicated nodes, enable **Dedicated Nodes** in the filters.
![](../img/dashboard_node_finder_dedicated.png)
### Reservation
When you have decided which node to reserve, you can easily rent it from the Node Finder page.
To reserve a node, simply click on `Reserve` on the node row.
![](../img/dashboard_node_finder_dedicated_reserve.png)
To unreserve a node, simply click on `Unreserve` on the node row.
![](../img/dashboard_node_finder_dedicated_unreserve.png)
Note that once you've rented a dedicated node that has a GPU, you can deploy GPU workloads.
### Billing & Pricing
- Once a node is rented, there is a fixed charge billed to the tenant regardless of deployed workloads.
- Any subsequent NodeContract deployed on a node where a rentContract is active (and the same user is creating the nodeContracts) can be excluded from billing (apart from public ip and network usage).
- Billing rates are calculated hourly on the TFGrid.
- While some of the documentation mentions a monthly price, the chain expresses pricing per hour. The monthly price shown within the manual is offered as a convenience to users, as it provides a simple way to estimate costs.
### Discounts
- Received Discounts for renting a node on TFGrid internet capacity
- 50% for dedicated node (TF Pricing policies)
- A second level discount up to 60% for balance level see [Discount Levels](../../../knowledge_base/cloud/pricing/staking_discount_levels.md)
- Discounts are calculated every time the grid bills by checking the available TFT balance on the user wallet and seeing if it is sufficient to receive a discount. As a result, if the user balance drops below the treshold of a given discount, the deployment price increases.
## GPU Nodes
To see only nodes with GPU, enable **GPU Node** in the filters.
![](../img/dashboard_node_finder_gpu.png)
This will filter nodes and only show nodes with GPU. You can see several information such as the model of the GPU and a GPU score.
![](../img/dashboard_node_finder_gpu2.png)
You can click on a given GPU node and see the GPU details.
![](../img/dashboard_node_finder_gpu3.png)
The ID thats needed to be used during deployments is easily accessible and has a button to copy to the clipboard.
### GPU Support
To use a GPU on the TFGrid, users need to rent a dedicated node. Once they have rented a dedicated node equipped with a GPU, users can deploy workloads on their dedicated GPU node.
### GPU Support Links
The ThreeFold Manual covers many ways to use a GPU node on the TFGrid. Read [this section](../../system_administrators/gpu/gpu_toc.md) to learn more.
The TF Dashboard is where to reserve the nodes the farmer should be able to set the extra fees on the form and the user also should be able to reserve and get the details of the node (cost including the extrafees, GPU informations).

View File

@@ -0,0 +1,3 @@
dashboard_tc.png
dashboard_portal_terms_conditions.png
profile_manager1.png

View File

Before

Width:  |  Height:  |  Size: 166 KiB

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 656 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 666 KiB

After

Width:  |  Height:  |  Size: 523 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 531 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

View File

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 68 KiB

View File

Before

Width:  |  Height:  |  Size: 199 KiB

After

Width:  |  Height:  |  Size: 199 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 875 KiB

After

Width:  |  Height:  |  Size: 390 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

View File

@@ -43,7 +43,7 @@ Deploy a new full virtual machine on the Threefold Grid
- `Myceluim` to enable mycelium on the virtual machine
- `Wireguard Access` to add a wireguard access to the Virtual Machine
- `GPU` flag to add GPU to the Virtual machine
- To deploy a Full VM with GPU, you first need to [rent a dedicated node](../../dashboard/deploy/node_finder.md#dedicated-nodes)
- To deploy a Full VM with GPU, you first need to [rent a dedicated node](../../dashboard/deploy/dedicated_machines.md)
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node

View File

Before

Width:  |  Height:  |  Size: 263 KiB

After

Width:  |  Height:  |  Size: 263 KiB

View File

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

View File

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 86 KiB

View File

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 94 KiB

View File

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View File

Before

Width:  |  Height:  |  Size: 69 KiB

After

Width:  |  Height:  |  Size: 69 KiB

View File

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

View File

@@ -63,6 +63,7 @@ If you're not sure and just want the easiest, most affordable option, skip the p
* **Recommended**: {cpu: 4, memory: 16gb, diskSize: 1000gb }
* Or choose a **Custom** plan
* If want to reserve a public IPv4 address, click on Network then select **Public IPv4**
* If you want a [dedicated](../deploy/dedicated_machines.md) and/or a certified node, select the corresponding option
* Choose the location of the node
* `Country`
* `Farm Name`

View File

@@ -1,53 +0,0 @@
<h1> Static Website </h1>
<h2>Table of Contents </h2>
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Deployment](#deployment)
---
## Introduction
Static Website is an application where a user provides a GitHub repository URL for the files to be automatically served online using Caddy.
## Prerequisites
- Make sure you have a [wallet](../wallet_connector.md)
- From the sidebar click on **Applications**
- Click on **Static Website**
## Deployment
![ ](./img/solutions_staticwebsite.png)
- Enter an instance name
- Enter a GitHub repository URL that needs to be cloned
- Enter the title for the cloned repository
- Select a capacity package:
- **Small**: {cpu: 1, memory: 2 , diskSize: 50 }
- **Medium**: {cpu: 2, memory: 4, diskSize: 100 }
- **Large**: {cpu: 4, memory: 16, diskSize: 250 }
- Or choose a **Custom** plan
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`
- `Country`
- `Farm Name`
- Choose the node to deploy on
- Note: You can select a specific node with manual selection
- `Custom Domain` flag allows the user to use a custom domain
- Choose a gateway node to deploy your static website
Once this is done, you can see a list of all of your deployed instances:
![ ](./img/staticwebsite_list.png)
Click on the button **Visit** under **Actions** to go to your static website!

View File

@@ -8,7 +8,6 @@ The TFChain DAO (i.e. Decentralized Autonomous Organization) feature integrates
- [Prerequisites to Vote](#prerequisites-to-vote)
- [How to Vote for a Proposal](#how-to-vote-for-a-proposal)
- [The Goal of the Threefold DAO](#the-goal-of-the-threefold-dao)
- [Voting Weight](#voting-weight)
***
@@ -40,17 +39,3 @@ To vote, you need to log into your Threefold Dashboard account, go to **TF DAO**
The goal of DAO voting system is to gather the thoughts and will of the Threefold community and build projects that are aligned with the ethos of the project.
We encourage anyone to share their ideas. Who knows? Your sudden spark of genius might lead to an accepted proposal on the Threefold DAO!
## Voting Weight
The DAO votes are weighted as follows:
- Get all linked farms to the account
- Get all nodes per farm
- Get compute and storage units per node (CU and SU)
- Compute the weight of a farm:
```
2 * (sum of CU of all nodes) + (sum of SU of all nodes)
```
Voting weights are tracked per farm to keep it easy and traceable. Thus, if an account has multiple farms, the vote will be registered per farm.

View File

@@ -4,16 +4,13 @@
- [Introduction](#introduction)
- [Supported Networks](#supported-networks)
- [Create a Wallet](#create-a-wallet)
- [Import a Wallet](#import-a-wallet)
- [Process](#process)
***
## Introduction
To interact with TFChain, users can connect their TFChain wallet to the wallet connector available on the ThreeFold Dashboard.
You can create a new wallet or import an existing wallet.
To interact with TFChain, users need to set a wallet connector.
## Supported Networks
@@ -30,36 +27,16 @@ Currently, we're supporting four different networks:
![ ](./img/profile_manager1.png)
## Create a Wallet
## Process
To create a new wallet, open the ThreeFold Dashboard on the desired network, click on `Create Account`, enter the following information and click `Connect`.
Start entering the following information required to create your new profile.
- `Mnemonics`: The secret words of your Polkadot account. Click on the **Create Account** button to generate yours.
- `Email`: Enter a valid email address.
- `Password`: Choose a password and confirm it. This will be used to access your account.
![ ](./img/profile_manager2.png)
![](./img/dashboard_walletconnector_window.png)
- `Mnemonics` are the secret words of your Polkadot account. Click on the **Create Account** button to generate yours.
- `Password` is used to access your account
- `Confirm Password`
You will be asked to accept ThreeFold's Terms and Conditions:
After you finish typing your credentials, click on **Connect**. Once your profile gets activated, you should find your **Twin ID** and **Address** generated under your **_Mnemonics_** for verification. Also, your **Account Balance** will be available at the top right corner under your profile name.
![](./img/dashboard_terms_conditions.png)
Once you've set your credentials, clicked on **Connect** and accepted the terms and conditions, your profile will be activated.
Upon activation, you will find your **Twin ID**, **Address** and wallet current **balance** generated under your **Mnemonics**.
![](./img/dashboard_walletconnector_info.png)
Your current and locked balances will also be available at the top right corner of the dashboard. Here's an example of the balances you can find for your wallet. Some TFT is locked during utilization as the TFGrid bills you for your workloads and traffic.
![](./img/dashboard_balances.png)
## Import a Wallet
You can import an existing wallet by entering in `Mnemonics` the associated seed phrase or HEX secret of the existing wallet.
- To import a wallet created with the TF Dashboard, use the seed phrase provided when you created the account.
- To import a wallet or a farm created on the TF Connect app, use the TFChain HEX secret.
- From the menu, open **Wallet** -> **Wallet name** -> **Info symbol (i)**, and then reveal and copy the **TFChain Secret**.
When you import a new wallet, you can decide a new password and email address, i.e. you only need the mnemonics to import an existing wallet on the dashboard.
![ ](./img/profile_manager3.png)