tfgrid/info_tfgrid_manual
28
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

...

Browse Source
This commit is contained in:
despiegk
2024-02-23 06:07:41 +03:00
commit a83f4cd5e8
1963 changed files with 56869 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
tosort/dashboard/portal/dashboard_portal_dedicated_nodes.md Normal file
View File

@@ -0,0 +1,76 @@
<h1> Dedicated Nodes </h1>
<h2> Table of Contents </h2>
- [What is a Dedicated Node?](#what-is-a-dedicated-node)
- [Description](#description)
- [Billing \& Pricing](#billing--pricing)
- [Discounts](#discounts)
- [Usage](#usage)
- [GPU Support](#gpu-support)
***
## What is a Dedicated Node?
Dedicated nodes 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.
## Description
- Node reserved with deploying a `RentContract` on this node. node can has only one rentContract.
- When a user create a RentContract against a node, the grid validate that there are no other active contracts on that node on the creation.
- Once a RentContract is created, the grid can only accept contracts on this node from the tenant.
- Only workloads from the tenant are accepted
## 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](../../wiki/cloudunits/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.
## Usage
- See list of all dedicated node on `Dedicated Nodes` tab on the portal.
![ ](../img/dedicated_nodes.png)
- Hover over the price to see the applied discounts
![](../img/dedicated_nodes_discounts.png)
- Expand row to see more info on the node:
![ ](../img/node_info.png)
- Resources
- Location
- Possible Public Ips *this depends on the farm it belongs to*
- You can see the nodes in 3 states:
- Free
- Reserved *Owned by current twin*
- Taken *Owned by another twin*
- Reserve a node:
- If node is not rented by another twin you can simply click reserve.
- Type your password on the polkadot pop up window.
- Wait for the pop up message said `Transaction succeeded`
![ ](../img/rented_succeeded.png)
- Unreserve a node:
- Simply as reserving but another check will be done to check you don't have any active workloads on the node before unreserving.
## 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.
For more information on GPU support, please read the [GPU section](../../gpu/gpu_toc.md) of the manual.

41
tosort/dashboard/portal/dashboard_portal_home.md Normal file
View File

@@ -0,0 +1,41 @@
# TF-Chain Portal
The TFChain Portal is a central hub within the ThreeFold Dashboard built for users to manage their accounts, perform transactions, explore network capacities, and engage with the ThreeFold Grid decentralized infrastructure.
Whether you're exploring the development network (Devnet), the quality assurance network (Qanet), the testing network (Testnet), or the production network (Mainnet), this manual will guide you through the essential functionalities of the TF-Chain Portal. So, let's get started!
## Currently on:
- [Devnet](https://dashboard.dev.grid.tf/)
- [Qanet](https://dashboard.qa.grid.tf/)
- [Testnet](https://dashboard.test.grid.tf/)
- [Mainnet](https://dashboard.grid.tf/)
![ ](../img/dashboard_portal_account.png ':size=600')
## Installation and activation
Follow the [Getting Started](../../getstarted/tfgrid3_getstarted.md) to make sure your TFChain account set up.
## Transfer TFT
- [Manage your Tokens on TFChain](../portal/dashboard_portal_ui_tokens.md) e.g. transfer TFT to TFChain
## Be a Farmer, manage your information
- [Activate your farmer account and nodes on TFChain](./dashboard_portal_ui_farming.md)
## Capacity Explorer
In the upper right corner, you can click on `EXPLORER` to get a view of all capacity connected to TFGrid v3. For more info, see [here](../explorer/explorer_home.md).
## Modify you Twin Info
A twinIP can be edited at any moment. Simply update the field and sign afterwards.
Probably not needed right now.
## Dedicated Nodes
Rent a whole node to serve your solutions.
[Dedicated Nodes](./dashboard_portal_dedicated_nodes.md)

5
tosort/dashboard/portal/dashboard_portal_list.md Normal file
View File

@@ -0,0 +1,5 @@
- on [Devnet](https://dashboard.dev.grid.tf/)
- on [Qanet](https://dashboard.qa.grid.tf/)
- on [Testnet](https://dashboard.test.grid.tf/)
- on [Mainnet](https://dashboard.grid.tf/)

24
tosort/dashboard/portal/dashboard_portal_polkadot_create_account.md Normal file
View File

@@ -0,0 +1,24 @@
# Create an Account for TFChain using Polkadot UI
> make sure [extension is installed](./dashboard_portal_polkadot_widget.md)
You will be asked to create a new account or to recover an existing account.
When creating a new account, the mnemonic seed words will be shown, which can be used to recover your wallet.
> Keep them in a safe place, they give access to the TFTs that you will hold on the TFGrid.
![ ](../img/dashboard_portal_create_account_1.png ':size=400')
In the next screen, you can choose a network. Select `Allow use on any chain`. Give your account a name and a password for easy access from your local hardware. With this information, the account can be generated.
![ ](../img/dashboard_portal_create_account_2.png ':size=400')
Once the account is generated, activate it by accepting the Terms & Conditions. You will get prompted to sign in the Polkadot extension.
![ ](../img/dashboard_portal_terms_conditions.png ':size=600')
>> PLEASE DO NOT FORGET TO REMEMBER YOUR MNEMONIC WORDS, YOU WILL NEED THEM IN NEXT STEPS.

17
tosort/dashboard/portal/dashboard_portal_polkadot_widget.md Normal file
View File

@@ -0,0 +1,17 @@
# Polkadot Extension
![ ](../img/polkadot_extension_.png)
## What does it do
This browser extension manages accounts and allows the signing of transactions with those accounts. It does not inject providers for use by dapps at this early point, nor does it perform wallet functions, e.g send funds.
## Install
Before using the tfchain_portal, you need to install a Polkadot extension.
It can be installed from [here](https://polkadot.js.org/extension/).
Extensions are available for the Google Chrome and Firefox browsers.

7
tosort/dashboard/portal/dashboard_portal_toc.md Normal file
View File

@@ -0,0 +1,7 @@
## More Info
- [Dashboard Portal Home](dashboard_portal_home)
- [Install Polkadot Widget](dashboard_portal_polkadot_widget)
- [Activate your account on TFChain](dashboard_portal_ui_activation)
- [Manage your Tokens on TFChain](dashboard_portal_ui_tokens) e.g. transfer TFT to TFChain
- [Activate your farmer account and nodes on TFChain](dashboard_portal_ui_farming)

17
tosort/dashboard/portal/dashboard_portal_transfer.md Normal file
View File

@@ -0,0 +1,17 @@
# TF-Chain Portal Transfer
## Transfer TFT between TFChain accounts
The portal can be used to transfer TFTs between 2 accounts that exist on the same chain.
> Remark: testnet and mainnet both have the same TFTs but as the 2 chains are different, there is no way to do a direct transfer between accounts on testnet and on mainnet.
![ ](../img/dashboard_portal_transfer.png ':size=600')
Click on `Transfer` in the sidebar to get the transfer screen.
![ ](../img/dashboard_portal_transfer_detail.png ':size=300')
Fill in the recipient address, the amount of tokens to transfer, and click on `Submit`. Sign in the extension screen, and you're done !
There is no transfer fee, just a signing fee of 0.001 TFT.

33
tosort/dashboard/portal/dashboard_portal_ui_activation.md Normal file
View File

@@ -0,0 +1,33 @@
# TF-Chain Portal Activation
## Go to the Portal
- [Devnet](https://dashboard.dev.grid.tf/)
- [Qanet](https://dashboard.qa.grid.tf/)
- [Testnet](https://dashboard.test.grid.tf/)
- [Mainnet](https://dashboard.grid.tf/)
## Create a Twin
A twin is a unique identifier of where you can be found digitally. Click on `CREATE` to register your Twin on TF-Chain.
![ ](../img/dashboard_portal_create_twin.png ':size=600')
If you want to connect your TwinID to the planetary network, fill in the IPv6 address you get from Yggdrasil.
If not, no need to fill in the ip address, use ```127.0.0.1```.
This address is reserved for future usage once the digital twin will launch.
![ ](../img/dashboard_portal_fill_ipv6.png ':size=400')
Submit the transaction using the password selected when creating the account.
The Twin IP can be modified at any moment.
## Required result
Shoud see something like:
![ ](../img/dashboard_portal_twin_created.png ':size=600')

70
tosort/dashboard/portal/dashboard_portal_ui_farming.md Normal file
View File

@@ -0,0 +1,70 @@
# Create a Farm
In this section, we'll walk you through the process of activating your farmer account, an essential step if you're looking to participate in the innovative world of farming on the ThreeFold Grid.
If you want to start farming, you need a farmID, which is the ID of the farm that is owning the hardware node(s) you connect to the TFGrid.
## Currently on:
- [Devnet](https://dashboard.dev.grid.tf/)
- [Qanet](https://dashboard.qa.grid.tf/)
- [Testnet](https://dashboard.test.grid.tf/)
- [Mainnet](https://dashboard.grid.tf/)
Click `CREATE FARM` and choose a name.
![ ](../img/dashboard_portal_farm.png ':size=600')
![ ](../img/dashboard_portal_create_farm.png ':size=300')
Click `Submit` and sign the action.
The farm is by default set up as 'DIY'. A farm can become certified through certification program.
Also a pricing policy is defined. Pricing policy is currently the same for all farms, the field is created for future use.
## Add a public IP to your Farm
If you have public IPv4 addresses available that can be used for usage on the TFGrid, you can add them in your farm.
Click `ADD IP`, specify the addresses, the gateway and click `CREATE`.
You can add them one by one or using range of IPs.
__Some notes about adding a new IPs__:
- Be careful not to create a new IP range that contains an IP address that already exists; doing so will result in an error.
- Verify that both the gateway address and the IP address are correct.
- Be careful not to include the same gateway address in a new IP range.
![ ](../img/dashboard_portal_ip_add.png ':size=600')
![ ](../img/dashboard_portal_ip_add_detail.png ':size=300')
![ ](../img/dashboard_portal_ip_add_detail_range.png ':size=300')
Deleting IPv4 addresses is also possible here. The `Deployed Contract ID` gives an indication of whether an IP is currently used. If it is 0, it is safe to remove it.
![ ](../img/dashboard_portal_ip_result.png ':size=400')
## Add a Stellar address for payout
In a first phase, farming of tokens still results in payout on the Stellar network. So to get the farming reward, a Stellar address needs to be provided.
![ ](../img/dashboard_portal_farm0.png ':size=600')
![ ](../img/dashboard_portal_stellar.png ':size=400')
## Generate your node bootstrap image
Once you know your farmID, you can set up your node on TFGrid3. Click on `View bootstrap`.
After booting a node, the info will become available in your portal, including the status info along with the minting and fixup receipts.
![ ](../img/dashboard_portal_node_info.png ':size=600')
Clicking on the node statistics will open up a calendar where you can view the periods the node was minting or undergoing a fixup. Clicking on the periods will show a popup with the start and end datetimes, receipt hash and the amount of TFTs minted (if it is a minting receipt).
![ ](../img/dashboard_portal_ui_nodes_minting.png ':size=600')
You can also download a single node's receipts using the `Download Receipts` button within the node statistics. Moreover, you can download all of the nodes' receipts using the `Download Receipts` button on the top left corner of the farm nodes table.
## Capacity Explorer
In the upper right corner, you can click on `EXPLORER` to get a view of all capacity connected to TFGrid v3. For more info, see [here](../explorer/explorer_home.md).

62
tosort/dashboard/portal/dashboard_portal_ui_tokens.md Normal file
View File

@@ -0,0 +1,62 @@
# Manage your TFT on TFChain
## Transfer TFT between TFChain accounts
The portal can be used to transfer TFTs between 2 accounts that exist on the same chain.
> Remark: testnet and mainnet both have the same TFTs but as the 2 chains are different, there is no way to do a direct transfer between accounts on testnet and on mainnet.
![ ](../img/dashboard_portal_transfer.png ':size=600')
Click on `Transfer` in the sidebar to get the transfer screen.
![ ](../img/dashboard_portal_transfer_detail.png ':size=300')
Fill in the recipient address, the amount of tokens to transfer, and click on `Submit`. Sign in the extension screen, and you're done !
There is no transfer fee, just a signing fee of 0.001 TFT.
## Transfer TFT between Stellar Network and TF-Chain
A minimum amount of TFT is sponsored for the initial setup, but as every action on TF-Chain requires some small TFT amount, TFT can be sent over from the Stellar network.
Also, capacity that is reserved is paid to the Substrate account. For multiple reasons (selling, storing, ...) you might need to transfer this amount to the Stellar network. There is a bridge between the two blockchains available, and transfers can be launched as indicated below.
### Deposit
A deposit of tokens from the Stellar network onto TF-Chain needs to happen from a Stellar wallet, like in the ThreeFold Connect App.
You have 2 options:
- TFT needs to be sent to the bridge account
- specifying in the memo field the twinID that was generated with the Twin creation e.g. twin_110 (dont forget twin_)
- Note there is a transaction cost of 1 TFT.
Or
- You can scan the QR code
Go to portal
!!!include:tfchain_portal_list
Click on `Bridge` in the sidebar to get the transfer screen. Click `Deposit`
![ ](../img/dashboard_portal_deposit_tft.png ':size=400')
### Withdraw
Sending tokens to the Stellar network can happen from this portal, after indicating the destination address and the amount to be transferred.
Go to portal
!!!include:tfchain_portal_list
Click on `Swap` in the sidebar to get the transfer screen. Click `Withdraw`.
![ ](../img/dashboard_portal_withdraw_tft.png ':size=400')
Click on `Submit` and sign using your password.
![ ](../img/dashboard_portal_transaction_sign.png ':size=400')
!!!include:tfchain_portal_toc