manual added documentation in collection manual
0
collections/manual/documentation/.collection
Normal file
43
collections/manual/documentation/dashboard/dashboard.md
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
<h1> ThreeFold Dashboard </h1>
|
||||||
|
|
||||||
|
Explore, control, and manage your ThreeFold Grid resources effortlessly through our integrated Dashboard. Deploy solutions seamlessly while gaining full control, all within a unified interface.
|
||||||
|
|
||||||
|
The ThreeFold Dashboard is a revolutionary platform that simplifies the deployment process, allowing users to effortlessly interact with the TFGrid using intuitive web components known as weblets.
|
||||||
|
|
||||||
|
## What is the ThreeFold Dashboard?
|
||||||
|
|
||||||
|
The ThreeFold Dashboard is a dynamic environment designed for both seasoned developers and newcomers alike. It offers a seamless and accessible browser experience, making it easy to deploy solutions on the TFGrid through the use of weblets.
|
||||||
|
|
||||||
|
In the context of the Dashboard, a weblet is a compiled JavaScript web component that can be effortlessly embedded within the HTML page of a web application. This modular approach allows for flexible and intuitive interactions, facilitating a user-friendly deployment process.
|
||||||
|
|
||||||
|
The backend for the weblets is introduced with the [Javascript Client](../developers/javascript/grid3_javascript_readme.md) which communicates to TFChain over RMB.
|
||||||
|
|
||||||
|
<h2> Table of Contents </h2>
|
||||||
|
|
||||||
|
- [Wallet Connector](./wallet_connector.md)
|
||||||
|
- [TFGrid](./tfgrid/tfgrid.md)
|
||||||
|
- [Deploy](./deploy/deploy.md)
|
||||||
|
- [Farms](./farms/farms.md)
|
||||||
|
- [TFChain](./tfchain/tfchain.md)
|
||||||
|
|
||||||
|
## Advantages
|
||||||
|
|
||||||
|
- It is a non-code easy way to deploy a whole solution on the TFGrid.
|
||||||
|
- It is 100% decentralized, there is no server involved.
|
||||||
|
- It is powerful tool designed to empower individuals and organizations with seamless control and management over their ThreeFold Grid resources.
|
||||||
|
- It provides an intuitive web-based interface that allows users to effortlessly deploy, monitor, and scale their workloads on the decentralized and sustainable ThreeFold Grid infrastructure.
|
||||||
|
|
||||||
|
## Dashboard
|
||||||
|
|
||||||
|
You can access the ThreeFold Dashboard on different TF Chain networks.
|
||||||
|
|
||||||
|
- [https://dashboard.dev.grid.tf](https://dashboard.dev.grid.tf) for Dev net
|
||||||
|
- [https://dashboard.qa.grid.tf](https://dashboard.qa.grid.tf) for QA net
|
||||||
|
- [https://dashboard.test.grid.tf](https://dashboard.test.grid.tf) for Test net
|
||||||
|
- [https://dashboard.grid.tf](https://dashboard.grid.tf) for Main net
|
||||||
|
|
||||||
|
## Limitations
|
||||||
|
|
||||||
|
- 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.
|
@ -0,0 +1,24 @@
|
|||||||
|
<h1> Ready Community Applications </h1>
|
||||||
|
|
||||||
|
Easily deploy your favourite applications on the ThreeFold grid with a click of a button.
|
||||||
|
|
||||||
|
![](../img/applications_landing.png)
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
<h2> Table of Contents </h2>
|
||||||
|
|
||||||
|
- [Algorand](../solutions/algorand.md)
|
||||||
|
- [CasperLabs](../solutions/casper.md)
|
||||||
|
- [Discourse](../solutions/discourse.md)
|
||||||
|
- [Funkwhale](../solutions/funkwhale.md)
|
||||||
|
- [Mattermost](../solutions/mattermost.md)
|
||||||
|
- [Nextcloud](../solutions/nextcloud.md)
|
||||||
|
- [Node Pilot](../solutions/nodepilot.md)
|
||||||
|
- [ownCloud](../solutions/owncloud.md)
|
||||||
|
- [Peertube](../solutions/peertube.md)
|
||||||
|
- [Presearch](../solutions/presearch.md)
|
||||||
|
- [Subsquid](../solutions/subsquid.md)
|
||||||
|
- [Taiga](../solutions/taiga.md)
|
||||||
|
- [Umbrel](../solutions/umbrel.md)
|
||||||
|
- [WordPress](../solutions/wordpress.md)
|
@ -0,0 +1,93 @@
|
|||||||
|
<h1> Dedicated Machines </h1>
|
||||||
|
|
||||||
|
<h2> Table of Contents </h2>
|
||||||
|
|
||||||
|
- [What is a Dedicated Machine?](#what-is-a-dedicated-machine)
|
||||||
|
- [Description](#description)
|
||||||
|
- [Billing \& Pricing](#billing--pricing)
|
||||||
|
- [Discounts](#discounts)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [GPU Support](#gpu-support)
|
||||||
|
- [Filter and Reserve a GPU Node](#filter-and-reserve-a-gpu-node)
|
||||||
|
- [Filter Nodes](#filter-nodes)
|
||||||
|
- [Reserve a Node](#reserve-a-node)
|
||||||
|
- [GPU Support Links](#gpu-support-links)
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
## What is a Dedicated Machine?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## 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](../../../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.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
- See list of all dedicated node on `Dedicated Machines` tab on the portal.
|
||||||
|
|
||||||
|
![ ](../img/dedicated_machines.png)
|
||||||
|
|
||||||
|
- Hover over the price to see the applied discounts
|
||||||
|
|
||||||
|
![](../img/dashboard_dedicated_nodes_discounts.png)
|
||||||
|
|
||||||
|
- Expand row to see more info on the node:
|
||||||
|
|
||||||
|
![ ](../img/dashboard_dedicated_nodes_details.png)
|
||||||
|
- Resources
|
||||||
|
- Location
|
||||||
|
- Possible Public Ips *this depends on the farm it belongs to*
|
||||||
|
|
||||||
|
- You can see the nodes in 2 states:
|
||||||
|
- Free
|
||||||
|
- Reserved *Owned by current twin*
|
||||||
|
- Reserve a node:
|
||||||
|
- If node is not rented by another twin you can simply click reserve.
|
||||||
|
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
## Filter and Reserve a GPU Node
|
||||||
|
|
||||||
|
You can filter and reserve a GPU node using the [Dedicated Machines section](https://dashboard.grid.tf/#/deploy/dedicated-nodes/) of the **Dashboard**.
|
||||||
|
|
||||||
|
### Filter Nodes
|
||||||
|
|
||||||
|
- Filter nodes using the vendor name
|
||||||
|
- In **Filters**, select **GPU's vendor name**
|
||||||
|
- Write the name of the vendor desired (e.g. **nvidia**, **amd**)
|
||||||
|
- Filter nodes using the device name
|
||||||
|
- In **Filters**, select **GPU's device name**
|
||||||
|
- Write the name of the device desired (e.g. **GT218**)
|
||||||
|
|
||||||
|
### Reserve a Node
|
||||||
|
|
||||||
|
When you have decided which node to reserve, click on **Reserve** under the column named **Actions**. Once you've rented a dedicated node that has a GPU, you can deploy GPU workloads.
|
||||||
|
|
||||||
|
## 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.
|
27
collections/manual/documentation/dashboard/deploy/deploy.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
# Deploy
|
||||||
|
|
||||||
|
Here you will find everything related to deployments on the ThreeFold grid. This includes:
|
||||||
|
|
||||||
|
- 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/sidebar_2.png)
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
## Table of Content
|
||||||
|
|
||||||
|
- [Pricing Calculator](./pricing_calculator.md)
|
||||||
|
- [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)
|
||||||
|
- [SSH Keys](./ssh_keys.md)
|
@ -0,0 +1,5 @@
|
|||||||
|
# Images
|
||||||
|
|
||||||
|
Find or Publish your Flist from [Zero-OS Hub](https://hub.grid.tf/)
|
||||||
|
|
||||||
|
![](../img/0_hub.png)
|
@ -0,0 +1,40 @@
|
|||||||
|
<h1>Node Finder</h1>
|
||||||
|
|
||||||
|
<h2>Table of Contents</h2>
|
||||||
|
|
||||||
|
- [Nodes](#nodes)
|
||||||
|
- [GPU Support](#gpu-support)
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
## 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/nodes.png)
|
||||||
|
|
||||||
|
You can get a node with the desired specifications using the filters available in the nodes page.
|
||||||
|
|
||||||
|
![](../img/nodes_filters.png)
|
||||||
|
|
||||||
|
You can see all of the node details by clicking on a node record.
|
||||||
|
|
||||||
|
![](../img/nodes_details.png)
|
||||||
|
|
||||||
|
## GPU Support
|
||||||
|
|
||||||
|
![GPU support](../img/gpu_filter.png)
|
||||||
|
|
||||||
|
- A new filter for GPU supported node is now available on the Nodes page.
|
||||||
|
- GPU count
|
||||||
|
- Filtering capabilities based on the model / device
|
||||||
|
|
||||||
|
On the details pages is shown the card information and its status (`reserved` or `available`) also the ID that’s needed to be used during deployments is easily accessible and has a copy to clipboard button.
|
||||||
|
|
||||||
|
![GPU details](../img/gpu_details.png)
|
||||||
|
|
||||||
|
Here’s an example of how it looks in case of reserved
|
||||||
|
|
||||||
|
![GPU details](../img/gpu_details_reserved.png)
|
||||||
|
|
||||||
|
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).
|
@ -0,0 +1,19 @@
|
|||||||
|
<h1> GPU Support </h1>
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
![GPU support](../img/gpu_filter.png)
|
||||||
|
|
||||||
|
- A new filter for GPU supported node is now available on the Nodes page.
|
||||||
|
- GPU count
|
||||||
|
- Filtering capabilities based on the model / device
|
||||||
|
|
||||||
|
On the details pages is shown the card information and its status (`reserved` or `available`) also the ID that’s needed to be used during deployments is easily accessible and has a copy to clipboard button.
|
||||||
|
|
||||||
|
![GPU details](../img/gpu_details.png)
|
||||||
|
|
||||||
|
Here’s an example of how it looks in case of reserved
|
||||||
|
|
||||||
|
![GPU details](../img/gpu_details_reserved.png)
|
||||||
|
|
||||||
|
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).
|
@ -0,0 +1,14 @@
|
|||||||
|
# Orchestrators
|
||||||
|
|
||||||
|
Deploy your favorite orchestrating services and enjoy the seamless coordination and automation of various software applications and services.
|
||||||
|
|
||||||
|
![](../img/orchestrator_landing.png)
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
## Table of Contnet
|
||||||
|
|
||||||
|
- [Kubernetes](../solutions/k8s.md)
|
||||||
|
- [Caprover](../solutions/caprover.md)
|
||||||
|
- [Caprover Admin](../solutions/caprover_admin.md)
|
||||||
|
- [Caprover Worker](../solutions/caprover_worker.md)
|
@ -0,0 +1,6 @@
|
|||||||
|
# TF Resource Calculator
|
||||||
|
|
||||||
|
A tool provided by ThreeFold that allows users to estimate and calculate potential cost of a deployment on the ThreeFold grid. The resource calculator takes into account various factors, including deployment resources, node certification, currnet balance, and in return it displays an accurate estimate for the deployment in terms of ThreeFold Tokens (TFT) and in USD per month.
|
||||||
|
|
||||||
|
|
||||||
|
![](../img/pricing_calculator.png)
|
@ -0,0 +1,5 @@
|
|||||||
|
# SSH Keys
|
||||||
|
|
||||||
|
Add, update or generate your SSH key with a click of a button.
|
||||||
|
|
||||||
|
![](../img/SSH_Key.png)
|
13
collections/manual/documentation/dashboard/deploy/vm.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<h1> Virtual Machines </h2>
|
||||||
|
|
||||||
|
On the TFGrid, you can deploy both micro and full virtual machines.
|
||||||
|
|
||||||
|
![](../img/vm_landing.png)
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
<h2> Table of Contents </h2>
|
||||||
|
|
||||||
|
- [Micro and Full VM Differences ](../solutions/vm_differences.md)
|
||||||
|
- [Full Virtual Machine](../solutions/fullVm.md)
|
||||||
|
- [Micro Virtual Machine](../solutions/vm.md)
|
@ -0,0 +1,49 @@
|
|||||||
|
# Contracts
|
||||||
|
|
||||||
|
From the Contracts section you can check your contracts by navigating to the `Deploy` then `Your Contracts` tab from the sidebar.
|
||||||
|
|
||||||
|
From there you will see the `Contracts List`, the list is split into three different sections. these sections are:
|
||||||
|
|
||||||
|
### Node contracts
|
||||||
|
|
||||||
|
![image](../img/node_contracts.png)
|
||||||
|
|
||||||
|
### Name contracts
|
||||||
|
|
||||||
|
![image](../img/name_contracts.png)
|
||||||
|
|
||||||
|
### Rent contracts
|
||||||
|
|
||||||
|
![image](../img/rent_contracts.png)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This list includes the following information about each contract.
|
||||||
|
|
||||||
|
- Contract ID.
|
||||||
|
- Contract Type.
|
||||||
|
- Contract State (Created, Deleted, GracePeriod).
|
||||||
|
- Solution Typw
|
||||||
|
- Billing Rate (in TFT/Hour).
|
||||||
|
- Solution Name.
|
||||||
|
- Created At.
|
||||||
|
- Expiration (Only appears if the contract is in GracePeriod).
|
||||||
|
- Node ID
|
||||||
|
- Node Status (Up, Down, Standby).
|
||||||
|
- Show Details (This button will display the detailed information of the desired contract).
|
||||||
|
|
||||||
|
![image](../img/contract_details.png)
|
||||||
|
|
||||||
|
|
||||||
|
## Cancel Contract
|
||||||
|
|
||||||
|
You can also cancel the target contract/s by select the contract you want to cancel
|
||||||
|
|
||||||
|
- Click on the checkbox on the left side of the contract row
|
||||||
|
- Click on the delete button in the bottom right of the table
|
||||||
|
- Review the contract/s ID then click on *Delete* button
|
||||||
|
|
||||||
|
Note:
|
||||||
|
|
||||||
|
>- You can Cancel all you contracts by clicking on the checkbox on the left side of the table header then click on *Delete* button.
|
||||||
|
>- It is advisable to remove the contract from its solution page, especially when multiple contracts may be linked to the same instance.
|
19
collections/manual/documentation/dashboard/farms/farms.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# Farms
|
||||||
|
|
||||||
|
Here you will find everything farming related. this includes:
|
||||||
|
|
||||||
|
- Monitoring, creating, and updating your farms from the [Your Farms](./your_farms.md) section where you can also check your nodes and update multiple things like the public configuration and extra fees of the node.
|
||||||
|
- Exploring and finding farms that are available on the ThreeFold grid from the [Farm Finder](./farms_finder.md) section.
|
||||||
|
- Generating your own boot device for your system from the [Node Installer](./node_installer.md) section.
|
||||||
|
- Estimating and calculating potential earnings from farming on the ThreeFold Grid from the [Simulator](./simulator.md) section.
|
||||||
|
|
||||||
|
![](../img/sidebar_3.png)
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
## Table of Content
|
||||||
|
|
||||||
|
- [Your Farms](./your_farms.md)
|
||||||
|
- [Farm Finder](./farms_finder.md)
|
||||||
|
- [Node Installer](./node_installer.md)
|
||||||
|
- [Simulator](./simulator.md)
|
@ -0,0 +1,13 @@
|
|||||||
|
# Farms
|
||||||
|
|
||||||
|
The farms page provides a more detailed view for the farms available on the ThreeFold grid With detailed information about any of the available farms.
|
||||||
|
|
||||||
|
![](../img/farms.png)
|
||||||
|
|
||||||
|
You can search for a specific farm using the farms filters.
|
||||||
|
|
||||||
|
![](../img/farms_filters.png)
|
||||||
|
|
||||||
|
You can see all of the farm details by clicking on a farm record.
|
||||||
|
|
||||||
|
![](../img/farms_details.png)
|
@ -0,0 +1,5 @@
|
|||||||
|
# Node Installer
|
||||||
|
|
||||||
|
Generate your own boot device for your system and download Zero-OS Images from [Zero-OS Bootstrap](https://bootstrap.grid.tf/)
|
||||||
|
|
||||||
|
![](../img/0_Bootstrap.png)
|
@ -0,0 +1,5 @@
|
|||||||
|
# Simulator
|
||||||
|
|
||||||
|
A tool provided by ThreeFold that allows users to estimate and calculate potential earnings from farming on the ThreeFold Grid. Farming refers to the process of providing computing resources, such as storage and processing power, to the ThreeFold Grid and earning tokens in return. The tf-farming-calculator takes into account various factors, including the amount of resources contributed, the duration of farming, and the current market conditions, to provide users with an estimate of their potential earnings in terms of ThreeFold Tokens (TFT).
|
||||||
|
|
||||||
|
![](../img/simulator.png)
|
134
collections/manual/documentation/dashboard/farms/your_farms.md
Normal file
@ -0,0 +1,134 @@
|
|||||||
|
# Farms <!-- omit from toc -->
|
||||||
|
|
||||||
|
This comprehensive guide aims to provide users with detailed instructions and insights into efficiently managing their _Farms_. Farms encompass servers and storage devices contributing computational and storage capabilities to the grid, empowering users to oversee, maintain, and optimize their resources effectively.
|
||||||
|
|
||||||
|
- [Getting started](#getting-started)
|
||||||
|
- [Create a new Farm](#create-a-new-farm)
|
||||||
|
- [Manage Your Farms](#manage-your-farms)
|
||||||
|
- [Add a public IP to your Farm](#add-a-public-ip-to-your-farm)
|
||||||
|
- [Add a Stellar address for payout](#add-a-stellar-address-for-payout)
|
||||||
|
- [Generate your node bootstrap image](#generate-your-node-bootstrap-image)
|
||||||
|
- [Additional information](#additional-information)
|
||||||
|
- [Manage Your Nodes](#manage-your-nodes)
|
||||||
|
- [Node information](#node-information)
|
||||||
|
- [Extra Fees](#extra-fees)
|
||||||
|
- [Public Configuration](#public-configuration)
|
||||||
|
- [The Difference Between IPs Assigned to Nodes Versus a Farm](#the-difference-between-ips-assigned-to-nodes-versus-a-farm)
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
After logging in to the TF Dashboard, on the sidebar click on **Dashboard** then _Your Farms_ .
|
||||||
|
|
||||||
|
## Create a new Farm
|
||||||
|
|
||||||
|
If you want to start farming, you need a farmID, 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_farms.png)
|
||||||
|
|
||||||
|
![ ](../img/dashboard_farms_create.png)
|
||||||
|
|
||||||
|
Click on `Create`.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Manage Your Farms
|
||||||
|
|
||||||
|
You can browse your Farms in _Farms_ table; Farms table contains all your own farms and its your entry point to manage your farm as in the following sections.
|
||||||
|
|
||||||
|
![](../img/dashboard_farms_farms_table.png)
|
||||||
|
|
||||||
|
### 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_farms_farm_details.png)
|
||||||
|
|
||||||
|
![ ](../img/dashboard_farms_add_ip_single.png)
|
||||||
|
|
||||||
|
![ ](../img/dashboard_farms_add_ip_range.png)
|
||||||
|
|
||||||
|
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_farms_ip_details.png)
|
||||||
|
|
||||||
|
### 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_farms_farm_details.png)
|
||||||
|
|
||||||
|
![ ](../img/dashboard_farms_stellar_address.png)
|
||||||
|
|
||||||
|
You can read about different ways to store TFT [here](../../threefold_token/storing_tft/storing_tft.md). Make sure to use a Stellar wallet for your farming rewards.
|
||||||
|
|
||||||
|
### Generate your node bootstrap image
|
||||||
|
|
||||||
|
Once you know your farmID, you can set up your node on TFGrid3. Click on `Bootstrap Node Image`.
|
||||||
|
|
||||||
|
![dashboard_bootstrap_farm](../img/dashboard_bootstrap_farm.png)
|
||||||
|
|
||||||
|
Read more Zero-OS bootstrap image [here](../../farmers/3node_building/2_bootstrap_image.md).
|
||||||
|
|
||||||
|
### Additional information
|
||||||
|
|
||||||
|
After booting a node, the info will become available in `Your Nodes` table, including the status info along with the minting and fixup receipts.
|
||||||
|
|
||||||
|
![ ](../img/dashboard_farms_node_details.png)
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Manage Your Nodes
|
||||||
|
|
||||||
|
as in farms table _Nodes_ table contains all your own nodes and its your entry point to manage your farm as in the following sections.
|
||||||
|
|
||||||
|
### Node information
|
||||||
|
|
||||||
|
Expand your node information by clicking on the expand button in the target node row.
|
||||||
|
|
||||||
|
### Extra Fees
|
||||||
|
|
||||||
|
You can set a price for the special hardware you’re providing e.g. GPUs while renting.
|
||||||
|
|
||||||
|
![](../img/dashboard_farms_extra_fee.png)
|
||||||
|
|
||||||
|
- Under the **Your Nodes** table, locate the target node and click **Set Additional Fees** under **Actions**
|
||||||
|
- Set a monthly fee (in USD) and click **Save**
|
||||||
|
|
||||||
|
### Public Configuration
|
||||||
|
|
||||||
|
To configure public IP addresses to a specific Node
|
||||||
|
|
||||||
|
![](../img/dashboard_farms_public_config.png)
|
||||||
|
|
||||||
|
- Under the **Your Nodes** table, locate the target node and click **Add a public config** under **Actions**
|
||||||
|
- Fill in the necessary information and click save. Only the IPv4 address and gateway are necessary.
|
||||||
|
|
||||||
|
> The IPv6 address and the Domain are optional but if you provide The IPv6 you have to provide its Domain.
|
||||||
|
|
||||||
|
#### The Difference Between IPs Assigned to Nodes Versus a Farm
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
IPs assigned to a farm are available to be rented by workloads. They can be assigned to virtual machines for example. IPs assigned to nodes enable each node to become a gateway.
|
43
collections/manual/documentation/dashboard/home.md
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
<h1> ThreeFold Dashboard </h1>
|
||||||
|
|
||||||
|
Explore, control, and manage your ThreeFold Grid resources effortlessly through our integrated Dashboard. Deploy solutions seamlessly while gaining full control, all within a unified interface.
|
||||||
|
|
||||||
|
The ThreeFold Dashboard is a revolutionary platform that simplifies the deployment process, allowing users to effortlessly interact with the TFGrid using intuitive web components known as weblets.
|
||||||
|
|
||||||
|
## What is the ThreeFold Dashboard?
|
||||||
|
|
||||||
|
The ThreeFold Dashboard is a dynamic environment designed for both seasoned developers and newcomers alike. It offers a seamless and accessible browser experience, making it easy to deploy solutions on the TFGrid through the use of weblets.
|
||||||
|
|
||||||
|
In the context of the Dashboard, a weblet is a compiled JavaScript web component that can be effortlessly embedded within the HTML page of a web application. This modular approach allows for flexible and intuitive interactions, facilitating a user-friendly deployment process.
|
||||||
|
|
||||||
|
The backend for the weblets is introduced with the [Javascript Client](../javascript/grid3_javascript_readme.md) which communicates to TFChain over RMB.
|
||||||
|
|
||||||
|
<h2> Table of Contents </h2>
|
||||||
|
|
||||||
|
- [Wallet Connector](./wallet_connector.md)
|
||||||
|
- [TFGrid](./tfgrid/tfgrid.md)
|
||||||
|
- [Deploy](./deploy/deploy.md)
|
||||||
|
- [Farms](./farms/farms.md)
|
||||||
|
- [TFChain](./tfchain/tfchain.md)
|
||||||
|
|
||||||
|
## Advantages
|
||||||
|
|
||||||
|
- It is a non-code easy way to deploy a whole solution on the TFGrid.
|
||||||
|
- It is 100% decentralized, there is no server involved.
|
||||||
|
- It is powerful tool designed to empower individuals and organizations with seamless control and management over their ThreeFold Grid resources.
|
||||||
|
- It provides an intuitive web-based interface that allows users to effortlessly deploy, monitor, and scale their workloads on the decentralized and sustainable ThreeFold Grid infrastructure.
|
||||||
|
|
||||||
|
## Dashboard
|
||||||
|
|
||||||
|
You can access the ThreeFold Dashboard on different TF Chain networks.
|
||||||
|
|
||||||
|
- [https://dashboard.dev.grid.tf](https://dashboard.dev.grid.tf) for Dev net.
|
||||||
|
- [https://dashboard.qa.grid.tf](https://dashboard.qa.grid.tf) for QA net.
|
||||||
|
- [https://dashboard.test.grid.tf](https://dashboard.test.grid.tf) for Test net.
|
||||||
|
- [https://dashboard.grid.tf](https://dashboard.grid.tf) for Main net.
|
||||||
|
|
||||||
|
## Limitations
|
||||||
|
|
||||||
|
- 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.
|
3
collections/manual/documentation/dashboard/img/.done
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
dashboard_tc.png
|
||||||
|
dashboard_portal_terms_conditions.png
|
||||||
|
profile_manager1.png
|
BIN
collections/manual/documentation/dashboard/img/0_bootstrap.png
Normal file
After Width: | Height: | Size: 166 KiB |
BIN
collections/manual/documentation/dashboard/img/0_hub.png
Normal file
After Width: | Height: | Size: 96 KiB |
BIN
collections/manual/documentation/dashboard/img/add_domain_10.png
Normal file
After Width: | Height: | Size: 42 KiB |
BIN
collections/manual/documentation/dashboard/img/add_domain_11.png
Normal file
After Width: | Height: | Size: 66 KiB |
BIN
collections/manual/documentation/dashboard/img/add_domain_6.png
Normal file
After Width: | Height: | Size: 33 KiB |
BIN
collections/manual/documentation/dashboard/img/add_domain_8.png
Normal file
After Width: | Height: | Size: 64 KiB |
BIN
collections/manual/documentation/dashboard/img/add_domain_9.png
Normal file
After Width: | Height: | Size: 48 KiB |
After Width: | Height: | Size: 4.1 KiB |
After Width: | Height: | Size: 188 KiB |
BIN
collections/manual/documentation/dashboard/img/bridge.png
Normal file
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 48 KiB |
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 130 KiB |
After Width: | Height: | Size: 9.0 KiB |
After Width: | Height: | Size: 60 KiB |
After Width: | Height: | Size: 93 KiB |
BIN
collections/manual/documentation/dashboard/img/dashboard_dao.png
Normal file
After Width: | Height: | Size: 86 KiB |
After Width: | Height: | Size: 42 KiB |
After Width: | Height: | Size: 56 KiB |
After Width: | Height: | Size: 100 KiB |
After Width: | Height: | Size: 120 KiB |
After Width: | Height: | Size: 255 KiB |
After Width: | Height: | Size: 115 KiB |
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 7.5 KiB |
After Width: | Height: | Size: 21 KiB |
After Width: | Height: | Size: 24 KiB |
After Width: | Height: | Size: 26 KiB |
After Width: | Height: | Size: 17 KiB |
After Width: | Height: | Size: 45 KiB |
After Width: | Height: | Size: 22 KiB |
After Width: | Height: | Size: 9.1 KiB |
After Width: | Height: | Size: 70 KiB |
After Width: | Height: | Size: 130 KiB |
After Width: | Height: | Size: 37 KiB |
After Width: | Height: | Size: 137 KiB |
After Width: | Height: | Size: 123 KiB |
After Width: | Height: | Size: 29 KiB |
After Width: | Height: | Size: 64 KiB |
After Width: | Height: | Size: 59 KiB |
After Width: | Height: | Size: 68 KiB |
After Width: | Height: | Size: 523 KiB |
After Width: | Height: | Size: 157 KiB |
After Width: | Height: | Size: 23 KiB |
After Width: | Height: | Size: 64 KiB |
After Width: | Height: | Size: 64 KiB |
After Width: | Height: | Size: 31 KiB |
After Width: | Height: | Size: 22 KiB |
After Width: | Height: | Size: 28 KiB |
After Width: | Height: | Size: 62 KiB |
BIN
collections/manual/documentation/dashboard/img/dashboard_tc.png
Normal file
After Width: | Height: | Size: 531 KiB |
After Width: | Height: | Size: 68 KiB |
After Width: | Height: | Size: 49 KiB |
After Width: | Height: | Size: 61 KiB |
After Width: | Height: | Size: 107 KiB |
After Width: | Height: | Size: 124 KiB |
After Width: | Height: | Size: 270 KiB |
After Width: | Height: | Size: 104 KiB |
After Width: | Height: | Size: 26 KiB |
After Width: | Height: | Size: 100 KiB |
After Width: | Height: | Size: 120 KiB |
BIN
collections/manual/documentation/dashboard/img/explorer_gpu.png
Normal file
After Width: | Height: | Size: 57 KiB |
After Width: | Height: | Size: 190 KiB |
After Width: | Height: | Size: 73 KiB |
After Width: | Height: | Size: 30 KiB |
After Width: | Height: | Size: 94 KiB |
After Width: | Height: | Size: 25 KiB |
After Width: | Height: | Size: 124 KiB |
After Width: | Height: | Size: 55 KiB |
After Width: | Height: | Size: 90 KiB |
After Width: | Height: | Size: 277 KiB |
After Width: | Height: | Size: 77 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 7.0 KiB |
After Width: | Height: | Size: 7.0 KiB |
BIN
collections/manual/documentation/dashboard/img/farms.png
Normal file
After Width: | Height: | Size: 52 KiB |
BIN
collections/manual/documentation/dashboard/img/farms_details.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
collections/manual/documentation/dashboard/img/farms_filters.png
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
collections/manual/documentation/dashboard/img/gpu_details.png
Normal file
After Width: | Height: | Size: 23 KiB |