...
This commit is contained in:
97
tosort/dashboard/explorer/explorer_find_capacity.md
Normal file
97
tosort/dashboard/explorer/explorer_find_capacity.md
Normal file
@@ -0,0 +1,97 @@
|
||||
<h1> ThreeFold Nodes Explorer </h1>
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Nodes Explorer Links](#nodes-explorer-links)
|
||||
- [Nodes Explorer Parameters](#nodes-explorer-parameters)
|
||||
- [Nodes Explorer Filters](#nodes-explorer-filters)
|
||||
- [Note on Public IP](#note-on-public-ip)
|
||||
- [Finding a Node](#finding-a-node)
|
||||
- [Questions and Feedback](#questions-and-feedback)
|
||||
|
||||
***
|
||||
|
||||
## Introduction
|
||||
|
||||
In this section, we cover how to use the ThreeFold Nodes Explorer to find capacity on the TFGrid.
|
||||
|
||||
Using the ThreeFold Nodes Explorer is a quick way to make sure that you are deploying on a node that is optimal for your specific workload. For example, you can use the Explorer to verify that there is enough capacity on a given node for your workload requirements.
|
||||
|
||||
## Nodes Explorer Links
|
||||
|
||||
Each network has a specific Dashboard. Make sure to use the correct URL that corresponds to the network you are deploying on.
|
||||
|
||||
- [Devnet Dashboard](https://dashboard.dev.grid.tf)
|
||||
- [Nodes Explorer](https://dashboard.dev.grid.tf/#/deploy/nodes)
|
||||
- [Qanet Dashboard](https://dashboard.qa.grid.tf)
|
||||
- [Nodes Explorer](https://dashboard.qa.grid.tf/explorer/nodes)
|
||||
- [Testnet Dashboard](https://dashboard.test.grid.tf)
|
||||
- [Nodes Explorer](https://dashboard.test.grid.tf/explorer/nodes)
|
||||
- [Mainnet Dashboard](https://dashboard.grid.tf)
|
||||
- [Nodes Explorer](https://dashboard.grid.tf/explorer/nodes)
|
||||
|
||||
## Nodes Explorer Parameters
|
||||
|
||||
There are many ways to use the Nodes Explorer.
|
||||
|
||||
To search only nodes with GPU, click on the toggle button **GPU Node (Only)**.
|
||||
|
||||
|
||||
|
||||
To search only gateway nodes, click on the toggle button **Gateways (Only)**.
|
||||
|
||||
|
||||
|
||||
On the right of the window, there is a drop-down menu to filter nodes based on their status: **Up**, **Down** and **Standby**. By default, this is set to **Up**.
|
||||
|
||||
|
||||
|
||||
Note that you can combine all those parameters.
|
||||
|
||||
## Nodes Explorer Filters
|
||||
|
||||
You can use different filters to narrow down your search. They are as follows:
|
||||
|
||||
- Node ID
|
||||
- Twin ID
|
||||
- Farm IDs
|
||||
- Farm Name
|
||||
- Country Full Name
|
||||
- Free SRU (GB)
|
||||
- Total HRU (GB)
|
||||
- Total MRU (GB)
|
||||
- Total CRU (Cores)
|
||||
- Free Public IP
|
||||
|
||||
### Note on Public IP
|
||||
|
||||
If you want to find a node with a public IP, it is recommended to set the filter **Free Public IP** to at least **2**. This will make sure that the public IP of the nodes presented to you are properly set.
|
||||
|
||||
## Finding a Node
|
||||
|
||||
To give you an overview of the search process, let's look for a node in Belgium with at least 4GB of SSD storage, 2GB of memory and an available public IP. We simply select those filters in the filter menu and set the filter information:
|
||||
|
||||
|
||||
|
||||
The nodes corresponding to your search are then presented to you:
|
||||
|
||||
|
||||
|
||||
At any time, you can click on a given node to see the node information:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
You can also click on **Check Node Metrics** to see the node information on Grafana. Using Grafana can be quite useful to get some very precise node data.
|
||||
|
||||
|
||||
|
||||
Once you've found a proper node for your deployment, take note of its node ID. There are different ways to deploy on a node. For example, you can use [Terraform](../../terraform/terraform_readme.md) or [Pulumi](../../pulumi/pulumi_readme.md).
|
||||
|
||||
## Questions and Feedback
|
||||
|
||||
If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram. You can also reach the [ThreeFold Support](https://threefoldfaq.crisp.help/en/) for help.
|
||||
39
tosort/dashboard/explorer/explorer_gpu_support.md
Normal file
39
tosort/dashboard/explorer/explorer_gpu_support.md
Normal file
@@ -0,0 +1,39 @@
|
||||
<h1> GPU Support </h1>
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [ThreeFold Explorer](#threefold-explorer)
|
||||
- [Statistics View](#statistics-view)
|
||||
|
||||
***
|
||||
|
||||
## Introduction
|
||||
|
||||
The ThreeFold Explorer is a powerful tool that empowers users to navigate and interact with the ThreeFold Grid seamlessly. Offering a comprehensive Statistics View, the TF Explorer provides real-time insights into the network, enabling users to make informed decisions and optimize their experiences within the decentralized ecosystem.
|
||||
|
||||
One of the groundbreaking advancements introduced in the ThreeFold Grid is the support for GPUs. This addition opens up new possibilities for users seeking enhanced computational capabilities. However, it's important to note that, to leverage GPU support, users must rent the entire 3Node as a dedicated server. This ensures the optimal utilization of GPU resources and provides users with a dedicated environment for deploying GPU-accelerated workloads on the TFGrid.
|
||||
|
||||
## ThreeFold Explorer
|
||||
|
||||
|
||||
|
||||
- A new filter for GPU supported node is now available on the TF Explorer
|
||||
- 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.
|
||||
|
||||
|
||||
|
||||
Here’s an example of how it looks in case of reserved
|
||||
|
||||
|
||||
|
||||
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).
|
||||
|
||||
## Statistics View
|
||||
|
||||
A simple card with GPUs count been added.
|
||||
|
||||
|
||||
203
tosort/dashboard/explorer/explorer_graphql_intro.md
Normal file
203
tosort/dashboard/explorer/explorer_graphql_intro.md
Normal file
@@ -0,0 +1,203 @@
|
||||
<h1> A Glimpse Into GraphQL </h1>
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Get Started](#get-started)
|
||||
- [GraphQL Examples](#graphql-examples)
|
||||
- [Getting Many Nodes](#getting-many-nodes)
|
||||
- [Finding Gateways](#finding-gateways)
|
||||
- [Finding Farms with Public IPs](#finding-farms-with-public-ips)
|
||||
- [Finding Nodes on a Specific Farm](#finding-nodes-on-a-specific-farm)
|
||||
- [Finding Nodes by Country](#finding-nodes-by-country)
|
||||
- [Filtering Nodes with GPU Devices](#filtering-nodes-with-gpu-devices)
|
||||
- [Finding Nodes by Capacity](#finding-nodes-by-capacity)
|
||||
- [Filtering Nodes with Specific Capacity](#filtering-nodes-with-specific-capacity)
|
||||
- [GraphQL and the ThreeFold Explorer](#graphql-and-the-threefold-explorer)
|
||||
|
||||
***
|
||||
|
||||
## Introduction
|
||||
|
||||
[GraphQL](https://graphql.org/), or Graph Query Language, is a powerful and flexible query language used for accessing and manipulating data. It serves as a fundamental component in the ThreeFold Grid ecosystem, offering a standardized and efficient means to interact with and retrieve information from various ThreeFold networks.
|
||||
|
||||
GraphQL allows users to request specific data they need, making it a more dynamic alternative to traditional REST APIs.
|
||||
|
||||
In the context of TFGrid, GraphQL plays a pivotal role in indexing and organizing information related to TFChain, the decentralized blockchain technology powering the ThreeFold ecosystem. TFChain's data, including information about nodes, transactions, and network status, is indexed over GraphQL, providing a unified interface for querying the ThreeFold networks (Devnet, Qanet, Testnet, and Mainnet).
|
||||
|
||||
## Get Started
|
||||
|
||||
Information on TFChain is indexed over GraphQL and is available for queries.
|
||||
|
||||
You can query the following ThreeFold networks with GraphQL:
|
||||
|
||||
- [Devnet GraphQL](https://graphql.dev.grid.tf/graphql)
|
||||
- [Qanet GraphQL](https://graphql.qa.grid.tf/graphql)
|
||||
- [Testnet GraphQL](https://graphql.test.grid.tf/graphql)
|
||||
- [Mainnet GraphQL](https://graphql.grid.tf/graphql)
|
||||
|
||||
The GraphQL interface used to query TF-Chain is the one offered by [Subsquid](https://docs.subsquid.io/). See more info on supported queries [here](https://docs.subsquid.io/query-squid/).
|
||||
|
||||
***
|
||||
|
||||
## GraphQL Examples
|
||||
|
||||
We present here some example on how to use GraphQL to query the ThreeFold Grid and find suitable nodes depending on your specific needs.
|
||||
***
|
||||
### Getting Many Nodes
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(orderBy: nodeId_ASC, limit: 5000, where: {
|
||||
cru_gt: "2", hru_gt: "500000000", mru_gt: "50000000", sru_gt: "1000000000",
|
||||
deletedAt_eq: null
|
||||
})
|
||||
{
|
||||
twinId
|
||||
city
|
||||
certificationType
|
||||
country
|
||||
created
|
||||
createdById
|
||||
cru
|
||||
farmId
|
||||
hru
|
||||
id
|
||||
uptime
|
||||
version
|
||||
mru
|
||||
sru
|
||||
nodeId
|
||||
interfaces {
|
||||
ips
|
||||
name
|
||||
node {
|
||||
city
|
||||
country
|
||||
cru
|
||||
hru
|
||||
sru
|
||||
mru
|
||||
}
|
||||
}
|
||||
location {
|
||||
latitude
|
||||
longitude
|
||||
}
|
||||
publicConfig {
|
||||
domain
|
||||
gw4
|
||||
gw6
|
||||
ipv4
|
||||
ipv6
|
||||
}
|
||||
deletedById
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
```
|
||||
***
|
||||
### Finding Gateways
|
||||
|
||||
gateway typically needs to be a node with public ipv4 or ipv6 and a domain configured otherwise it won't be able to create `NameContracts`
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes {
|
||||
nodeId
|
||||
publicConfig {
|
||||
domain
|
||||
ipv4
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
***
|
||||
### Finding Farms with Public IPs
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
farms {
|
||||
farmId
|
||||
name
|
||||
|
||||
publicIPs {
|
||||
ip
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
***
|
||||
### Finding Nodes on a Specific Farm
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(where: {farmId_eq: 1}) {
|
||||
twinId
|
||||
}
|
||||
}
|
||||
```
|
||||
***
|
||||
### Finding Nodes by Country
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(where: {country_eq: "BE"}) {
|
||||
twinId
|
||||
}
|
||||
}
|
||||
```
|
||||
***
|
||||
### Filtering Nodes with GPU Devices
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(where: {hasGpu_eq: true}) {
|
||||
hasGpu
|
||||
id
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
***
|
||||
### Finding Nodes by Capacity
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes() {
|
||||
cru,
|
||||
hru,
|
||||
mru,
|
||||
sru,
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
> Note that the cru are in bytes.
|
||||
***
|
||||
### Filtering Nodes with Specific Capacity
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(where: {cru_gt: "2", hru_gt: "500000000", mru_gt: "50000000", sru_gt: "1000000000"}) {
|
||||
nodeId
|
||||
cru
|
||||
hru
|
||||
mru
|
||||
sru
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
> Note that the cru are in bytes.
|
||||
|
||||
***
|
||||
|
||||
## GraphQL and the ThreeFold Explorer
|
||||
|
||||
Note that most of those examples have their equivalent searches available in our [ThreeFold Explorer](https://dashboard.grid.tf/explorer/nodes).
|
||||
111
tosort/dashboard/explorer/explorer_home.md
Normal file
111
tosort/dashboard/explorer/explorer_home.md
Normal file
@@ -0,0 +1,111 @@
|
||||
<h1> ThreeFold Explorer </h1>
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [ThreeFold Explorer Links](#threefold-explorer-links)
|
||||
- [ExplorerUI](#explorerui)
|
||||
- [Statistics](#statistics)
|
||||
- [Exploring Farms](#exploring-farms)
|
||||
- [Farm Details](#farm-details)
|
||||
- [Exploring Nodes](#exploring-nodes)
|
||||
- [Light and Dark Modes](#light-and-dark-modes)
|
||||
- [Map Capacity Distribution](#map-capacity-distribution)
|
||||
|
||||
***
|
||||
|
||||
## Introduction
|
||||
|
||||
The ThreeFold Explorer serves as a powerful and intuitive tool within the ThreeFold Dashboard specifically designed to empower users in navigating and interacting with the ThreeFold Grid.
|
||||
|
||||
At its core, the TF Explorer is a comprehensive platform that enables users to discover nodes within the grid that align with their specific requirements, facilitating a seamless and efficient exploration of the decentralized network. Whether you are seeking computational resources, specific geographic locations, or specialized hardware configurations, the ThreeFold Explorer provides a user-friendly interface to effortlessly identify and connect with nodes that best suit your needs.
|
||||
|
||||
Throughout this manual, we will delve into the intricacies of the ThreeFold Explorer, highlighting key features, utilization strategies, and best practices for harnessing its capabilities effectively.
|
||||
|
||||
## ThreeFold Explorer Links
|
||||
|
||||
The ThreeFold Explorer can give insights into the different ThreeFold networks. Each ThreeFold network has an associated ThreeFold Explorer. You can use the ThreeFold Explorer to query information about ThreeFold Statistics, Nodes and Farms. The links are the following:
|
||||
|
||||
- [Devnet Dashboard](https://dashboard.dev.grid.tf)
|
||||
- [Statistics](https://dashboard.dev.grid.tf/#/tf-grid/stats)
|
||||
- [Nodes](https://dashboard.dev.grid.tf/#/deploy/nodes)
|
||||
- [Farms](https://dashboard.dev.grid.tf/#/farms/farm-finder)
|
||||
- [Qanet Dashboard](https://dashboard.qa.grid.tf)
|
||||
- [Statistics](https://dashboard.qa.grid.tf/explorer/statistics)
|
||||
- [Nodes](https://dashboard.qa.grid.tf/explorer/nodes)
|
||||
- [Farms](https://dashboard.qa.grid.tf/explorer/farms)
|
||||
- [Testnet Dashboard](https://dashboard.test.grid.tf)
|
||||
- [Statistics](https://dashboard.test.grid.tf/explorer/statistics)
|
||||
- [Nodes](https://dashboard.test.grid.tf/explorer/nodes)
|
||||
- [Farms](https://dashboard.test.grid.tf/explorer/farms)
|
||||
- [Mainnet Dashboard](https://dashboard.grid.tf)
|
||||
- [Statistics](https://dashboard.grid.tf/explorer/statistics)
|
||||
- [Nodes](https://dashboard.grid.tf/explorer/nodes)
|
||||
- [Farms](https://dashboard.grid.tf/explorer/farms)
|
||||
|
||||
When you open an Explorer link, you will be asked to log in, but this is optional. You can simply close the login window and consult the Explorer.
|
||||
|
||||
|
||||
|
||||
## ExplorerUI
|
||||
|
||||
|
||||
Explorer UI helps exploring the capacity connected to Threefold Grid. Searching for nodes, farms, gateways .. etc. It also supports Dark mode for more comfortable navigation.
|
||||
|
||||
### Statistics
|
||||
|
||||
|
||||
|
||||
Here you can see generic overview about:
|
||||
|
||||
- Number of farms
|
||||
- Number of nodes
|
||||
- Number of gateways
|
||||
- Number of twins
|
||||
- Number of contracts
|
||||
- The capacity CRU, SRU, HRU, MRU
|
||||
- The number of public IPs available
|
||||
|
||||
### Exploring Farms
|
||||
|
||||
You can see a list of all farms with filtering options.
|
||||
|
||||
|
||||
|
||||
### Farm Details
|
||||
|
||||
Click on a farm shows up the farm details information.
|
||||
|
||||
|
||||
|
||||
### Exploring Nodes
|
||||
|
||||
Explorer UI allows exploring the nodes and filtering them by many filtering option.
|
||||
|
||||
|
||||
|
||||
You can see all of the node details by clicking on a node record.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Light and Dark Modes
|
||||
|
||||
Both light and dark modes are supported on the ThreeFold Explorer. Click on the icon in the upper right corner of the screen to change the view mode.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Map Capacity Distribution
|
||||
|
||||
You can also see a map of how the capacity is distributed.
|
||||
A map is available with a global overview, showing in which countries capacity is offered.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
6
tosort/dashboard/explorer/explorer_list.md
Normal file
6
tosort/dashboard/explorer/explorer_list.md
Normal file
@@ -0,0 +1,6 @@
|
||||
|
||||
- [Devnet Explorer](https://dashboard.dev.grid.tf)
|
||||
- [Qanet Explorer](https://dashboard.qa.grid.tf)
|
||||
- [Testnet Explorer](https://dashboard.test.grid.tf)
|
||||
- [Mainnet explorer](https://dashboard.grid.tf)
|
||||
<!-- - Overview of all nodes in the world, over all nets https://explorer.threefold.io/ (not useful to find node on specific net). ==> comment because it's pointing to TFGrid 2-->
|
||||
11
tosort/dashboard/explorer/explorer_report_issues.md
Normal file
11
tosort/dashboard/explorer/explorer_report_issues.md
Normal file
@@ -0,0 +1,11 @@
|
||||
## Report Explorer Bugs:
|
||||
|
||||
!!!include:report_issue_fr_include
|
||||
|
||||
### If you are an expert user
|
||||
|
||||
Please open a github issue in [grid_explorer_ui repo](https://github.com/threefoldtech/tfgrid_dashboard)
|
||||
|
||||
Also to plan your deployment beyond the explorer capabilities you can use these [graphql example queries](explorer_graphql_examples)
|
||||
|
||||
!!!include:explorer_toc
|
||||
6
tosort/dashboard/explorer/explorer_toc.md
Normal file
6
tosort/dashboard/explorer/explorer_toc.md
Normal file
@@ -0,0 +1,6 @@
|
||||
## Explorer Information
|
||||
|
||||
- [Find Capacity](explorer_find_capacity)
|
||||
<!-- - [GraphQL Support](explorer_graphql_intro) -->
|
||||
- [User Interface](explorer_ui)
|
||||
- [Report Issues or Ask For Features](explorer_report_issues)
|
||||
48
tosort/dashboard/explorer/explorer_ui.md
Normal file
48
tosort/dashboard/explorer/explorer_ui.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Explorer UI
|
||||
|
||||
|
||||
|
||||
Explorer UI helps exploring the capacity connected to Threefold Grid. Searching for nodes, farms, gateways .. etc. It also supports Dark mode for more comfortable navigation.
|
||||
|
||||
## Statistics
|
||||
|
||||
|
||||
|
||||
Here you can see generic overview about
|
||||
|
||||
- number of farms
|
||||
- number of nodes
|
||||
- number of gateways
|
||||
- number of twins
|
||||
- number of contracts
|
||||
- the capacity CRU, SRU, HRU, MRU
|
||||
- the number of public IPs available
|
||||
|
||||
## Exploring farms
|
||||
|
||||
You can see a list of all farms with filtering options
|
||||
|
||||
|
||||
## Farm details
|
||||
|
||||
Click on a farm shows up the farm details information
|
||||
|
||||
|
||||
## Exploring nodes
|
||||
|
||||
Explorer UI allows exploring the nodes and filtering them by many filtering option
|
||||
|
||||
|
||||
You can see all of the node details by clicking on a node record.
|
||||
|
||||
|
||||
|
||||
|
||||
Lightmode is supported. Click on the icon in the upper right corner of the screen.
|
||||
|
||||
|
||||
|
||||
Can also see a map of how the capacity is distributed.
|
||||
A map is available with a global overview, showing in which countries capacity is offered.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user