diff --git a/books/manual/SUMMARY.md b/books/manual/SUMMARY.md index 84ebb03..b774903 100644 --- a/books/manual/SUMMARY.md +++ b/books/manual/SUMMARY.md @@ -11,7 +11,7 @@ - [Node Finder](dashboard/deploy/node_finder.md) - [Virtual Machines](dashboard/solutions/vm_intro.md) - [Micro and Full VM Differences ](dashboard/solutions/vm_differences.md) - - [Full Virtual Machine](dashboard/solutions/fullVm.md) + - [Full Virtual Machine](dashboard/solutions/fullvm.md) - [Micro Virtual Machine](dashboard/solutions/microvm.md) - [Nixos MicroVM](dashboard/solutions/nixos_micro.md) - [Add a Domain](dashboard/solutions/add_domain.md) @@ -254,6 +254,7 @@ - [IPFS on a Micro VM](system_administrators/advanced/ipfs/ipfs_microvm.md) - [MinIO Operator with Helm3](system_administrators/advanced/minio_helm3.md) - [AI & ML Workloads](system_administrators/advanced/ai_ml_workloads.md) + - [Hummingbot](system_administrators/advanced/hummingbot.md) - [ThreeFold Token](threefold_token/threefold_token.md) - [TFT Bridges](threefold_token/tft_bridges/tft_bridges.md) - [TFChain-Stellar Bridge](threefold_token/tft_bridges/tfchain_stellar_bridge.md) diff --git a/collections/cloud/grid_billing/grid_billing.md b/collections/cloud/grid_billing/grid_billing.md index f1d56bc..7b7c10e 100644 --- a/collections/cloud/grid_billing/grid_billing.md +++ b/collections/cloud/grid_billing/grid_billing.md @@ -247,7 +247,7 @@ Contract cost/hour = CU cost/hour + SU cost/hour ### Applying the Dedicated Node Discount -There's a default `50%` discount for renting a node, this discount is not related to the staking discount. For more information on dedicated node discounts, please [read this section](dedicated_machines.md). +There's a default `50%` discount for renting a node, this discount is not related to the staking discount. For more information on dedicated node discounts, please [read this section](dashboard@@node_finder). ``` Cost with 50% discount = 35.72532 * 0.5 diff --git a/collections/dashboard/deploy/vm.md b/collections/dashboard/deploy/vm.md index 4b0ee77..fdc0933 100644 --- a/collections/dashboard/deploy/vm.md +++ b/collections/dashboard/deploy/vm.md @@ -9,5 +9,5 @@ On the TFGrid, you can deploy both micro and full virtual machines.

Table of Contents

