finalized info_fgrid sync

This commit is contained in:
mik-tf
2024-08-29 19:22:26 -04:00
parent a75e59d42c
commit 0c33119601
53 changed files with 1088 additions and 571 deletions

View File

@@ -15,10 +15,10 @@ The backend for the weblets is introduced with the [Javascript Client](developer
<h2> Table of Contents </h2>
- [Wallet Connector](wallet_connector.md)
- [TFGrid](tfgrid.md)
- [Deploy](deploy.md)
- [Farms](farms.md)
- [TFChain](tfchain.md)
- [TFGrid](tfgrid/tfgrid.md)
- [Deploy](deploy/deploy.md)
- [Farms](farms/farms.md)
- [TFChain](tfchain/tfchain.md)
## Advantages
@@ -42,11 +42,12 @@ You can access the ThreeFold Dashboard on different TF Chain networks.
- 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
## List of Mainnet Backend Stacks
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.
We provide independent mainnet backend stacks. Here is the current list:
- [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
- [https://dashboard.grid.tf](https://dashboard.grid.tf)
- [https://dashboard.be.grid.tf](https://dashboard.be.grid.tf)
- [https://dashboard.fin.grid.tf](https://dashboard.fin.grid.tf)
- [https://dashboard.sg.grid.tf](https://dashboard.sg.grid.tf)
- [https://dashboard.us.grid.tf](https://dashboard.us.grid.tf)

View File

@@ -2,4 +2,6 @@
Find or Publish your Flist from [Zero-OS Hub](https://hub.grid.tf/)
![](../img/0_hub.png)
![](../img/0_hub.png)
Learn more about the Zero-OS Hub [here](developers@@zos_hub).

View File

@@ -45,11 +45,14 @@ If your deployment has some minimum requirements, you can easily filter relevant
## Node Details
You can see all of the node details when you click on its row.
You can see all of the node details when you click on its row:
![](../img/dashboard_node_finder_node_view.png)
Note that the network speed test displayed in the Node Finder is updated every 6 hours.
> Note: The network speed test displayed in the Node Finder is updated every 6 hours.
To access the public Grafana page displaying additional information, click on `Check Node Health`:
![](../img/node_finder_grafana.png)
## Gateway Nodes

View File

@@ -2,24 +2,24 @@
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)
- [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)
- [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)
- [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
## Getting Started
After logging in to the TF Dashboard, on the sidebar click on **Dashboard** then _Your Farms_ .
## Create a new Farm
## 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.
@@ -47,7 +47,7 @@ You can browse your Farms in _Farms_ table; Farms table contains all your own fa
![](../img/dashboard_farms_farms_table.png)
### Add a public IP to your Farm
### 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`.
@@ -69,7 +69,7 @@ Deleting IPv4 addresses is also possible here. The `Deployed Contract ID` gives
![ ](../img/dashboard_farms_ip_details.png)
### Add a Stellar address for payout
### 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.
@@ -79,7 +79,7 @@ In a first phase, farming of tokens still results in payout on the Stellar netwo
You can read about different ways to store TFT [here](threefold_token@@storing_tft). Make sure to use a Stellar wallet for your farming rewards.
### Generate your node bootstrap image
### Generate Your Node Bootstrap Image
Once you know your farmID, you can set up your node on TFGrid3. Click on `Bootstrap Node Image`.
@@ -87,7 +87,7 @@ Once you know your farmID, you can set up your node on TFGrid3. Click on `Bootst
Read more Zero-OS bootstrap image [here](farmers@@2_bootstrap_image).
### Additional information
### 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.
@@ -103,7 +103,7 @@ You can also download a single node's receipts using the `Download Receipts` but
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
### Node Information
Expand your node information by clicking on the expand button in the target node row.

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 KiB

View File

@@ -5,7 +5,7 @@
- [Introduction](#introduction)
- [Requirements](#requirements)
- [Configs Tab](#configs-tab)
- [Admin and Workers Tabs](#admin-and-workers-tabs)
- [Leader and Workers Tabs](#leader-and-workers-tabs)
- [The Domain Name](#the-domain-name)
- [Domain Name Example](#domain-name-example)
- [How to Know the IP Address](#how-to-know-the-ip-address)
@@ -31,10 +31,10 @@ Caprover is a very cool management app for containers based on Docker Swarm.
It has following benefits :
- easy to deploy apps (in seconds)
- easy to create new apps
- super good monitoring
- can be extended over the TFGrid
- Easy to deploy apps (in seconds)
- Easy to create new apps
- Super good monitoring
- Can be extended over the TFGrid
## Requirements
@@ -46,23 +46,51 @@ It has following benefits :
![ ](./img/solutions_caprover.png)
- Enter domain for you Caprover instance, Be very careful about the domain name: it needs to be a wildcard domain name you can configure in your chosen domain name system.
- Enter domain for you Caprover instance.
- Be very careful about the domain name: it needs to be a wildcard domain name you can configure in your chosen domain name system.
- Enter password for you Caprover instance.
If you have more than one SSH keys set, you can click on `Manage SSH keys` to select which one to use for this deployment.
## Admin and Workers Tabs
## Leader and Workers Tabs
Each deployment will have one leader and there can be many workers. By default, CapRover is deployed on nodes with IPv4.
![ ](./img/solutions_caprover_leader.png)
![ ](./img/solutions_caprover_workers.png)
Use the Leader and Workers tabs to add nodes to your deployment.
- Enter a name for the deployment or keep the default name
- Select a capacity package:
- **Small**: {cpu: 1, memory: 2, diskSize: 25 }
- **Medium**: {cpu: 2, memory: 4, diskSize: 50 }
- **Large**: {cpu: 4, memory: 16, diskSize: 100 }
- Or choose a **Custom** plan
- Choose the network
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the node
- Automated
- Choose the location of the node
- `Region`
- `Country`
- `Farm Name`
- Click on `Load Nodes`
- Click on the node you want to deploy on
- Manual selection
- Select a specific node ID
- Click `Deploy`
Note: Worker nodes only accept SSH keys of RSA format.
Deployment will take couple of minutes.
## The Domain Name
As per the [CapRover documentation](https://caprover.com/docs/get-started.html), you need to point a wildcard DNS entry to the VM IP address of your CapRover instance. You have to do this after having deployed the CapRover instance, otherwise you won't have access to the VM IP address.
As per the [CapRover documentation](https://caprover.com/docs/get-started.html), you need to point a wildcard DNS entry to the VM IP address of your CapRover Leader instance. You have to do this after having deployed the CapRover instance, otherwise you won't have access to the VM IP address.
Lets say your domain is **example.com** and your subdomain is **subdomain**. You can set **\*.subdomain.example.com** as an A record in your DNS settings to point to the VM IP address of the server hosting the CapRover instance, where **\*** acts as the wildcard. To do this, go to the DNS settings of your domain name registrar, and set a wild card A record entry.
@@ -97,54 +125,14 @@ Go back to your CapRover weblet and go to the deployment list. Click on `Show De
![ ](./img/solution_caprover_list.png)
- The public IPv4 address is visible in here
![](./img/solutions_caprover_ipaddress.png)
- Now you can configure the domain name (see above, don't forget to point the wildcard domain to the public IP address)
Click on details if you want to see more details
Go to the `JSON` tab to see the Json ouput:
```json
{
"version": 0,
"name": "caprover_leader_cr_156e44f0",
"created": 1637843368,
"status": "ok",
"message": "",
"flist": "https://hub.grid.tf/samehabouelsaad.3bot/tf-caprover-main-a4f186da8d.flist",
"publicIP": {
"ip": "185.206.122.136/24",
"gateway": "185.206.122.1"
},
"planetary": false,
"yggIP": "",
"interfaces": [
{
"network": "caprover_network_cr_156e44f0",
"ip": "10.200.4.2"
}
],
"capacity": {
"cpu": 4,
"memory": 8192
},
"mounts": [
{
"name": "data0",
"mountPoint": "/var/lib/docker",
"size": 107374182400,
"state": "ok",
"message": ""
}
],
"env": {
"SWM_NODE_MODE": "leader",
"CAPROVER_ROOT_DOMAIN": "apps.openly.life",
"PUBLIC_KEY": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC/9RNGKRjHvViunSOXhBF7EumrWvmqAAVJSrfGdLaVasgaYK6tkTRDzpZNplh3Tk1aowneXnZffygzIIZ82FWQYBo04IBWwFDOsCawjVbuAfcd9ZslYEYB3QnxV6ogQ4rvXnJ7IHgm3E3SZvt2l45WIyFn6ZKuFifK1aXhZkxHIPf31q68R2idJ764EsfqXfaf3q8H3u4G0NjfWmdPm9nwf/RJDZO+KYFLQ9wXeqRn6u/mRx+u7UD+Uo0xgjRQk1m8V+KuLAmqAosFdlAq0pBO8lEBpSebYdvRWxpM0QSdNrYQcMLVRX7IehizyTt+5sYYbp6f11WWcxLx0QDsUZ/J"
},
"entrypoint": "/sbin/zinit init",
"metadata": "",
"description": "caprover leader machine/node"
}
```
![](./img/solutions_caprover_json.png)
## How to Access the Admin Interface

View File

@@ -30,8 +30,8 @@ __Process__ :
- Or choose a **Custom** plan
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Dedicated` flag to retrieve only dedeicated nodes
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`
@@ -46,8 +46,8 @@ If you have more than one SSH keys set, you can click on `Manage SSH keys` to se
After that is done you can see a list of all of your deployed instances
![ ](./img/casper4.png)
![](./img/casper4.png)
Click on ***Visit*** to go to the homepage of your Casperlabs instance! The node takes a long time in order for the RPC service to be ready so be patient!
![ ](./img/casper5.png)
![](./img/casper5.png)

View File

@@ -27,8 +27,10 @@
- **Medium**: {cpu: 2, memory: 4, diskSize: 50 }
- **Large**: {cpu: 4, memory: 16, diskSize: 100 }
- Or choose a **Custom** plan
- `Dedicated` flag to retrieve only dedeicated nodes
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -40,7 +40,7 @@ Deploy a new full virtual machine on the Threefold Grid
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Public IPv6` flag gives the virtual machine a Public IPv6
- `Planetary Network` to connect the Virtual Machine to Planetary network
- `Myceluim` to enable mycelium on the virtual machine
- `Mycelium` 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](node_finder.md#dedicated-nodes)

View File

@@ -37,8 +37,8 @@ __Process__ :
- Or choose a **Custom** plan
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Dedicated` flag to retrieve only dedeicated nodes
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -39,7 +39,7 @@ __Process__ :
- `Public IPv6` flag gives the virtual machine a Public IPv6
- `Planetary Network` to connect the Virtual Machine to Planetary network
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedeicated nodes
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -41,7 +41,7 @@ On the TF grid, Kubernetes clusters can be deployed out of the box. We have impl
## Kubeconfig
Once the cluster is ready, you can SSH into the cluster using `ssh root@IP`
> IP can be the public IP or the planetary network IP
> IP can be the public IP, Mycelium or the Planetary Network IP
Onced connected via SSH, you can execute commands on the cluster like `kubectl get nodes`, and to get the kubeconfig, you can find it in `/root/.kube/config`

View File

@@ -29,7 +29,10 @@
- **Medium**: {cpu: 2, memory: 4, diskSize: 50 }
- **Large**: {cpu: 4, memory: 16, diskSize: 100 }
- Or choose a **Custom** plan
- `Dedicated` flag to retrieve only dedeicated nodes
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -68,7 +68,7 @@ If you're not sure and just want the easiest, most affordable option, skip the p
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedeicated nodes
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -29,7 +29,7 @@ This is a simple instance of upstream [Node Pilot](https://nodepilot.tech).
- 256 MB of memory
- 15 GB of storage
- `Dedicated` flag to retrieve only dedeicated nodes
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
@@ -40,7 +40,7 @@ This is a simple instance of upstream [Node Pilot](https://nodepilot.tech).
> Or you can select a specific node with manual selection.
- When using the [flist](https://hub.grid.tf/tf-official-vms/node-pilot-zdbfs.flist) you get a node pilot instance ready out-of-box. You need to get a public ipv4 to get it to works.
- When using the [flist](https://hub.grid.tf/tf-official-vms/node-pilot-zdbfs.flist) you get a node pilot instance ready out-of-box. You need to get a public IPv4 to get it to works.
After that is done you can see a list of all of your deployed instances

View File

@@ -30,13 +30,10 @@
- **Medium**: { cpu: 2, memory: 4, diskSize: 100 }
- **Large**: { cpu: 4, memory: 16, diskSize: 250 }
- Or choose a **Custom** plan
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Public IPv6` flag gives the virtual machine a Public IPv6
- `Planetary Network` to connect the Virtual Machine to Planetary network
- `Wiregaurd Access` to add a wiregaurd acces to the Virtual Machine
- `Dedicated` flag to retrieve only dedeicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the network
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`
- `Country`

View File

@@ -33,8 +33,9 @@
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Planetary Network` to connect the Virtual Machine to Planetary network
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedeicated nodes
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -34,7 +34,9 @@ Static Website is an application where a user provides a GitHub repository URL f
- **Medium**: {cpu: 2, memory: 4, diskSize: 100 }
- **Large**: {cpu: 4, memory: 16, diskSize: 250 }
- Or choose a **Custom** plan
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node

View File

@@ -32,8 +32,9 @@
- **Medium**: {cpu: 2, memory: 4, diskSize: 100 }
- **Large**: {cpu: 4, memory: 16, diskSize: 250 }
- Or choose a **Custom** plan
- `Dedicated` flag to retrieve only dedeicated nodes
- Choose the network
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -31,8 +31,10 @@
- **Medium**: {cpu: 4, memory: 8, diskSize: 150 }
- **Large**: {cpu: 4, memory: 16, diskSize: 250 }
- Or choose a **Custom** plan
- `Dedicated` flag to retrieve only dedeicated nodes
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -41,10 +41,10 @@
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Public IPv6` flag gives the virtual machine a Public IPv6
- `Planetary Network` to connect the Virtual Machine to Planetary network
- `Mycelium` to enable Mycelium on the virtual machine
- `Wireguard Access` to add a wireguard access to the Virtual Machine
- `Dedicated` flag to retrieve only dedeicated nodes
- `Planetary Network` flag gives the virtual machine an Yggdrasil address
- `Mycelium` flag gives the virtual machine a Mycelium address
- `Wireguard Access` to add a WireGuard acces to the Virtual Machine
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -31,8 +31,12 @@
- **Medium**: { cpu: 2, memory: 4 , diskSize: 50 }
- **Large**: { cpu: 4, memory: 16 , diskSize: 100 }
- Or choose a **Custom** plan
- `Dedicated` flag to retrieve only dedeicated nodes
- Choose the network
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Planetary Network` to connect the Virtual Machine to Planetary network
- `Mycelium` to enable Mycelium on the virtual machine
- `Wireguard Access` to add a wireguard acces to the Virtual Machine
- `Dedicated` flag to retrieve only dedicated nodes
- `Certified` flag to retrieve only certified nodes
- Choose the location of the node
- `Region`

View File

@@ -88,8 +88,8 @@ In this section, we cover the steps to deploy a WordPress instance on the Playgr
- Or choose a **Custom** plan
- Choose the network
- **Public IPv4** flag gives the virtual machine a Public IPv4
- `Public IPv4` flag gives the virtual machine a Public IPv4
- `Mycelium` to enable Mycelium on the virtual machine
- **Dedicated** flag to retrieve only dedicated nodes
- **Certified** flag to retrieve only certified nodes
- Choose the location of the node