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

@@ -65,7 +65,7 @@ You can use the [Node Finder](../../dashboard/deploy/node_finder.md) on the [TF
## Reserving the GPU Node
Now, users can reserve the node in the **Dedicated Nodes** section of the Dashboard and then deploy workloads using the GPU. For more information, read [this documentation](../../dashboard/deploy/node_finder.md#dedicated-nodes).
Now, users can reserve the node in the **Dedicated Nodes** section of the Dashboard and then deploy workloads using the GPU. For more information, read [this documentation](../../dashboard/deploy/dedicated_machines.md).
## Questions and Feedback

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.0 KiB

View File

@@ -5,7 +5,6 @@
- [Introduction](#introduction)
- [Access the Reports](#access-the-reports)
- [Available Information](#available-information)
- [TFT Farming Registration Price](#tft-farming-registration-price)
***
@@ -23,11 +22,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: This contains the basic information in relation to your node.
- Node Info
- Node ID
- Farm Name and ID
- Measured Uptime
- Node Resources: These resources are related to the [cloud units](../../../knowledge_base/cloud/cloudunits.md) and the [resource units](../../../knowledge_base/cloud/resource_units_calc_cloudunits.md).
- Node Resources
- CU
- SU
- NU
@@ -35,14 +34,8 @@ The ThreeFold Alpha minting tool will present the following information for each
- MRU
- SRU
- HRU
- 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.
- TFT Farmed
- Payout Address
<!-- NOTE: This is removed from the new dashboard, but might be brought back.

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
can't expose services directly. These are HIDDEN nodes, and are mostly booted with an USB stick from
cant'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 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.
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.
As a farmer you are in charge of selecting and creating the appropriate network setup for your farm.
@@ -83,4 +83,4 @@ The above setup will allows your node(s) to appear in explorer on the TFGrid and
We have started a forum where people share their experiences and configurations. This will be work in progress and forever growing.
**IMPORTANT**: You as a farmer do not need access to IPV4 to be able to rent capacity for IT workloads that need to be visible on IPV4, this is something that can happen elsewhere on the TFGrid.

View File

@@ -36,8 +36,6 @@
- [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)
***
@@ -433,20 +431,6 @@ 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 prints 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'
```
If you've deleted the log file while the bot is running, the bot won't recreated it. In this case, you will need to restart the bot, e.g. `systemctl restart farmerbot`. The bot will then automatically create a log file.
# 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).

View File

@@ -231,7 +231,7 @@ power:
periodic_wake_up_start: 01:00PM
```
Note that if the user wants to include all the nodes within a farm, they can simply omit the `included_nodes` section. In this case, all nodes of the farm will be included in the Farmerbot, as shown in the example below. If you are proceeding like this, make sure that you don't have any unused node IDs on your farm, as the Farmerbot would try to wake up nodes that aren't running anymore on the grid.
Note that if the user wants to include all the nodes within a farm, they can simply omit the `included_nodes` section. In this case, all nodes of the farm will be included in the Farmerbot, as shown in the example below:
```
farm_id: 1

View File

@@ -23,7 +23,6 @@ To buy a certified node from an official ThreeFold vendor, check the [ThreeFold
- [Room Parameters](./farming_optimization/farm_room_parameters.md)
- [Farming Costs](./farming_optimization/farming_costs.md)
- [Calculate Your ROI](./farming_optimization/calculate_roi.md)
- [Farming Requirements](./farming_optimization/farming_requirements.md)
- [Advanced Networking](./advanced_networking/advanced_networking_toc.md)
- [Networking Overview](./advanced_networking/networking_overview.md)
- [Network Considerations](./advanced_networking/network_considerations.md)

View File

@@ -10,5 +10,4 @@ The section [Build a 3Node](../3node_building/3node_building.md) covered the not
- [Minting Periods](./minting_periods.md)
- [Room Parameters](./farm_room_parameters.md)
- [Farming Costs](./farming_costs.md)
- [Calculate Your ROI](./calculate_roi.md)
- [Farming Requirements](./farming_requirements.md)
- [Calculate Your ROI](./calculate_roi.md)

View File

@@ -1,28 +0,0 @@
<h1> Farming Requirements </h1>
<h2> Table of Contents </h2>
- [Introduction](#introduction)
- [Uptime Requirements](#uptime-requirements)
- [Farmerbot Consideration](#farmerbot-consideration)
---
## Introduction
This section contains information on the farming requirements.
## Uptime Requirements
To be eligible for proof-of-capacity farming rewards, farmers need to ensure that their nodes have a minimum uptime per minting period.
- 95% uptime requirements for DIY nodes
- This means that nodes have 36 hours of allowed downtime per month
- 98% uptime requirements for certified nodes
- This means that nodes have 14.4 hours of allowed downtime per month
A minting period is 720 hours.
### Farmerbot Consideration
When minting considers a node running the Farmerbot, it counts standby time as uptime, as long as the node is healthy. If the node fails to wake within 24 hours, those 24 are deducted. This means that if the node misses two different wakeup within 24 hours, it will not have sufficient uptime for this minting period. This accounts for both certified and DIY cases.

View File

@@ -45,7 +45,7 @@ The minting periods for the 12 months of 2024 are the following:
| Jan 2024 | December 31, 2023 at 14\:08\:40 | January 31, 2024 at 00\:56\:40 |
| Feb 2024 | January 31, 2024 at 00\:56\:40 | March 1, 2024 at 11\:44\:40 |
| Mar 2024 | March 1, 2024 at 11\:44\:40 | March 31, 2024 at 22\:32\:40 |
| Apr 2024 | March 31, 2024 at 22\:32\:40 | May 1, 2024 at 09\:20\:40 |
| Apr 2024 | Marc 31, 2024 at 22\:32\:40 | May 1, 2024 at 09\:20\:40 |
| May 2024 | May 1, 2024 at 09\:20\:40 | May 31, 2024 at 20\:08\:40 |
| Jun 2024 | May 31, 2024 at 20\:08\:40 | July 1, 2024 at 06\:56\:40 |
| Jul 2024 | July 1, 2024 at 06\:56\:40 | July 31, 2024 at 17:44\:40 |

View File

@@ -11,7 +11,7 @@
## Introduction
Farmers can set additional fees for their 3Nodes on the [TF Dashboard](https://dashboard.grid.tf/). By doing so, users will then be able to [reserve the 3Node and use it as a dedicated node](../../dashboard/deploy/node_finder.md#dedicated-nodes).
Farmers can set additional fees for their 3Nodes on the [TF Dashboard](https://dashboard.grid.tf/). By doing so, users will then be able to [reserve the 3Node and use it as a dedicated node](../../dashboard/deploy/dedicated_machines.md).
This can be useful for farmers who provide additional values to their 3Nodes, e.g. a GPU card and/or high-quality hardware.
## Steps