- [Micro and Full VM Differences ](vm_differences.md) -- [Full Virtual Machine](fullVm.md) -- [Micro Virtual Machine](vm.md) +- [Full Virtual Machine](fullvm.md) +- [Micro Virtual Machine](microvm.md) diff --git a/collections/dashboard/solutions/basic_environments_readme.md b/collections/dashboard/solutions/basic_environments_readme.md index 5bbd8c9..a98cae4 100644 --- a/collections/dashboard/solutions/basic_environments_readme.md +++ b/collections/dashboard/solutions/basic_environments_readme.md @@ -4,8 +4,8 @@ - [Virtual Machines](vm_intro.md) - [Micro and Full VM Differences ](vm_differences.md) - - [Full Virtual Machine](fullVm.md) - - [Micro Virtual Machine](vm.md) + - [Full Virtual Machine](fullvm.md) + - [Micro Virtual Machine](microvm.md) - [Kubernetes](k8s.md) - [NixOS MicroVM](nixos_micro.md) - [Add a Domain](add_domain.md) \ No newline at end of file diff --git a/collections/dashboard/solutions/fullvm.md b/collections/dashboard/solutions/fullvm.md index 1137273..56261a6 100644 --- a/collections/dashboard/solutions/fullvm.md +++ b/collections/dashboard/solutions/fullvm.md @@ -43,7 +43,7 @@ Deploy a new full virtual machine on the Threefold Grid - `Myceluim` 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](dashboard@@dedicated_machines) + - To deploy a Full VM with GPU, you first need to [rent a dedicated node](node_finder.md#dedicated-nodes) - `Dedicated` flag to retrieve only dedicated nodes - `Certified` flag to retrieve only certified nodes - Choose the location of the node diff --git a/collections/dashboard/solutions/nextcloud.md b/collections/dashboard/solutions/nextcloud.md index 72f9cb1..d09b077 100644 --- a/collections/dashboard/solutions/nextcloud.md +++ b/collections/dashboard/solutions/nextcloud.md @@ -63,7 +63,7 @@ If you're not sure and just want the easiest, most affordable option, skip the p * **Recommended**: {cpu: 4, memory: 16gb, diskSize: 1000gb } * Or choose a **Custom** plan * If want to reserve a public IPv4 address, click on Network then select **Public IPv4** -* If you want a [dedicated](dedicated_machines.md) and/or a certified node, select the corresponding option +* If you want a [dedicated node](node_finder.md#dedicated-nodes) and/or a certified node, select the corresponding option * Choose the location of the node * `Country` * `Farm Name` diff --git a/collections/dashboard/solutions/solutions.md b/collections/dashboard/solutions/solutions.md index 1a10b1c..bc592b4 100644 --- a/collections/dashboard/solutions/solutions.md +++ b/collections/dashboard/solutions/solutions.md @@ -7,8 +7,8 @@ This section provides a non-code easy way to deploy a whole solution on the TFGr - [Basic Environments](basic_environments_readme.md) - [Virtual Machines](vm_intro.md) - [Micro and Full VM Differences](vm_differences.md) - - [Full Virtual Machine](fullVm.md) - - [Micro Virtual Machine](vm.md) + - [Full Virtual Machine](fullvm.md) + - [Micro Virtual Machine](microvm.md) - [Kubernetes](k8s.md) - [NixOS MicroVM](nixos_micro.md) - [Ready Community Solutions](ready_community_readme.md) diff --git a/collections/farmers/3node_building/gpu_farming.md b/collections/farmers/3node_building/gpu_farming.md index 35cbf8e..cbb0de0 100644 --- a/collections/farmers/3node_building/gpu_farming.md +++ b/collections/farmers/3node_building/gpu_farming.md @@ -65,7 +65,7 @@ You can use the [Node Finder](dashboard@@node_finder) on the [TF Dashboard](http ## 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](dedicated_machines.md). +Now, users can reserve the node using the **Node Finder** of the Dashboard and then deploy workloads using the GPU. For more information, read [this documentation](dashboard@@node_finder). ## Questions and Feedback diff --git a/collections/farmers/farming_optimization/set_additional_fees.md b/collections/farmers/farming_optimization/set_additional_fees.md index 5da2886..d647571 100644 --- a/collections/farmers/farming_optimization/set_additional_fees.md +++ b/collections/farmers/farming_optimization/set_additional_fees.md @@ -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@@dedicated_machines). +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@@node_finder). This can be useful for farmers who provide additional values to their 3Nodes, e.g. a GPU card and/or high-quality hardware. ## Steps diff --git a/collections/system_administrators/advanced/advanced.md b/collections/system_administrators/advanced/advanced.md index f554c42..0edb6dd 100644 --- a/collections/system_administrators/advanced/advanced.md +++ b/collections/system_administrators/advanced/advanced.md @@ -13,4 +13,5 @@ In this section, we delve into sophisticated topics and powerful functionalities - [IPFS on a Full VM](ipfs_fullvm.md) - [IPFS on a Micro VM](ipfs_microvm.md) - [MinIO Operator with Helm3](minio_helm3.md) -- [AI & ML Workloads](ai_ml_workloads.md) \ No newline at end of file +- [AI & ML Workloads](ai_ml_workloads.md) +- [Hummingbot](hummingbot.md) \ No newline at end of file diff --git a/collections/system_administrators/advanced/ai_ml_workloads.md b/collections/system_administrators/advanced/ai_ml_workloads.md index bc5760e..5bd227c 100644 --- a/collections/system_administrators/advanced/ai_ml_workloads.md +++ b/collections/system_administrators/advanced/ai_ml_workloads.md @@ -23,7 +23,7 @@ In the second part, we show how to use PyTorch to run AI/ML tasks. ## Prerequisites -You need to reserve a [dedicated GPU node](../../dashboard/deploy/node_finder.md#dedicated-nodes) on the ThreeFold Grid. +You need to reserve a [dedicated GPU node](dashboard@@node_finder) on the ThreeFold Grid. ## Prepare the System diff --git a/collections/system_administrators/advanced/hummingbot.md b/collections/system_administrators/advanced/hummingbot.md new file mode 100644 index 0000000..1a154b7 --- /dev/null +++ b/collections/system_administrators/advanced/hummingbot.md @@ -0,0 +1,80 @@ +

Hummingbot on a Full VM

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Deploy a Full VM](#deploy-a-full-vm) +- [Preparing the VM](#preparing-the-vm) +- [Setting Hummingbot](#setting-hummingbot) +- [References](#references) + +--- + +## Introduction + +Hummingbot is an open source platform that helps you design, backtest, and deploy fleets of automated crypto trading bots. + +In this guide, we go through the basic steps to deploy a [Hummingbot](https://hummingbot.org/) instance on a full VM running on the TFGrid. + + +## Prerequisites + +- [A TFChain account](../../../dashboard/wallet_connector.md) +- TFT in your TFChain account + - [Buy TFT](../../../threefold_token/buy_sell_tft/buy_sell_tft.md) + - [Send TFT to TFChain](../../../threefold_token/tft_bridges/tfchain_stellar_bridge.md) + +## Deploy a Full VM + +We start by deploying a full VM on the ThreeFold Dashboard. + +* On the [Threefold Dashboard](https://dashboard.grid.tf/#/), go to the [full virtual machine deployment page](https://dashboard.grid.tf/#/deploy/virtual-machines/full-virtual-machine/) +* Deploy a full VM (Ubuntu 22.04) with an IPv4 address and at least the minimum specs for Hummingbot + * IPv4 Address + * Minimum vcores: 1vcore + * Minimum MB of RAM: 4096GB + * Minimum storage: 15GB +* After deployment, note the VM IPv4 address +* Connect to the VM via SSH + * ``` + ssh root@VM_IPv4_address + ``` + +## Preparing the VM + +We prepare the full to run Hummingbot. + +* Update the VM + ``` + apt update + ``` +* [Install Docker](../computer_it_basics/docker_basics.html#install-docker-desktop-and-docker-engine) + +## Setting Hummingbot + +We clone the Hummingbot repo and start it via Docker. + +* Clone the Hummingbot repository + ``` + git clone https://github.com/hummingbot/hummingbot.git + cd hummingbot + ``` +* Start Hummingbot + ``` + docker compose up -d + ``` +* Attach to instance + ``` + docker attach hummingbot + ``` + +You should now see the Hummingbot page. + +![](./img/hummingbot.png) + +## References + +The information to install Hummingbot have been taken directly from their [documentation](https://hummingbot.org/installation/docker/). + +For any advanced configurations, you may refer to the Hummingbot documentation. \ No newline at end of file diff --git a/collections/system_administrators/advanced/img/hummingbot.png b/collections/system_administrators/advanced/img/hummingbot.png new file mode 100644 index 0000000..ab81cfa Binary files /dev/null and b/collections/system_administrators/advanced/img/hummingbot.png differ diff --git a/collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md b/collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md index 91cc986..a251f97 100644 --- a/collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md +++ b/collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md @@ -25,7 +25,7 @@ Note that WireGuard provides the connection to the 3Node deployment. It is up to # Prerequisites -Make sure to [read the introduction](../tfgrid3_getstarted.md#get-started---your-first-deployment) before going further. +Make sure to [read the introduction](tfgrid3_getstarted.md#get-started---your-first-deployment) before going further. * SSH client of your choice * [Open-SSH](ssh_openssh.md) @@ -36,7 +36,7 @@ Make sure to [read the introduction](../tfgrid3_getstarted.md#get-started---your # Deploy a Weblet with WireGuard Access -For this guide on WireGuard access, we deploy a [Full VM](fullVm.md). Note that the whole process is similar with other types of ThreeFold weblets on the Dashboard. +For this guide on WireGuard access, we deploy a [Full VM](dashboard@fullvm). Note that the whole process is similar with other types of ThreeFold weblets on the Dashboard. * On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine * Choose the parameters you want @@ -102,7 +102,7 @@ To set the WireGuard connection on Windows, add and activate a tunnel with the W # Test the WireGuard Connection -As a test, you can [ping](../../computer_it_basics/cli_scripts_basics.md#test-the-network-connectivity-of-a-domain-or-an-ip-address-with-ping) the virtual IP address of the VM to make sure the WireGuard connection is properly established. Make sure to replace `VM_WireGuard_IP` with the proper WireGuard IP address: +As a test, you can [ping](cli_scripts_basics.md#test-the-network-connectivity-of-a-domain-or-an-ip-address-with-ping) the virtual IP address of the VM to make sure the WireGuard connection is properly established. Make sure to replace `VM_WireGuard_IP` with the proper WireGuard IP address: * Ping the deployment ``` diff --git a/collections/system_administrators/gpu/gpu.md b/collections/system_administrators/gpu/gpu.md index 581d26f..d930a98 100644 --- a/collections/system_administrators/gpu/gpu.md +++ b/collections/system_administrators/gpu/gpu.md @@ -25,7 +25,7 @@ To use a GPU on the TFGrid, users need to rent a dedicated node. Once they have ## Filter and Reserve a GPU Node -You can filter and reserve a GPU node using the [Dedicated Nodes section](dashboard@@dedicated_machines) of the **ThreeFold Dashboard**. +You can filter and reserve a GPU node using the [Dedicated Nodes section](dashboard@@node_finder) of the **ThreeFold Dashboard**. ### Filter Nodes @@ -52,7 +52,7 @@ When you have decided which node to reserve, click on **Reserve** under the colu ## Deploy a VM with GPU -Now that you've reserverd a dedicated GPU node, it's time to deploy a VM to make use of the GPU! There are many ways to proceed. You can use the [Dashboard](fullVm.md), [Go](developers@@grid3_go_gpu), [Terraform](terraform_gpu_support.md), etc. +Now that you've reserverd a dedicated GPU node, it's time to deploy a VM to make use of the GPU! There are many ways to proceed. You can use the [Dashboard](fullvm.md), [Go](developers@@grid3_go_gpu), [Terraform](terraform_gpu_support.md), etc. For example, deploying a VM with GPU on the Dashboard is easy. Simply set the GPU option and make sure to select your dedicated node, as show here: ![image](./img/gpu_3.png) diff --git a/collections/system_administrators/system_administrators.md b/collections/system_administrators/system_administrators.md index fe0d556..cea89ac 100644 --- a/collections/system_administrators/system_administrators.md +++ b/collections/system_administrators/system_administrators.md @@ -83,4 +83,5 @@ For complementary information on ThreeFold grid and its cloud component, refer t - [IPFS on a Full VM](ipfs_fullvm.md) - [IPFS on a Micro VM](ipfs_microvm.md) - [MinIO Operator with Helm3](minio_helm3.md) - - [AI & ML Workloads](ai_ml_workloads.md) \ No newline at end of file + - [AI & ML Workloads](ai_ml_workloads.md) + - [Hummingbot](hummingbot.md) \ No newline at end of file