tfgrid/info_tfgrid
38
3
Fork 0
Code Issues 12 Pull Requests Packages Projects 3 Releases Activity

manual, update new pr

Browse Source
This commit is contained in:
Mik-TF 2024-05-14 16:48:37 -04:00
parent 6be34813c1
commit cf82a6f7b9
8 changed files with 88 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
collections/cloud/resource_units_calc_cloudunits.md
View File

@ -14,7 +14,7 @@
## Resource Units Overview
The threefold Zero-OS and TFChain software translates resource units (CRU, MRU, HRU, SRU) into cloud units (CU, SU) for farming reward purposes.
The ThreeFold Zero-OS and TFChain software translates resource units (CRU, MRU, HRU, SRU) into cloud units (CU, SU) for farming reward purposes.
Resource units are used to measure and convert capacity on the hardware level into cloud units: CU & SU.

23
collections/dashboard/wallet_connector.md
View File

@ -4,13 +4,16 @@
- [Introduction](#introduction)
- [Supported Networks](#supported-networks)
- [Process](#process)
- [Create a Wallet](#create-a-wallet)
- [Import a Wallet](#import-a-wallet)
***
## Introduction
To interact with TFChain, users need to set a wallet connector.
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.
## Supported Networks
@ -27,16 +30,24 @@ Currently, we're supporting four different networks:
![ ](./img/profile_manager1.png)
## Process
## Create a Wallet
Start entering the following information required to create your new profile.
Open the ThreeFold Dashboard and enter the following information to create your new wallet.
![ ](./img/profile_manager2.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
- `Password` is used to access your account.
- `Confirm Password`
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.
After setting your credentials, click on **Connect**. Once your profile gets activated, you should find your **Twin ID** and **Address** generated under your **_Mnemonics_**. Your **Account Balance** will be available at the top right corner.
![ ](./img/profile_manager3.png)
## Import a Wallet
You can import an existing wallet by entering in `Mnemonics` the associated seed phrase or HEX secret.
- 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**.

51
collections/developers/grid_deployment/grid_deployment_full_vm.md
View File

@ -4,6 +4,7 @@
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Deploy All 3 Network Instances](#deploy-all-3-network-instances)
- [DNS Settings](#dns-settings)
- [DNS Verification](#dns-verification)
- [Prepare the VM](#prepare-the-vm)
@ -17,9 +18,11 @@
## Introduction
We present the steps to deploy a network instance of the TFGrid on a full VM.
We present the steps to deploy an instance of the TFGrid on a full VM.
For this guide, we will be deploying a mainnet instance. While the steps are similar for testnet and devnet, you will have to adjust your deployment depending on which network you use.
For this guide, we will be deploying a mainnet instance. While the steps are similar for testnet and devnet, you will have to adjust your deployment depending on which network you use. Details are provided when needed.
We also provide information to deploy the 3 different network instances.
## Prerequisites
@ -33,17 +36,30 @@ For this guide, you will need to deploy a full VM on the ThreeFold Grid with at
After deploying the full VM, take note of the IPv4 and IPv6 addresses to properly set the DNS records and then SSH into the VM.
It is recommended to deploy on a machine with modern hardware and NVME storage disk.
## Deploy All 3 Network Instances
To deploy the 3 network instances, mainnet, testnet and mainnet, you need to follow the same process for each network on a separate machine or at least on a different VM.
This means that you can either deploy each network instance on 3 different machines, or you can also deploy 3 different VMs on the same machine, e.g. a dedicated node. Then, each VM will run a different network instance. In this case, you will certainly need a machine with NVME storage disk and modern hardware.
## DNS Settings
You need to set an A record for the IPv4 address and an AAAA record for the IPv6 address with a wildcard subdomain.
The following table explicitly shows how to set the A and AAAA records for your domain.
The following table explicitly shows how to set the A and AAAA records for your domain for all 3 networks. Note that both `testnet` and `devnet` have a subdomain. The last two lines are for mainnet since no subdomain is needed in this case.
| Type | Host | Value |
| ---- | ---- | -------------- |
| A | \* | <ipv4_address> |
| AAAA | \* | <ipv6_address> |
| A | \*.dev | <devnet_ipv4_address> |
| AAAA | \*.dev | <devnet_ipv6_address> |
| A | \*.test | <testnet_ipv4_address> |
| AAAA | \*.test | <testnet_ipv6_address> |
| A | \* | <mainnet_ipv4_address> |
| AAAA | \* | <mainnet_ipv6_address> |
As stated above, each network instance must be on its own VM or machine to work properly. Make sure to adjust the DNS records accordingly.
### DNS Verification
@ -51,12 +67,17 @@ You can use tools such as [DNSChecker](https://dnschecker.org/) or [dig](https:/
## Prepare the VM
We show the steps to prepare the VM to run the network instance.
If you are deploying on testnet or devnet, simply replace `mainnet` by the proper network in the following lines.
- Download the ThreeFold Tech `grid_deployment` repository
```
git clone https://github.com/threefoldtech/grid_deployment
cd grid_deployment/docker-compose/mainnet
```
- Generate a TFChain node key with `subkey`
- Note: If you deploy the 3 network instances, you can use the same node key for all 3 networks. But it is recommended to use 3 different keys to facilitate management.
```
echo .subkey_mainnet >> .gitignore
../subkey generate-node-key > .nodekey_mainnet
@ -80,7 +101,7 @@ You can use tools such as [DNSChecker](https://dnschecker.org/) or [dig](https:/
- **GRID_PROXY_MNEMONIC**="word1 word2 ... word24"
- Write the seed phrase of an account on mainnet with at least 10 TFT in the wallet and a registered twin ID\*
> \*Note: If you've created an account using the ThreeFold Dashboard on mainnet, the twin ID is automatically registered.
> \*Note: If you've created an account using the ThreeFold Dashboard on a given network, the twin ID is automatically registered for this network.
## Set the Firewall
@ -110,16 +131,18 @@ This will take some time since you are downloading the whole mainnet grid snapsh
Once you've deployed the grid stack online, you can access the different grid services by usual the usual subdomains:
```
dashboard.your.domain
metrics.your.domain
tfchain.your.domain
graphql.your.domain
relay.your.domain
gridproxy.your.domain
activation.your.domain
stats.your.domain
dashboard.example.com
metrics.example.com
tfchain.example.com
graphql.example.com
relay.example.com
gridproxy.example.com
activation.example.com
stats.example.com
```
In the case of testnet and devnet, links will also have the given subdomain, such as `dashboard.test.example.com` for a `testnet` instance.
## Manual Commands
Once you've run the install script, you can deploy manually the grid stack with the following command:

6
collections/faq/faq.md
View File

@ -24,7 +24,7 @@
- [ThreeFold uses Quantum Safe Storage technology, what does it mean?](#threefold-uses-quantum-safe-storage-technology-what-does-it-mean)
- [Quantum Safe File System (QSFS) allows for part of the storage to go down and it can self repair, however it’s still attached to a single VM and a single point of failure. Can a QSFS instance be reattached to another VM to recover it?](#quantum-safe-file-system-qsfs-allows-for-part-of-the-storage-to-go-down-and-it-can-self-repair-however-its-still-attached-to-a-single-vm-and-a-single-point-of-failure-can-a-qsfs-instance-be-reattached-to-another-vm-to-recover-it)
- [Where does the ThreeFold Explorer take its data from?](#where-does-the-threefold-explorer-take-its-data-from)
- [How can I use the Gridproxy to query information on the TF Grid?](#how-can-i-use-the-gridproxy-to-query-information-on-the-tf-grid)
- [How can I use the Gridproxy public API to query information on the TFGrid?](#how-can-i-use-the-gridproxy-public-api-to-query-information-on-the-tfgrid)
- [How can I see the stats of the ThreeFold Grid?](#how-can-i-see-the-stats-of-the-threefold-grid)
- [What is the difference between a seed phrase (mnemonics) and an HEX secret?](#what-is-the-difference-between-a-seed-phrase-mnemonics-and-an-hex-secret)
- [Buying and Transacting TFT](#buying-and-transacting-tft)
@ -409,9 +409,9 @@ See the next Q&A for more information on Swagger.
### How can I use the Gridproxy to query information on the TF Grid?
### How can I use the Gridproxy public API to query information on the TFGrid?
You can go to the Gridproxy Swagger index: [https://gridproxy.grid.tf/swagger/index.html](https://gridproxy.grid.tf/swagger/index.html).
You can go to the Gridproxy public API Swagger index: [https://gridproxy.grid.tf/swagger/index.html](https://gridproxy.grid.tf/swagger/index.html).
There you can query information such as information on a 3node.

15
collections/farmers/3node_building/minting_receipts.md
View File

@ -5,6 +5,7 @@
- [Introduction](#introduction)
- [Access the Reports](#access-the-reports)
- [Available Information](#available-information)
- [TFT Farming Registration Price](#tft-farming-registration-price)
***
@ -22,11 +23,11 @@ Once you have the receipt hash of your node minting, you can get the [minting re
The ThreeFold Alpha minting tool will present the following information for each minting receipt hash:
- Node Info
- Node Info: This contains the basic information in relation to your node.
- Node ID
- Farm Name and ID
- Measured Uptime
- Node Resources
- Node Resources: These resources are related to the [cloud units](cloud@@cloudunits) and the [resource units](cloud@@resource_units_calc_cloudunits).
- CU
- SU
- NU
@ -34,5 +35,11 @@ The ThreeFold Alpha minting tool will present the following information for each
- MRU
- SRU
- HRU
- TFT Farmed
- Payout Address
- TFT Farmed: This is the quantity of TFT farmed during the minting period.
- Payout Address: The payout address is the Stellar address you set to receive your farming rewards.
## TFT Farming Registration Price
Currently, minting is set at a TFT value of 0.08 USD. This TFT farming registration price (i.e. the TFT minting value) can be seen as a farming difficulty level. The higher this number is, the less TFT is minted for the same given node. This number is not related to the TFT market price and is currently fixed.
The ThreeFold DAO can vote to change this number. For example, if the ThreeFold DAO decides to increase the TFT minting value to 0.10 USD, the farming difficulty would be increased by 25% (0.08 * 1.25 = 0.10). This updated TFT farming registration price would then affect all new nodes that are registered after the DAO vote is passed.

8
collections/farmers/advanced_networking/network_setup.md
View File

@ -28,7 +28,7 @@ The nodes themselves can have connectivity in a few different ways:
- Only have RFC1918 private addresses, connected to the Internet through NAT, NO IPv6
Mostly, these are single-NIC (Network card) machines that can host some workloads through the Overlay Network, but
cant't expose services directly. These are HIDDEN nodes, and are mostly booted with an USB stick from
can't expose services directly. These are HIDDEN nodes, and are mostly booted with an USB stick from
bootstrap.grid.tf .
- Dual-stacked: having RFC1918 private IPv4 and public IPv6 , where the IPv6 addresses are received from a home router,
but firewalled for outgoing traffic only. These nodes are effectively also HIDDEN
@ -70,9 +70,9 @@ Use your (home) ISP router Ipv6 DHCP capabilities to provide (private) IPv6 addr
### 2.2 Data Center/Advanced Setup
In this situation there are many options on how to setup you node. This requires you as the expert to make a few decisions on how to connect what what the best setup is that you can support for the operaitonal time of your farm. The same basics principles apply:
- You have to have a block of (public) IPv6 routed to you router, or you have to have your router setup to provide Network Address Translation (NAT)
- You have to have a DHCP server in your network that manages and controls IPV6 ip adress leases. Depending on your specific setup you have this DHCP server manage a public IPv6y range which makes all nodes directly connected to the public internet or you have this DHCP server manage a private block og IPv6 addresses which makes all you nodes connect to the internet through NAT.
In this situation there are many options on how to setup your node. This requires you as the expert to make a few decisions on how to connect what what the best setup is that you can support for the operaitonal time of your farm. The same basics principles apply:
- You have to have a block of (public) IPv6 routed to your router, or you have to have your router setup to provide Network Address Translation (NAT)
- You have to have a DHCP server in your network that manages and controls IPV6 ip adress leases. Depending on your specific setup you have this DHCP server manage a public IPv6 range which makes all nodes directly connected to the public internet or you have this DHCP server manage a private block of IPv6 addresses which makes all your nodes connect to the internet through NAT.
As a farmer you are in charge of selecting and creating the appropriate network setup for your farm.

14
collections/farmers/farmerbot/farmerbot_information.md
View File

@ -36,6 +36,8 @@
- [Properly reboot the node if power target "Down" doesn't work](#properly-reboot-the-node-if-power-target-down-doesnt-work)
- [Add a 3Node to a running Farmerbot](#add-a-3node-to-a-running-farmerbot)
- [Update the Farmerbot with a new release](#update-the-farmerbot-with-a-new-release)
- [Troubleshooting](#troubleshooting)
- [Can't Find the Logs](#cant-find-the-logs)
- [Questions and Feedback](#questions-and-feedback)
***
@ -431,6 +433,18 @@ There are only a few steps needed to update the Farmerbot to a new release.
rm tfgrid-sdk-go_Linux_x86_64.tar.gz
```
# Troubleshooting
## Can't Find the Logs
If you can't find the logs of the Farmerbot, make sure that you ran the bot before! Once the Farmerbot runs, it should print logs in a file called `farmerbot.log` in the directory where it is running.
You can try a search for any files under the home directory with the `.log` extension in case it's been moved:
```
find ~/ -name '*.log'
```
# Questions and Feedback
If you have questions concerning the Farmerbot, feel free to ask for help on the [ThreeFold Forum](https://forum.threefold.io/) or on the [ThreeFold Farmer chat](https://t.me/threefoldfarmers).