development_manual #64

Merged
mik-tf merged 42 commits from development_manual into development 2024-05-13 17:17:42 +00:00
9 changed files with 11 additions and 11 deletions
Showing only changes of commit 088f111774 - Show all commits

View File

@ -9,7 +9,7 @@
## Introduction ## Introduction
It's almost the same as in [deploying a single VM](../javascript/grid3_javascript_vm.md) the only difference is you can automate the choice of the node to deploy on using code. We now support `FilterOptions` to filter nodes based on specific criteria e.g the node resources (CRU, SRU, HRU, MRU) or being part of a specific farm or located in some country, or being a gateway or not It's almost the same as in [deploying a single VM](grid3_javascript_vm.md) the only difference is you can automate the choice of the node to deploy on using code. We now support `FilterOptions` to filter nodes based on specific criteria e.g the node resources (CRU, SRU, HRU, MRU) or being part of a specific farm or located in some country, or being a gateway or not
## Example ## Example

View File

@ -36,7 +36,7 @@ To use the Grid Client, you will need the following on the TFGrid:
- A TFChain account - A TFChain account
- TFT in your wallet - TFT in your wallet
If it is not the case, please visit the [Get started section](../../system_administrators/getstarted/tfgrid3_getstarted.md). If it is not the case, please visit the [Get started section](system_administrators@@tfgrid3_getstarted).
## Installation ## Installation
@ -81,7 +81,7 @@ Make sure to set the client configuration properly before using the Grid Client.
- **network**: The network environment (**dev**, **qa**, **test** or **main**). - **network**: The network environment (**dev**, **qa**, **test** or **main**).
- **mnemonic**: The 12 words mnemonics for your account. - **mnemonic**: The 12 words mnemonics for your account.
- Learn how to create one [here](../../dashboard/wallet_connector.md). - Learn how to create one [here](dashboard@@wallet_connector).
- **storeSecret**: This is any word that will be used for encrypting/decrypting the keys on ThreeFold key-value store. - **storeSecret**: This is any word that will be used for encrypting/decrypting the keys on ThreeFold key-value store.

View File

@ -62,7 +62,7 @@ using e2e. That's similar to home servers by matrix
for more details, check [client options](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/docs/client_configuration.md) for more details, check [client options](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/docs/client_configuration.md)
> Note: The choice of the node is completely up to the user at this point. They need to do the capacity planning. Check [Node Finder](../../dashboard/deploy/node_finder.md) to know which nodes fits your deployment criteria. > Note: The choice of the node is completely up to the user at this point. They need to do the capacity planning. Check [Node Finder](dashboard@@node_finder) to know which nodes fits your deployment criteria.
Check the document for [capacity planning using code](../javascript/grid3_javascript_capacity_planning.md) if you want to automate it Check the document for [capacity planning using code](grid3_javascript_capacity_planning.md) if you want to automate it
> Note: this feature is still experimental > Note: this feature is still experimental

View File

@ -4,7 +4,7 @@ This section covers developing projects on top of Threefold Grid using Javascrip
Javascript has a huge ecosystem, and first class citizen when it comes to blockchain technologies like substrate and that was one of the reasons for it to become one the very first supported languages on the grid. Javascript has a huge ecosystem, and first class citizen when it comes to blockchain technologies like substrate and that was one of the reasons for it to become one the very first supported languages on the grid.
Please make sure to check the [basics](../../system_administrators/getstarted/tfgrid3_getstarted.md) before continuing. Please make sure to check the [basics](system_administrators@@tfgrid3_getstarted) before continuing.
<h2> Table of Contents </h2> <h2> Table of Contents </h2>

View File

@ -145,7 +145,7 @@ We need to specify its
- disks: disks model collection - disks: disks model collection
- memory - memory
- root filesystem size - root filesystem size
- flist: the image it is going to start from. Check the [supported flists](../flist/grid3_supported_flists.md) - flist: the image it is going to start from. Check the [supported flists](grid3_supported_flists.md)
- entry point: entrypoint command / script to execute - entry point: entrypoint command / script to execute
- env: has the environment variables needed e.g sshkeys used - env: has the environment variables needed e.g sshkeys used
- public ip: if we want to have a public ip attached to the VM - public ip: if we want to have a public ip attached to the VM

View File

@ -105,4 +105,4 @@ async function main() {
main(); main();
``` ```
It's similiar to the previous section of [deploying a single VM](../javascript/grid3_javascript_vm.md), but just adds more vm objects to vms collection. It's similiar to the previous section of [deploying a single VM](grid3_javascript_vm.md), but just adds more vm objects to vms collection.

View File

@ -186,7 +186,7 @@ log(vmResult);
- `CreateNetWorkModel` : - `CreateNetWorkModel` :
we are creating a network and set the node id to be `gwNode`, the name `monNetwork` and inside the function we set `addAccess: true` to add __wireguard__ access. we are creating a network and set the node id to be `gwNode`, the name `monNetwork` and inside the function we set `addAccess: true` to add __wireguard__ access.
- `createMachineModel` and `createMachinesModel` is similar to the previous section of [deploying a single VM](../javascript/grid3_javascript_vm.md), but we are passing the created `NetworkModel` to the machines model and the entry point here runs a simple python server. - `createMachineModel` and `createMachinesModel` is similar to the previous section of [deploying a single VM](grid3_javascript_vm.md), but we are passing the created `NetworkModel` to the machines model and the entry point here runs a simple python server.
### Deploy the Gateway ### Deploy the Gateway

View File

@ -20,7 +20,7 @@ The TFGrid client Proxy acts as an interface to access information about the gri
The proxy is used as the backend of several threefold projects like: The proxy is used as the backend of several threefold projects like:
- [Dashboard](../../dashboard/dashboard.md) - [Dashboard](dashboard@@dashboard)
<!-- Usage --> <!-- Usage -->

View File

@ -20,7 +20,7 @@ To install Golang, you can follow the official [guide](https://go.dev/doc/instal
## Docker ## Docker
Docker is useful for running the TFGridDb in container environment. Read this to [install Docker engine](../../system_administrators/computer_it_basics/docker_basics.md#install-docker-desktop-and-docker-engine). Docker is useful for running the TFGridDb in container environment. Read this to [install Docker engine](system_administrators@@docker_basics.md#install-docker-desktop-and-docker-engine).
Note: it will be necessary to follow step #2 in the previous article to run docker without sudo. if you want to avoid that. edit the docker commands in the `Makefile` and add sudo. Note: it will be necessary to follow step #2 in the previous article to run docker without sudo. if you want to avoid that. edit the docker commands in the `Makefile` and add sudo.