new book manual
This commit is contained in:
@@ -0,0 +1,24 @@
|
||||
<h1> Ready Community Applications </h1>
|
||||
|
||||
Easily deploy your favourite applications on the ThreeFold grid with a click of a button.
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
<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.
|
||||
|
||||
|
||||
|
||||
- Hover over the price to see the applied discounts
|
||||
|
||||
|
||||
|
||||
- Expand row to see more info on the node:
|
||||
|
||||
|
||||
- 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
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)
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
## 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/)
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
You can get a node with the desired specifications using the filters available in the nodes page.
|
||||
|
||||
|
||||
|
||||
You can see all of the node details by clicking on a node record.
|
||||
|
||||
|
||||
|
||||
## GPU Support
|
||||
|
||||
|
||||
|
||||
- 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.
|
||||
|
||||
|
||||
|
||||
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).
|
||||
@@ -0,0 +1,19 @@
|
||||
<h1> GPU Support </h1>
|
||||
|
||||
***
|
||||
|
||||
|
||||
|
||||
- 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.
|
||||
|
||||
|
||||
|
||||
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).
|
||||
@@ -0,0 +1,14 @@
|
||||
# Orchestrators
|
||||
|
||||
Deploy your favorite orchestrating services and enjoy the seamless coordination and automation of various software applications and services.
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
# SSH Keys
|
||||
|
||||
Add, update or generate your SSH key with a click of a button.
|
||||
|
||||
|
||||
13
collections/manual/documentation/dashboard/deploy/vm.md
Normal file
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.
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
<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
|
||||
|
||||
|
||||
|
||||
### Name contracts
|
||||
|
||||
|
||||
|
||||
### Rent contracts
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
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).
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
Reference in New Issue
Block a user